Fixes #135 Add support for generate_release_notes

ncipollo · Nov 26, 2021 · 40bb172 · 40bb172
1 parent 66aaa1e
commit 40bb172
Show file tree

Hide file tree

Showing 15 changed files with 134 additions and 23 deletions.
diff --git a/README.md b/README.md
@@ -13,6 +13,7 @@ This action will create a GitHub release and optionally upload an artifact to it
 - **commit**: An optional commit reference. This will be used to create the tag if it does not exist.
 - **discussionCategory**: When provided this will generate a discussion of the specified category. The category must exist otherwise this will cause the action to fail. This isn't used with draft releases.
 - **draft**: Optionally marks this release as a draft release. Set to `true` to enable.
+- **generateReleaseNotes**: Indicates if release notes should be automatically generated. Set to `true` to enable.
 - **name**: An optional name for the release. If this is omitted the tag will be used.
 - **omitBody**: Indicates if the release body should be omitted.
 - **omitBodyDuringUpdate**: Indicates if the release body should be omitted during updates. The body will still be applied for newly created releases. This will preserve the existing body during updates.

diff --git a/__tests__/Action.test.ts b/__tests__/Action.test.ts
@@ -26,6 +26,7 @@ const createName = 'createName'
 const commit = 'commit'
 const discussionCategory = 'discussionCategory'
 const draft = true
+const generateReleaseNotes = true
 const id = 100
 const createPrerelease = true
 const updatePrerelease = false
@@ -51,7 +52,14 @@ describe("Action", () => {
 
         await action.perform()
 
-        expect(createMock).toBeCalledWith(tag, createBody, commit, discussionCategory, draft, createName, createPrerelease)
+        expect(createMock).toBeCalledWith(tag,
+            createBody,
+            commit,
+            discussionCategory,
+            draft,
+            generateReleaseNotes,
+            createName,
+            createPrerelease)
         expect(uploadMock).not.toBeCalled()
         assertOutputApplied()
     })
@@ -63,7 +71,15 @@ describe("Action", () => {
 
         await action.perform()
 
-        expect(createMock).toBeCalledWith(tag, createBody, commit, discussionCategory, draft, createName, createPrerelease)
+        expect(createMock).toBeCalledWith(
+            tag,
+            createBody,
+            commit,
+            discussionCategory,
+            draft,
+            generateReleaseNotes,
+            createName,
+            createPrerelease)
         expect(uploadMock).toBeCalledWith(artifacts, releaseId, url)
         assertOutputApplied()
     })
@@ -80,7 +96,16 @@ describe("Action", () => {
 
         await action.perform()
 
-        expect(createMock).toBeCalledWith(tag, createBody, commit, discussionCategory, draft, createName, createPrerelease)
+        expect(createMock).toBeCalledWith(
+            tag,
+            createBody,
+            commit,
+            discussionCategory,
+            draft,
+            generateReleaseNotes,
+            createName,
+            createPrerelease
+        )
         expect(uploadMock).toBeCalledWith(artifacts, releaseId, url)
         assertOutputApplied()
 
@@ -91,7 +116,16 @@ describe("Action", () => {
 
         await action.perform()
 
-        expect(createMock).toBeCalledWith(tag, createBody, commit, discussionCategory, draft, createName, createPrerelease)
+        expect(createMock).toBeCalledWith(
+            tag,
+            createBody,
+            commit,
+            discussionCategory,
+            draft,
+            generateReleaseNotes,
+            createName,
+            createPrerelease
+        )
         expect(uploadMock).toBeCalledWith(artifacts, releaseId, url)
         assertOutputApplied()
     })
@@ -125,7 +159,16 @@ describe("Action", () => {
             expect(error).toEqual("error")
         }
 
-        expect(createMock).toBeCalledWith(tag, createBody, commit, discussionCategory, draft, createName, createPrerelease)
+        expect(createMock).toBeCalledWith(
+            tag,
+            createBody,
+            commit,
+            discussionCategory,
+            draft,
+            generateReleaseNotes,
+            createName,
+            createPrerelease
+        )
         expect(uploadMock).not.toBeCalled()
     })
 
@@ -191,7 +234,16 @@ describe("Action", () => {
             expect(error).toEqual(expectedError)
         }
 
-        expect(createMock).toBeCalledWith(tag, createBody, commit, discussionCategory, draft, createName, createPrerelease)
+        expect(createMock).toBeCalledWith(
+            tag,
+            createBody,
+            commit,
+            discussionCategory,
+            draft,
+            generateReleaseNotes,
+            createName,
+            createPrerelease
+        )
         expect(uploadMock).toBeCalledWith(artifacts, releaseId, url)
     })
 
@@ -315,6 +367,7 @@ describe("Action", () => {
                 commit: commit,
                 discussionCategory: discussionCategory,
                 draft: draft,
+                generateReleaseNotes: true,
                 owner: "owner",
                 createdPrerelease: createPrerelease,
                 replacesArtifacts: replacesArtifacts,

diff --git a/__tests__/Inputs.test.ts b/__tests__/Inputs.test.ts
@@ -38,9 +38,16 @@ describe('Inputs', () => {
         inputs = new CoreInputs(createGlobber(), context)
     })
 
-    it('returns targetCommit', () => {
-        mockGetInput.mockReturnValue('42')
-        expect(inputs.commit).toBe('42')
+    describe('commit', () => {
+        it('returns commit', () => {
+            mockGetInput.mockReturnValueOnce('commit')
+            expect(inputs.commit).toBe('commit')
+        })
+
+        it('returns undefined when omitted', () => {
+            mockGetInput.mockReturnValueOnce('')
+            expect(inputs.commit).toBeUndefined()
+        })
     })
 
     it('returns token', () => {
@@ -202,6 +209,18 @@ describe('Inputs', () => {
         })
     })
 
+    describe('generateReleaseNotes', () => {
+        it('returns returns true', function () {
+            mockGetInput.mockReturnValue("true")
+            expect(inputs.generateReleaseNotes).toBe(true)
+        });
+
+        it('returns false when omitted', function () {
+            mockGetInput.mockReturnValue("")
+            expect(inputs.generateReleaseNotes).toBe(false)
+        });
+    })
+
     describe('owner', () => {
         it('returns owner from context', function () {
             process.env.GITHUB_REPOSITORY = "owner/repo"

diff --git a/__tests__/Integration.test.ts b/__tests__/Integration.test.ts
@@ -43,9 +43,10 @@ describe.skip('Integration Test', () => {
                 artifacts: artifacts(),
                 createdReleaseBody: "This release was generated by release-action's integration test",
                 createdReleaseName: "Releases Action Integration Test",
-                commit: "",
+                commit: undefined,
                 discussionCategory: 'Release',
                 draft: false,
+                generateReleaseNotes: true,
                 owner: "ncipollo",
                 createdPrerelease: false,
                 replacesArtifacts: true,

diff --git a/action.yml b/action.yml
@@ -43,6 +43,10 @@ inputs:
     description: "Optionally marks this release as a draft release. Set to true to enable."
     required: false
     default: ''
+  generateReleaseNotes:
+    description: 'Indicates if release notes should be automatically generated.'
+    required: false
+    default: 'false'
   name:
     description: 'An optional name for the release. If this is omitted the tag will be used.'
     required: false

diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/lib/Action.js b/lib/Action.js
@@ -93,7 +93,7 @@ class Action {
     }
     createRelease() {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield this.releases.create(this.inputs.tag, this.inputs.createdReleaseBody, this.inputs.commit, this.inputs.discussionCategory, this.inputs.draft, this.inputs.createdReleaseName, this.inputs.createdPrerelease);
+            return yield this.releases.create(this.inputs.tag, this.inputs.createdReleaseBody, this.inputs.commit, this.inputs.discussionCategory, this.inputs.draft, this.inputs.generateReleaseNotes, this.inputs.createdReleaseName, this.inputs.createdPrerelease);
         });
     }
 }

diff --git a/lib/Inputs.js b/lib/Inputs.js
@@ -70,7 +70,11 @@ class CoreInputs {
         return '';
     }
     get commit() {
-        return core.getInput('commit');
+        const commit = core.getInput('commit');
+        if (commit) {
+            return commit;
+        }
+        return undefined;
     }
     get createdReleaseName() {
         if (CoreInputs.omitName)
@@ -98,6 +102,10 @@ class CoreInputs {
         const draft = core.getInput('draft');
         return draft == 'true';
     }
+    get generateReleaseNotes() {
+        const generate = core.getInput('generateReleaseNotes');
+        return generate == 'true';
+    }
     get owner() {
         let owner = core.getInput('owner');
         if (owner) {

diff --git a/lib/Releases.js b/lib/Releases.js
@@ -15,14 +15,15 @@ class GithubReleases {
         this.inputs = inputs;
         this.git = git;
     }
-    create(tag, body, commitHash, discussionCategory, draft, name, prerelease) {
+    create(tag, body, commitHash, discussionCategory, draft, generateReleaseNotes, name, prerelease) {
         return __awaiter(this, void 0, void 0, function* () {
             // noinspection TypeScriptValidateJSTypes
             return this.git.rest.repos.createRelease({
                 body: body,
                 name: name,
                 discussion_category_name: discussionCategory,
                 draft: draft,
+                generate_release_notes: generateReleaseNotes,
                 owner: this.inputs.owner,
                 prerelease: prerelease,
                 repo: this.inputs.repo,

diff --git a/package.json b/package.json
@@ -3,11 +3,11 @@
   "version": "1.1.0",
   "private": true,
   "description": "An action which manages a github release",
-  "main": "dist/index.js",
+  "main": "lib/main.js",
   "scripts": {
     "build": "tsc",
     "clean": "rm -rf lib/*",
-    "debug": "yarn clean && yarn install && yarn build",
+    "debug": "yarn clean && yarn install && yarn build && yarn package",
     "package": "ncc build --source-map --license licenses.txt",
     "release": "yarn clean && yarn install --production && yarn build && yarn package",
     "test": "jest"

diff --git a/src/Action.ts b/src/Action.ts
@@ -114,6 +114,7 @@ export class Action {
             this.inputs.commit,
             this.inputs.discussionCategory,
             this.inputs.draft,
+            this.inputs.generateReleaseNotes,
             this.inputs.createdReleaseName,
             this.inputs.createdPrerelease
         )

diff --git a/src/Inputs.ts b/src/Inputs.ts
@@ -8,11 +8,12 @@ export interface Inputs {
     readonly allowUpdates: boolean
     readonly artifactErrorsFailBuild: boolean
     readonly artifacts: Artifact[]
-    readonly commit: string
+    readonly commit?: string
     readonly createdReleaseBody?: string
     readonly createdReleaseName?: string
     readonly discussionCategory?: string
     readonly draft: boolean
+    readonly generateReleaseNotes: boolean
     readonly owner: string
     readonly createdPrerelease: boolean
     readonly removeArtifacts: boolean
@@ -83,8 +84,12 @@ export class CoreInputs implements Inputs {
         return ''
     }
 
-    get commit(): string {
-        return core.getInput('commit')
+    get commit(): string | undefined {
+        const commit = core.getInput('commit')
+        if (commit) {
+            return commit
+        }
+        return undefined
     }
 
     get createdReleaseName(): string | undefined {
@@ -117,6 +122,11 @@ export class CoreInputs implements Inputs {
         const draft = core.getInput('draft')
         return draft == 'true'
     }
+
+    get generateReleaseNotes(): boolean {
+        const generate = core.getInput('generateReleaseNotes')
+        return generate == 'true'
+    }
 
     get owner(): string {
         let owner = core.getInput('owner')

diff --git a/src/Releases.ts b/src/Releases.ts
@@ -24,6 +24,7 @@ export interface Releases {
         commitHash?: string,
         discussionCategory?: string,
         draft?: boolean,
+        generateReleaseNotes?: boolean,
         name?: string,
         prerelease?: boolean
     ): Promise<CreateReleaseResponse>
@@ -72,6 +73,7 @@ export class GithubReleases implements Releases {
         commitHash?: string,
         discussionCategory?: string,
         draft?: boolean,
+        generateReleaseNotes?: boolean,
         name?: string,
         prerelease?: boolean
     ): Promise<CreateReleaseResponse> {
@@ -81,6 +83,7 @@ export class GithubReleases implements Releases {
             name: name,
             discussion_category_name: discussionCategory,
             draft: draft,
+            generate_release_notes: generateReleaseNotes,
             owner: this.inputs.owner,
             prerelease: prerelease,
             repo: this.inputs.repo,

diff --git a/tsconfig.json b/tsconfig.json
@@ -1,7 +1,8 @@
 {
   "compilerOptions": {
-    "target": "es6",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
+    "target": "es2015",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
     "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
+    "moduleResolution": "node",
     "outDir": "./lib",                        /* Redirect output structure to the directory. */
     "rootDir": "./src",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
     "strict": true,                           /* Enable all strict type-checking options. */