Fixes #185 Add omitDraftDuringUpdate input (#190)

.gitignore

@@ -93,3 +93,6 @@ fabric.properties
 .idea/**/markdown-navigator/
 
 # End of https://www.gitignore.io/api/webstorm
+
+# Coverage
+coverage

README.md

@@ -18,6 +18,7 @@ This action will create a GitHub release and optionally upload an artifact to it
 | name                       | An optional name for the release. If this is omitted the tag will be used.                                                                                                                                                                          | false      | ""                   |
 | omitBody                   | Indicates if the release body should be omitted.                                                                                                                                                                                                    | false      | false                |
 | 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.                                                                     | false      | false                |
+| omitDraftDuringUpdate      | Indicates if the draft flag should be omitted during updates. The draft flag will still be applied for newly created releases. This will preserve the existing draft state during updates.                                                          | false      | false                |
 | omitName                   | Indicates if the release name should be omitted.                                                                                                                                                                                                    | false      | false                |
 | omitNameDuringUpdate       | Indicates if the release name should be omitted during updates. The name will still be applied for newly created releases. This will preserve the existing name during updates.                                                                     | false      | false                |
 | omitPrereleaseDuringUpdate | Indicates if the prerelease flag should be omitted during updates. The prerelease flag will still be applied for newly created releases. This will preserve the existing prerelease state during updates.                                           | false      | false                |

__tests__/Action.test.ts

@@ -22,20 +22,21 @@ const artifacts = [
 ]
 
 const createBody = 'createBody'
+const createDraft = true
 const createName = 'createName'
 const commit = 'commit'
 const discussionCategory = 'discussionCategory'
-const draft = true
 const generateReleaseNotes = true
 const id = 100
 const createPrerelease = true
-const updatePrerelease = false
 const releaseId = 101
 const replacesArtifacts = true
 const tag = 'tag'
 const token = 'token'
 const updateBody = 'updateBody'
+const updateDraft = false
 const updateName = 'updateName'
+const updatePrerelease = false
 const url = 'http://api.example.com'
 
 describe("Action", () => {
@@ -56,7 +57,7 @@ describe("Action", () => {
             createBody,
             commit,
             discussionCategory,
-            draft,
+            createDraft,
             generateReleaseNotes,
             createName,
             createPrerelease)
@@ -76,7 +77,7 @@ describe("Action", () => {
             createBody,
             commit,
             discussionCategory,
-            draft,
+            createDraft,
             generateReleaseNotes,
             createName,
             createPrerelease)
@@ -101,7 +102,7 @@ describe("Action", () => {
             createBody,
             commit,
             discussionCategory,
-            draft,
+            createDraft,
             generateReleaseNotes,
             createName,
             createPrerelease
@@ -121,7 +122,7 @@ describe("Action", () => {
             createBody,
             commit,
             discussionCategory,
-            draft,
+            createDraft,
             generateReleaseNotes,
             createName,
             createPrerelease
@@ -164,7 +165,7 @@ describe("Action", () => {
             createBody,
             commit,
             discussionCategory,
-            draft,
+            createDraft,
             generateReleaseNotes,
             createName,
             createPrerelease
@@ -215,7 +216,7 @@ describe("Action", () => {
             updateBody,
             commit,
             discussionCategory,
-            draft,
+            updateDraft,
             updateName,
             updatePrerelease
         )
@@ -239,7 +240,7 @@ describe("Action", () => {
             createBody,
             commit,
             discussionCategory,
-            draft,
+            createDraft,
             generateReleaseNotes,
             createName,
             createPrerelease
@@ -266,7 +267,7 @@ describe("Action", () => {
             updateBody,
             commit,
             discussionCategory,
-            draft,
+            updateDraft,
             updateName,
             updatePrerelease
         )
@@ -285,7 +286,7 @@ describe("Action", () => {
             updateBody,
             commit,
             discussionCategory,
-            draft,
+            updateDraft,
             updateName,
             updatePrerelease
         )
@@ -304,7 +305,7 @@ describe("Action", () => {
             updateBody,
             commit,
             discussionCategory,
-            draft,
+            updateDraft,
             updateName,
             updatePrerelease
         )
@@ -362,11 +363,11 @@ describe("Action", () => {
                 allowUpdates: allowUpdates,
                 artifactErrorsFailBuild: true,
                 artifacts: inputArtifact,
+                createdDraft: createDraft,
                 createdReleaseBody: createBody,
                 createdReleaseName: createName,
                 commit: commit,
                 discussionCategory: discussionCategory,
-                draft: draft,
                 generateReleaseNotes: true,
                 owner: "owner",
                 createdPrerelease: createPrerelease,
@@ -375,6 +376,7 @@ describe("Action", () => {
                 repo: "repo",
                 tag: tag,
                 token: token,
+                updatedDraft: updateDraft,
                 updatedReleaseBody: updateBody,
                 updatedReleaseName: updateName,
                 updatedPrerelease: updatePrerelease

__tests__/Inputs.test.ts

@@ -108,7 +108,7 @@ describe('Inputs', () => {
 
         it('returns input.artifacts with default contentType', () => {
             mockGetInput.mockReturnValueOnce('art1')
-                .mockReturnValueOnce('raw')
+                .mockReturnValueOnce('')
                 .mockReturnValueOnce('false')
 
             expect(inputs.artifacts).toEqual(artifacts)
@@ -128,6 +128,17 @@ describe('Inputs', () => {
         })
     })
 
+    describe('createdDraft', () => {
+        it('returns false', () => {
+            expect(inputs.createdDraft).toBe(false)
+        })
+
+        it('returns true', () => {
+            mockGetInput.mockReturnValue('true')
+            expect(inputs.createdDraft).toBe(true)
+        })
+    })
+
     describe('createdReleaseBody', () => {
         it('returns input body', () => {
             mockGetInput
@@ -174,7 +185,7 @@ describe('Inputs', () => {
             mockGetInput
                 .mockReturnValueOnce('true')
                 .mockReturnValueOnce('name')
-            expect(inputs.createdReleaseBody).toBeUndefined()
+            expect(inputs.createdReleaseName).toBeUndefined()
         })
 
         it('returns tag', () => {
@@ -198,17 +209,6 @@ describe('Inputs', () => {
         })
     })
 
-    describe('draft', () => {
-        it('returns false', () => {
-            expect(inputs.draft).toBe(false)
-        })
-
-        it('returns true', () => {
-            mockGetInput.mockReturnValue('true')
-            expect(inputs.draft).toBe(true)
-        })
-    })
-
     describe('generateReleaseNotes', () => {
         it('returns returns true', function () {
             mockGetInput.mockReturnValue("true")
@@ -299,6 +299,33 @@ describe('Inputs', () => {
         })
     })
 
+    describe('updatedDraft', () => {
+        it('returns false', () => {
+            expect(inputs.updatedDraft).toBe(false)
+        })
+
+        it('returns true', () => {
+            mockGetInput
+                .mockReturnValueOnce('false')
+                .mockReturnValue('true')
+            expect(inputs.updatedDraft).toBe(true)
+        })
+
+        it('returns true when omitted is blank', () => {
+            mockGetInput
+                .mockReturnValueOnce('')
+                .mockReturnValue('true')
+            expect(inputs.updatedDraft).toBe(true)
+        })
+
+        it('returns undefined when omitted for update', () => {
+            mockGetInput
+                .mockReturnValueOnce('true')
+                .mockReturnValueOnce('true')
+            expect(inputs.updatedDraft).toBeUndefined()
+        })
+    })
+
     describe('updatedReleaseBody', () => {
         it('returns input body', () => {
             mockGetInput

__tests__/Integration.test.ts

@@ -41,11 +41,11 @@ describe.skip('Integration Test', () => {
                 allowUpdates: true,
                 artifactErrorsFailBuild: false,
                 artifacts: artifacts(),
+                createdDraft: false,
                 createdReleaseBody: "This release was generated by release-action's integration test",
                 createdReleaseName: "Releases Action Integration Test",
                 commit: undefined,
                 discussionCategory: 'Release',
-                draft: false,
                 generateReleaseNotes: true,
                 owner: "ncipollo",
                 createdPrerelease: false,
@@ -54,6 +54,7 @@ describe.skip('Integration Test', () => {
                 repo: "actions-playground",
                 tag: "release-action-test",
                 token: getToken(),
+                updatedDraft: false,
                 updatedReleaseBody: "This release was generated by release-action's integration test",
                 updatedReleaseName: "Releases Action Integration Test",
                 updatedPrerelease: false

action.yml

@@ -59,6 +59,10 @@ inputs:
     description: '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.'
     required: false
     default: 'false'
+  omitDraftDuringUpdate:
+    description: 'Indicates if the draft flag should be omitted during updates. The draft flag will still be applied for newly created releases. This will preserve the existing draft state during updates.'
+    required: false
+    default: 'false'
   omitName:
     description: 'Indicates if the release name should be omitted.'
     required: false

dist/index.js

@@ -71,7 +71,7 @@ class Action {
     }
     updateRelease(id) {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield this.releases.update(id, this.inputs.tag, this.inputs.updatedReleaseBody, this.inputs.commit, this.inputs.discussionCategory, this.inputs.draft, this.inputs.updatedReleaseName, this.inputs.updatedPrerelease);
+            return yield this.releases.update(id, this.inputs.tag, this.inputs.updatedReleaseBody, this.inputs.commit, this.inputs.discussionCategory, this.inputs.updatedDraft, this.inputs.updatedReleaseName, this.inputs.updatedPrerelease);
         });
     }
     static noPublishedRelease(error) {
@@ -100,7 +100,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.generateReleaseNotes, 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.createdDraft, this.inputs.generateReleaseNotes, this.inputs.createdReleaseName, this.inputs.createdPrerelease);
         });
     }
 }
@@ -640,14 +640,6 @@ class CoreInputs {
         const allow = core.getInput('artifactErrorsFailBuild');
         return allow == 'true';
     }
-    get createdReleaseBody() {
-        if (CoreInputs.omitBody)
-            return undefined;
-        return this.body;
-    }
-    static get omitBody() {
-        return core.getInput('omitBody') == 'true';
-    }
     get body() {
         const body = core.getInput('body');
         if (body) {
@@ -659,6 +651,30 @@ class CoreInputs {
         }
         return '';
     }
+    get createdDraft() {
+        const draft = core.getInput('draft');
+        return draft == 'true';
+    }
+    get createdPrerelease() {
+        const preRelease = core.getInput('prerelease');
+        return preRelease == 'true';
+    }
+    get createdReleaseBody() {
+        if (CoreInputs.omitBody)
+            return undefined;
+        return this.body;
+    }
+    static get omitBody() {
+        return core.getInput('omitBody') == 'true';
+    }
+    get createdReleaseName() {
+        if (CoreInputs.omitName)
+            return undefined;
+        return this.name;
+    }
+    static get omitName() {
+        return core.getInput('omitName') == 'true';
+    }
     get commit() {
         const commit = core.getInput('commit');
         if (commit) {
@@ -666,11 +682,6 @@ class CoreInputs {
         }
         return undefined;
     }
-    get createdReleaseName() {
-        if (CoreInputs.omitName)
-            return undefined;
-        return this.name;
-    }
     get discussionCategory() {
         const category = core.getInput('discussionCategory');
         if (category) {
@@ -678,9 +689,6 @@ class CoreInputs {
         }
         return undefined;
     }
-    static get omitName() {
-        return core.getInput('omitName') == 'true';
-    }
     get name() {
         const name = core.getInput('name');
         if (name) {
@@ -688,10 +696,6 @@ class CoreInputs {
         }
         return this.tag;
     }
-    get draft() {
-        const draft = core.getInput('draft');
-        return draft == 'true';
-    }
     get generateReleaseNotes() {
         const generate = core.getInput('generateReleaseNotes');
         return generate == 'true';
@@ -703,18 +707,6 @@ class CoreInputs {
         }
         return this.context.repo.owner;
     }
-    get createdPrerelease() {
-        const preRelease = core.getInput('prerelease');
-        return preRelease == 'true';
-    }
-    static get omitPrereleaseDuringUpdate() {
-        return core.getInput('omitPrereleaseDuringUpdate') == 'true';
-    }
-    get updatedPrerelease() {
-        if (CoreInputs.omitPrereleaseDuringUpdate)
-            return undefined;
-        return this.createdPrerelease;
-    }
     get removeArtifacts() {
         const removes = core.getInput('removeArtifacts');
         return removes == 'true';
@@ -745,6 +737,22 @@ class CoreInputs {
     get token() {
         return core.getInput('token', { required: true });
     }
+    get updatedDraft() {
+        if (CoreInputs.omitDraftDuringUpdate)
+            return undefined;
+        return this.createdDraft;
+    }
+    static get omitDraftDuringUpdate() {
+        return core.getInput('omitDraftDuringUpdate') == 'true';
+    }
+    get updatedPrerelease() {
+        if (CoreInputs.omitPrereleaseDuringUpdate)
+            return undefined;
+        return this.createdPrerelease;
+    }
+    static get omitPrereleaseDuringUpdate() {
+        return core.getInput('omitPrereleaseDuringUpdate') == 'true';
+    }
     get updatedReleaseBody() {
         if (CoreInputs.omitBody || CoreInputs.omitBodyDuringUpdate)
             return undefined;

lib/Action.js

@@ -64,7 +64,7 @@ class Action {
     }
     updateRelease(id) {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield this.releases.update(id, this.inputs.tag, this.inputs.updatedReleaseBody, this.inputs.commit, this.inputs.discussionCategory, this.inputs.draft, this.inputs.updatedReleaseName, this.inputs.updatedPrerelease);
+            return yield this.releases.update(id, this.inputs.tag, this.inputs.updatedReleaseBody, this.inputs.commit, this.inputs.discussionCategory, this.inputs.updatedDraft, this.inputs.updatedReleaseName, this.inputs.updatedPrerelease);
         });
     }
     static noPublishedRelease(error) {
@@ -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.generateReleaseNotes, 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.createdDraft, this.inputs.generateReleaseNotes, this.inputs.createdReleaseName, this.inputs.createdPrerelease);
         });
     }
 }

lib/Inputs.js

@@ -54,14 +54,6 @@ class CoreInputs {
         const allow = core.getInput('artifactErrorsFailBuild');
         return allow == 'true';
     }
-    get createdReleaseBody() {
-        if (CoreInputs.omitBody)
-            return undefined;
-        return this.body;
-    }
-    static get omitBody() {
-        return core.getInput('omitBody') == 'true';
-    }
     get body() {
         const body = core.getInput('body');
         if (body) {
@@ -73,6 +65,30 @@ class CoreInputs {
         }
         return '';
     }
+    get createdDraft() {
+        const draft = core.getInput('draft');
+        return draft == 'true';
+    }
+    get createdPrerelease() {
+        const preRelease = core.getInput('prerelease');
+        return preRelease == 'true';
+    }
+    get createdReleaseBody() {
+        if (CoreInputs.omitBody)
+            return undefined;
+        return this.body;
+    }
+    static get omitBody() {
+        return core.getInput('omitBody') == 'true';
+    }
+    get createdReleaseName() {
+        if (CoreInputs.omitName)
+            return undefined;
+        return this.name;
+    }
+    static get omitName() {
+        return core.getInput('omitName') == 'true';
+    }
     get commit() {
         const commit = core.getInput('commit');
         if (commit) {
@@ -80,11 +96,6 @@ class CoreInputs {
         }
         return undefined;
     }
-    get createdReleaseName() {
-        if (CoreInputs.omitName)
-            return undefined;
-        return this.name;
-    }
     get discussionCategory() {
         const category = core.getInput('discussionCategory');
         if (category) {
@@ -92,9 +103,6 @@ class CoreInputs {
         }
         return undefined;
     }
-    static get omitName() {
-        return core.getInput('omitName') == 'true';
-    }
     get name() {
         const name = core.getInput('name');
         if (name) {
@@ -102,10 +110,6 @@ class CoreInputs {
         }
         return this.tag;
     }
-    get draft() {
-        const draft = core.getInput('draft');
-        return draft == 'true';
-    }
     get generateReleaseNotes() {
         const generate = core.getInput('generateReleaseNotes');
         return generate == 'true';
@@ -117,18 +121,6 @@ class CoreInputs {
         }
         return this.context.repo.owner;
     }
-    get createdPrerelease() {
-        const preRelease = core.getInput('prerelease');
-        return preRelease == 'true';
-    }
-    static get omitPrereleaseDuringUpdate() {
-        return core.getInput('omitPrereleaseDuringUpdate') == 'true';
-    }
-    get updatedPrerelease() {
-        if (CoreInputs.omitPrereleaseDuringUpdate)
-            return undefined;
-        return this.createdPrerelease;
-    }
     get removeArtifacts() {
         const removes = core.getInput('removeArtifacts');
         return removes == 'true';
@@ -159,6 +151,22 @@ class CoreInputs {
     get token() {
         return core.getInput('token', { required: true });
     }
+    get updatedDraft() {
+        if (CoreInputs.omitDraftDuringUpdate)
+            return undefined;
+        return this.createdDraft;
+    }
+    static get omitDraftDuringUpdate() {
+        return core.getInput('omitDraftDuringUpdate') == 'true';
+    }
+    get updatedPrerelease() {
+        if (CoreInputs.omitPrereleaseDuringUpdate)
+            return undefined;
+        return this.createdPrerelease;
+    }
+    static get omitPrereleaseDuringUpdate() {
+        return core.getInput('omitPrereleaseDuringUpdate') == 'true';
+    }
     get updatedReleaseBody() {
         if (CoreInputs.omitBody || CoreInputs.omitBodyDuringUpdate)
             return undefined;

package.json

@@ -7,6 +7,7 @@
   "scripts": {
     "build": "tsc",
     "clean": "rm -rf lib/*",
+    "coverage": "jest --coverage",
     "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",

src/Action.ts

@@ -78,7 +78,7 @@ export class Action {
             this.inputs.updatedReleaseBody,
             this.inputs.commit,
             this.inputs.discussionCategory,
-            this.inputs.draft,
+            this.inputs.updatedDraft,
             this.inputs.updatedReleaseName,
             this.inputs.updatedPrerelease
         )
@@ -113,7 +113,7 @@ export class Action {
             this.inputs.createdReleaseBody,
             this.inputs.commit,
             this.inputs.discussionCategory,
-            this.inputs.draft,
+            this.inputs.createdDraft,
             this.inputs.generateReleaseNotes,
             this.inputs.createdReleaseName,
             this.inputs.createdPrerelease

src/Inputs.ts

@@ -9,18 +9,19 @@ export interface Inputs {
     readonly artifactErrorsFailBuild: boolean
     readonly artifacts: Artifact[]
     readonly commit?: string
+    readonly createdDraft: boolean
+    readonly createdPrerelease: boolean
     readonly createdReleaseBody?: string
     readonly createdReleaseName?: string
     readonly discussionCategory?: string
-    readonly draft: boolean
     readonly generateReleaseNotes: boolean
     readonly owner: string
-    readonly createdPrerelease: boolean
     readonly removeArtifacts: boolean
     readonly replacesArtifacts: boolean
     readonly repo: string
     readonly tag: string
     readonly token: string
+    readonly updatedDraft?: boolean
     readonly updatedReleaseBody?: string
     readonly updatedReleaseName?: string
     readonly updatedPrerelease?: boolean
@@ -61,15 +62,6 @@ export class CoreInputs implements Inputs {
         return allow == 'true'
     }
 
-    get createdReleaseBody(): string | undefined {
-        if (CoreInputs.omitBody) return undefined
-        return this.body
-    }
-
-    private static get omitBody(): boolean {
-        return core.getInput('omitBody') == 'true'
-    }
-
     private get body(): string | undefined {
         const body = core.getInput('body')
         if (body) {
@@ -84,6 +76,34 @@ export class CoreInputs implements Inputs {
         return ''
     }
 
+    get createdDraft(): boolean {
+        const draft = core.getInput('draft')
+        return draft == 'true'
+    }
+
+    get createdPrerelease(): boolean {
+        const preRelease = core.getInput('prerelease')
+        return preRelease == 'true'
+    }
+
+    get createdReleaseBody(): string | undefined {
+        if (CoreInputs.omitBody) return undefined
+        return this.body
+    }
+
+    private static get omitBody(): boolean {
+        return core.getInput('omitBody') == 'true'
+    }
+
+    get createdReleaseName(): string | undefined {
+        if (CoreInputs.omitName) return undefined
+        return this.name
+    }
+
+    private static get omitName(): boolean {
+        return core.getInput('omitName') == 'true'
+    }
+
     get commit(): string | undefined {
         const commit = core.getInput('commit')
         if (commit) {
@@ -92,11 +112,6 @@ export class CoreInputs implements Inputs {
         return undefined
     }
 
-    get createdReleaseName(): string | undefined {
-        if (CoreInputs.omitName) return undefined
-        return this.name
-    }
-
     get discussionCategory(): string | undefined {
         const category = core.getInput('discussionCategory')
         if (category) {
@@ -105,10 +120,6 @@ export class CoreInputs implements Inputs {
         return undefined
     }
 
-    private static get omitName(): boolean {
-        return core.getInput('omitName') == 'true'
-    }
-
     private get name(): string | undefined {
         const name = core.getInput('name')
         if (name) {
@@ -118,11 +129,6 @@ export class CoreInputs implements Inputs {
         return this.tag
     }
     
-    get draft(): boolean {
-        const draft = core.getInput('draft')
-        return draft == 'true'
-    }
-    
     get generateReleaseNotes(): boolean {
         const generate = core.getInput('generateReleaseNotes')
         return generate == 'true'
@@ -136,19 +142,6 @@ export class CoreInputs implements Inputs {
         return this.context.repo.owner
     }
     
-    get createdPrerelease(): boolean {
-        const preRelease = core.getInput('prerelease')
-        return preRelease == 'true'
-    }
-
-    private static get omitPrereleaseDuringUpdate(): boolean {
-        return core.getInput('omitPrereleaseDuringUpdate') == 'true'
-    }
-
-    get updatedPrerelease(): boolean | undefined {
-        if (CoreInputs.omitPrereleaseDuringUpdate) return undefined
-        return this.createdPrerelease
-    }
     get removeArtifacts(): boolean {
         const removes = core.getInput('removeArtifacts')
         return removes == 'true'
@@ -185,6 +178,24 @@ export class CoreInputs implements Inputs {
         return core.getInput('token', {required: true})
     }
 
+    get updatedDraft(): boolean | undefined {
+        if (CoreInputs.omitDraftDuringUpdate) return undefined
+        return this.createdDraft
+    }
+
+    private static get omitDraftDuringUpdate(): boolean {
+        return core.getInput('omitDraftDuringUpdate') == 'true'
+    }
+    
+    get updatedPrerelease(): boolean | undefined {
+        if (CoreInputs.omitPrereleaseDuringUpdate) return undefined
+        return this.createdPrerelease
+    }
+
+    private static get omitPrereleaseDuringUpdate(): boolean {
+        return core.getInput('omitPrereleaseDuringUpdate') == 'true'
+    }
+
     get updatedReleaseBody(): string | undefined {
         if (CoreInputs.omitBody || CoreInputs.omitBodyDuringUpdate) return undefined
         return this.body