Standardize on separate call to generate release notes

__tests__/Action.test.ts

@@ -55,6 +55,7 @@ describe("Action", () => {
         applyReleaseDataMock.mockClear()
         applyAssetUrlsMock.mockClear()
         createMock.mockClear()
+        genReleaseNotesMock.mockClear()
         getMock.mockClear()
         listMock.mockClear()
         shouldSkipMock.mockClear()
@@ -62,18 +63,81 @@ describe("Action", () => {
         uploadMock.mockClear()
     })
 
+    it("creates release with generated release notes when no body provided", async () => {
+        const action = createAction(false, false, false, true, false, "")
+
+        await action.perform()
+
+        expect(genReleaseNotesMock).toHaveBeenCalledWith(tag)
+        expect(createMock).toHaveBeenCalledWith(
+            tag,
+            generatedReleaseBody,
+            commit,
+            discussionCategory,
+            createDraft,
+            makeLatest,
+            createName,
+            createPrerelease
+        )
+        expect(uploadMock).not.toHaveBeenCalled()
+        assertOutputApplied()
+        assertAssetUrlsApplied({})
+    })
+
+    it("creates release with generated release notes that override existing body", async () => {
+        const action = createAction(false, false, false, true, false, "existing body")
+
+        await action.perform()
+
+        expect(genReleaseNotesMock).toHaveBeenCalledWith(tag)
+        expect(createMock).toHaveBeenCalledWith(
+            tag,
+            generatedReleaseBody,
+            commit,
+            discussionCategory,
+            createDraft,
+            makeLatest,
+            createName,
+            createPrerelease
+        )
+        expect(uploadMock).not.toHaveBeenCalled()
+        assertOutputApplied()
+        assertAssetUrlsApplied({})
+    })
+
+    it("creates release with static body when generateReleaseNotes is false", async () => {
+        const action = createAction(false, false, false, false, false, "static body")
+
+        await action.perform()
+
+        expect(genReleaseNotesMock).not.toHaveBeenCalled()
+        expect(createMock).toHaveBeenCalledWith(
+            tag,
+            "static body",
+            commit,
+            discussionCategory,
+            createDraft,
+            makeLatest,
+            createName,
+            createPrerelease
+        )
+        expect(uploadMock).not.toHaveBeenCalled()
+        assertOutputApplied()
+        assertAssetUrlsApplied({})
+    })
+
     it("creates release but does not upload if no artifact", async () => {
         const action = createAction(false, false)
 
         await action.perform()
 
+        expect(genReleaseNotesMock).toHaveBeenCalledWith(tag)
         expect(createMock).toHaveBeenCalledWith(
             tag,
-            createBody,
+            generatedReleaseBody,
             commit,
             discussionCategory,
             createDraft,
-            generateReleaseNotes,
             makeLatest,
             createName,
             createPrerelease
@@ -90,13 +154,13 @@ describe("Action", () => {
 
         await action.perform()
 
+        expect(genReleaseNotesMock).toHaveBeenCalledWith(tag)
         expect(createMock).toHaveBeenCalledWith(
             tag,
-            createBody,
+            generatedReleaseBody,
             commit,
             discussionCategory,
             createDraft,
-            generateReleaseNotes,
             makeLatest,
             createName,
             createPrerelease
@@ -119,13 +183,13 @@ describe("Action", () => {
 
         await action.perform()
 
+        expect(genReleaseNotesMock).toHaveBeenCalledWith(tag)
         expect(createMock).toHaveBeenCalledWith(
             tag,
-            createBody,
+            generatedReleaseBody,
             commit,
             discussionCategory,
             createDraft,
-            generateReleaseNotes,
             makeLatest,
             createName,
             createPrerelease
@@ -143,13 +207,13 @@ describe("Action", () => {
 
         await action.perform()
 
+        expect(genReleaseNotesMock).toHaveBeenCalledWith(tag)
         expect(createMock).toHaveBeenCalledWith(
             tag,
-            createBody,
+            generatedReleaseBody,
             commit,
             discussionCategory,
             createDraft,
-            generateReleaseNotes,
             makeLatest,
             createName,
             createPrerelease
@@ -209,13 +273,13 @@ describe("Action", () => {
             expect(error).toEqual("error")
         }
 
+        expect(genReleaseNotesMock).toHaveBeenCalledWith(tag)
         expect(createMock).toHaveBeenCalledWith(
             tag,
-            createBody,
+            generatedReleaseBody,
             commit,
             discussionCategory,
             createDraft,
-            generateReleaseNotes,
             makeLatest,
             createName,
             createPrerelease
@@ -310,13 +374,13 @@ describe("Action", () => {
             expect(error).toEqual(expectedError)
         }
 
+        expect(genReleaseNotesMock).toHaveBeenCalledWith(tag)
         expect(createMock).toHaveBeenCalledWith(
             tag,
-            createBody,
+            generatedReleaseBody,
             commit,
             discussionCategory,
             createDraft,
-            generateReleaseNotes,
             makeLatest,
             createName,
             createPrerelease
@@ -484,7 +548,8 @@ describe("Action", () => {
         hasArtifact: boolean,
         removeArtifacts = false,
         generateReleaseNotes = true,
-        omitBodyDuringUpdate = false
+        omitBodyDuringUpdate = false,
+        createdReleaseBody = createBody
     ): Action {
         let inputArtifact: Artifact[]
 
@@ -551,7 +616,7 @@ describe("Action", () => {
                 artifactErrorsFailBuild: true,
                 artifacts: inputArtifact,
                 createdDraft: createDraft,
-                createdReleaseBody: createBody,
+                createdReleaseBody: createdReleaseBody,
                 createdReleaseName: createName,
                 commit,
                 discussionCategory,

dist/licenses.txt

@@ -93,6 +93,60 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 IN THE SOFTWARE.
 
+@isaacs/balanced-match
+MIT
+(MIT)
+
+Original code Copyright Julian Gruber <julian@juliangruber.com>
+
+Port to TypeScript Copyright Isaac Z. Schlueter <i@izs.me>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+
+@isaacs/brace-expansion
+MIT
+MIT License
+
+Copyright Julian Gruber <julian@juliangruber.com>
+
+TypeScript port Copyright Isaac Z. Schlueter <i@izs.me>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+
 @octokit/auth-token
 MIT
 The MIT License
@@ -265,31 +319,6 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 
 
-balanced-match
-MIT
-(MIT)
-
-Copyright (c) 2013 Julian Gruber &lt;julian@juliangruber.com&gt;
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the "Software"), to deal in
-the Software without restriction, including without limitation the rights to
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
-of the Software, and to permit persons to whom the Software is furnished to do
-so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
-
-
 before-after-hook
 Apache-2.0
                                  Apache License
@@ -495,31 +524,6 @@ Apache-2.0
    limitations under the License.
 
 
-brace-expansion
-MIT
-MIT License
-
-Copyright (c) 2013 Julian Gruber <julian@juliangruber.com>
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
-
-
 deprecation
 ISC
 The ISC License

src/Action.ts

@@ -141,13 +141,19 @@ export class Action {
     }
 
     private async createRelease(): Promise<CreateReleaseResponse> {
+        let releaseBody = this.inputs.createdReleaseBody
+
+        if (this.inputs.generateReleaseNotes) {
+            const response = await this.releases.generateReleaseNotes(this.inputs.tag)
+            releaseBody = response.data.body
+        }
+
         return await this.releases.create(
             this.inputs.tag,
-            this.inputs.createdReleaseBody,
+            releaseBody,
             this.inputs.commit,
             this.inputs.discussionCategory,
             this.inputs.createdDraft,
-            this.inputs.generateReleaseNotes,
             this.inputs.makeLatest,
             this.inputs.createdReleaseName,
             this.inputs.createdPrerelease

src/Releases.ts

@@ -27,7 +27,6 @@ export interface Releases {
         commitHash?: string,
         discussionCategory?: string,
         draft?: boolean,
-        generateReleaseNotes?: boolean,
         makeLatest?: "legacy" | "true" | "false" | undefined,
         name?: string,
         prerelease?: boolean
@@ -80,7 +79,6 @@ export class GithubReleases implements Releases {
         commitHash?: string,
         discussionCategory?: string,
         draft?: boolean,
-        generateReleaseNotes?: boolean,
         makeLatest?: "legacy" | "true" | "false" | undefined,
         name?: string,
         prerelease?: boolean
@@ -91,7 +89,6 @@ export class GithubReleases implements Releases {
             name: name,
             discussion_category_name: discussionCategory,
             draft: draft,
-            generate_release_notes: generateReleaseNotes,
             make_latest: makeLatest,
             owner: this.inputs.owner,
             prerelease: prerelease,