fix(success): fix access to the release notes (#284)

There was a wrong assumption that release notes would be passed separately to the plugin. This is not the case and could break clients using the new addRelease feature. This commit fixes the access to the release notes of the next release.
semantic-release · Sep 7, 2020 · 24344df · 24344df
1 parent db2e9c8
commit 24344df
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -83,7 +83,8 @@ If you have actions that trigger on newly created releases, please use a generat
 | `failTitle`           | The title of the issue created when a release fails. Set to `false` to disable opening an issue when a release fails.                                                                                  | `The automated release is failing 🚨`                                                                                                                |
 | `labels`              | The [labels](https://help.github.com/articles/about-labels) to add to the issue created when a release fails. Set to `false` to not add any label.                                                     | `['semantic-release']`                                                                                                                               |
 | `assignees`           | The [assignees](https://help.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users) to add to the issue created when a release fails.                                           | -                                                                                                                                                    |
-| `releasedLabels`      | The [labels](https://help.github.com/articles/about-labels) to add to each issue and pull request resolved by the release. Set to `false` to not add any label. See [releasedLabels](#releasedlabels). | `['released<%= nextRelease.channel ? \` on @\${nextRelease.channel}\` : "" %>']`                                                                     |
+| `releasedLabels`      | The [labels](https://help.github.com/articles/about-labels) to add to each issue and pull request resolved by the release. Set to `false` to not add any label. See [releasedLabels](#releasedlabels). | `['released<%= nextRelease.channel ? \` on @\${nextRelease.channel}\` : "" %>']-                                                                                                                                                    |
+| `addReleases`         | Will add release links to the GitHub Release. Can be `false`, `"bottom"` or `"top"`. See [addReleases](#addReleases). | `false`                                                                     |
 
 #### proxy
 

diff --git a/lib/success.js b/lib/success.js
@@ -19,7 +19,6 @@ module.exports = async (pluginConfig, context) => {
     nextRelease,
     releases,
     logger,
-    notes,
   } = context;
   const {
     githubToken,
@@ -152,8 +151,8 @@ module.exports = async (pluginConfig, context) => {
       if (!isEmpty(additionalReleases) && !isNil(ghRelaseId)) {
         const newBody =
           addReleases === 'top'
-            ? additionalReleases.concat('\n---\n', notes)
-            : notes.concat('\n---\n', additionalReleases);
+            ? additionalReleases.concat('\n---\n', nextRelease.notes)
+            : nextRelease.notes.concat('\n---\n', additionalReleases);
         await github.repos.updateRelease({owner, repo, release_id: ghRelaseId, body: newBody});
       }
     }

diff --git a/test/success.test.js b/test/success.test.js
@@ -675,7 +675,6 @@ test.serial('Editing the release to include all release links at the bottom', as
     commits,
     nextRelease,
     releases,
-    notes: nextRelease.notes,
     logger: t.context.logger,
   });
 
@@ -733,7 +732,6 @@ test.serial('Editing the release to include all release links at the top', async
     commits,
     nextRelease,
     releases,
-    notes: nextRelease.notes,
     logger: t.context.logger,
   });