feat: add release notes to output

cycjimmy · Mar 15, 2020 · a56320d · a56320d
1 parent 9786c42
commit a56320d
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 2 deletions.
diff --git a/.github/workflows/testRelease.yml b/.github/workflows/testRelease.yml
@@ -36,4 +36,5 @@ jobs:
           echo ${{ steps.semantic.outputs.new_release_major_version }}
           echo ${{ steps.semantic.outputs.new_release_minor_version }}
           echo ${{ steps.semantic.outputs.new_release_patch_version }}
+          echo ${{ steps.semantic.outputs.new_release_notes }}
 
diff --git a/README.md b/README.md
@@ -27,6 +27,7 @@ GitHub Action for [Semantic Release](https://github.com/semantic-release/semanti
   * `new_release_major_version`: Major version of the new release
   * `new_release_minor_version`: Minor version of the new release
   * `new_release_patch_version`: Patch version of the new release
+  * `new_release_notes`: The release notes for the new release.
 
 ### Examples
 

diff --git a/action.yml b/action.yml
@@ -24,6 +24,8 @@ outputs:
     description: 'Minor version of the new release'
   new_release_patch_version:
     description: 'Patch version of the new release'
+  new_release_notes:
+    description: 'The release notes for the new release.'
 runs:
   using: 'node12'
   main: 'index.js'
diff --git a/src/outputs.json b/src/outputs.json
@@ -3,5 +3,6 @@
   "new_release_version": "new_release_version",
   "new_release_major_version": "new_release_major_version",
   "new_release_minor_version": "new_release_minor_version",
-  "new_release_patch_version": "new_release_patch_version"
+  "new_release_patch_version": "new_release_patch_version",
+  "new_release_notes": "new_release_notes"
 }
diff --git a/src/windUpJob.task.js b/src/windUpJob.task.js
@@ -24,7 +24,7 @@ module.exports = async (result) => {
     core.debug(`The release was published with plugin "${release.pluginName}".`);
   }
 
-  const {version} = nextRelease;
+  const {version, notes} = nextRelease;
   const [major, minor, patch] = version.split('.');
 
   // set outputs
@@ -33,4 +33,5 @@ module.exports = async (result) => {
   core.setOutput(outputs.new_release_major_version, major);
   core.setOutput(outputs.new_release_minor_version, minor);
   core.setOutput(outputs.new_release_patch_version, patch);
+  core.setOutput(outputs.new_release_notes, notes);
 };