From eaf85d7480143508066290d145b8f40b2155b147 Mon Sep 17 00:00:00 2001 From: Lars Kappert Date: Thu, 9 Mar 2023 13:32:08 +0100 Subject: [PATCH] Add note about github.autoGenerate (closes #945) --- docs/github-releases.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/github-releases.md b/docs/github-releases.md index 7f126bb3..d409274a 100644 --- a/docs/github-releases.md +++ b/docs/github-releases.md @@ -36,6 +36,7 @@ In this mode, release-it will open the default browser pointed at the GitHub web - Configure `github.release: true` - This mode is enabled automatically when the `GITHUB_TOKEN` environment variable is not set. - Set `github.web: true` explicitly to override this `GITHUB_TOKEN` check. +- Use `github.autoGenerate: true` to let GitHub generate release notes. In non-interactive CI mode (using `--ci` or in a CI environment), release-it will not open a browser, but instead print the url to the GitHub web interface (including data to pre-populate the fields).