Wrap up the github.autoGenerate feature

release-it · Jan 9, 2022 · a467b5f · a467b5f
1 parent 0a4c605
commit a467b5f
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 6 deletions.
diff --git a/config/release-it.json b/config/release-it.json
@@ -33,6 +33,7 @@
     "release": false,
     "releaseName": "Release ${version}",
     "releaseNotes": null,
+    "autoGenerate": false,
     "preRelease": false,
     "draft": false,
     "tokenRef": "GITHUB_TOKEN",

diff --git a/docs/github-releases.md b/docs/github-releases.md
@@ -75,6 +75,8 @@ An example:
 }
 ```
 
+Use `--github.autoGenerate` to have GitHub auto-generate the release notes.
+
 See [Changelog](./changelog.md) for more information about generating changelogs/release notes.
 
 ## Attach binary assets

diff --git a/lib/plugin/github/GitHub.js b/lib/plugin/github/GitHub.js
@@ -187,7 +187,7 @@ class GitHub extends Release {
 
   getOctokitReleaseOptions(options = {}) {
     const { owner, project: repo } = this.getContext('repo');
-    const { releaseName, draft = false, preRelease = false, autoGenerate } = this.options;
+    const { releaseName, draft = false, preRelease = false, autoGenerate = false } = this.options;
     const { tagName } = this.config.getContext();
     const { version, releaseNotes } = this.getContext();
     const { isPreRelease } = parseVersion(version);

diff --git a/test/github.js b/test/github.js
@@ -116,7 +116,9 @@ test('should create auto generated release notes', async t => {
 
   interceptAuthentication();
   interceptCollaborator();
-  interceptCreate({ body: { tag_name: '2.0.2', name: 'Release 2.0.2', draft: false, prerelease: false, generate_release_notes: true } });
+  interceptCreate({
+    body: { tag_name: '2.0.2', name: 'Release 2.0.2', draft: false, prerelease: false, generate_release_notes: true }
+  });
 
   await runTasks(github);
 

diff --git a/test/stub/github.js b/test/stub/github.js
@@ -40,10 +40,17 @@ const interceptCreate = ({
   host = 'github.com',
   owner = 'user',
   project = 'repo',
-  body: { tag_name, name = '', body = null, prerelease = false, draft = false, generate_release_notes }
+  body: { tag_name, name = '', body = null, prerelease = false, draft = false, generate_release_notes = false }
 } = {}) =>
   nock(api)
-    .post(`/repos/${owner}/${project}/releases`, { tag_name, name, body, prerelease, draft, generate_release_notes })
+    .post(`/repos/${owner}/${project}/releases`, {
+      tag_name,
+      name,
+      body,
+      prerelease,
+      draft,
+      generate_release_notes
+    })
     .reply(() => {
       const id = 1;
       const responseBody = {
@@ -65,17 +72,18 @@ const interceptUpdate = ({
   api = 'https://api.github.com',
   owner = 'user',
   project = 'repo',
-  body: { tag_name, name = '', body = null, prerelease = false, draft = false }
+  body: { tag_name, name = '', body = null, prerelease = false, draft = false, generate_release_notes = false }
 } = {}) =>
   nock(api)
-    .patch(`/repos/${owner}/${project}/releases/1`, { tag_name, name, body, draft, prerelease })
+    .patch(`/repos/${owner}/${project}/releases/1`, { tag_name, name, body, draft, prerelease, generate_release_notes })
     .reply(200, {
       id: 1,
       tag_name,
       name,
       body,
       prerelease,
       draft,
+      generate_release_notes,
       upload_url: `https://uploads.${host}/repos/${owner}/${project}/releases/1/assets{?name,label}`,
       html_url: `https://${host}/${owner}/${project}/releases/tag/${tag_name}`
     });