Add publish input

lucacome · Apr 27, 2023 · 72cd7ea · 72cd7ea
1 parent efc52f6
commit 72cd7ea
Show file tree

Hide file tree

Showing 9 changed files with 122 additions and 179 deletions.
diff --git a/README.md b/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
 

diff --git a/__tests__/notes.test.ts b/__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 = {

diff --git a/__tests__/release.test.ts b/__tests__/release.test.ts
@@ -139,6 +139,7 @@ describe('createOrUpdateRelease', () => {
     footer: 'footer',
     variables: [],
     collapseAfter: 0,
+    publish: false,
   }
   beforeEach(() => {
     jest.clearAllMocks()

diff --git a/__tests__/version.test.ts b/__tests__/version.test.ts
@@ -11,6 +11,7 @@ describe('getVersionIncrease', () => {
     footer: '',
     variables: [],
     collapseAfter: 0,
+    publish: false,
   }
 
   const releaseData = {

diff --git a/action.yml b/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'