Add publish input

README.md

@@ -44,6 +44,7 @@ jobs:
 | `notes-header` | `string` | The header to use for the release notes. |
 | `notes-footer` | `string` | The footer to use for the release notes. |
 | `variables` | `list` | A list of variables to use in the header and footer. |
+| `publish` | `boolean` | Whether to publish the release. (default `false`) |
 
 ## Outputs
 

__tests__/notes.test.ts

@@ -81,6 +81,7 @@ describe('generateReleaseNotes', () => {
       footer: 'footer with version {{version}} and baz {{baz}}',
       variables: ['foo=bar', 'baz=qux'],
       collapseAfter: 0,
+      publish: false,
     }
     const releaseData = {
       releases: [],
@@ -117,6 +118,7 @@ describe('generateReleaseNotes', () => {
       footer: 'footer with version {{version}}',
       variables: [],
       collapseAfter: 3,
+      publish: false,
     }
 
     const releaseData = {

__tests__/release.test.ts

@@ -139,6 +139,7 @@ describe('createOrUpdateRelease', () => {
     footer: 'footer',
     variables: [],
     collapseAfter: 0,
+    publish: false,
   }
   beforeEach(() => {
     jest.clearAllMocks()

__tests__/version.test.ts

@@ -11,6 +11,7 @@ describe('getVersionIncrease', () => {
     footer: '',
     variables: [],
     collapseAfter: 0,
+    publish: false,
   }
 
   const releaseData = {

action.yml

@@ -30,6 +30,10 @@ inputs:
     description: 'Number of lines required for the section to be collapsed'
     default: '0'
     required: false
+  publish:
+    description: 'Whether to publish the release'
+    default: 'false'
+    required: false
 outputs:
   version:
     description: 'The version of the release'

src/context.ts

@@ -9,6 +9,7 @@ export interface Inputs {
   footer: string
   variables: string[]
   collapseAfter: number
+  publish: boolean
 }
 
 export function getInputs(): Inputs {
@@ -20,5 +21,6 @@ export function getInputs(): Inputs {
     footer: core.getInput('notes-footer'),
     variables: Util.getInputList('variables'),
     collapseAfter: parseInt(core.getInput('collapse-after'), 10),
+    publish: core.getBooleanInput('publish'),
   }
 }

src/release.ts

@@ -82,7 +82,7 @@ export async function createOrUpdateRelease(
     return
   }
 
-  const draft = releaseData.branch !== 'tag'
+  const draft = releaseData.branch !== 'tag' || !inputs.publish
   releaseData.branch = (releaseData.branch === 'tag' && releaseDraft?.target_commitish) || releaseData.branch
   core.debug(`releaseData.branch: ${releaseData.branch}`)
   const newReleaseNotes = await generateReleaseNotes(client, inputs, releaseData)