Merge pull request #29 from Updater/fix-missing-context

Fix missing context

Author: pmowrer

bin/semantic-release-github-pr.js

@@ -20,9 +20,16 @@ const { getCurrentBranchName } = require('../src/git-utils');
     // Set `dry-run` to keep `semantic-release` from publishing an actual release.
     `--dry-run`,
     `--branch=${branch}`,
-    // We hard-set our versions of `analyze-commits` and `generate-notes`.
+    // We hard-set our version of `analyze-commits (preventing accidental override)`.
     `--analyze-commits=${plugins}`,
-    `--generate-notes=${plugins}`,
+
+    // TODO: Used to hard-set our version of `generateNotes` as well, but no
+    // longer seems possible after it became a "multi plugin" (array)
+    // configuration in `semantic-release` 15.7.0. Instead, it's soft-set set
+    // via the shareable config option below (`--extends`). It doesn't matter
+    // other than it allows the user to break the plugin by (inadvertently)
+    // overriding our version of `generateNotes`.
+
     // We use `extends` here to pick up a soft-set default for `verifyConditions`,
     // allowing users to override it (setting a plugin directly from the CLI
     // trumps plugins read from a config file).

package.json

@@ -3,7 +3,10 @@
   "version": "0.0.0-development",
   "description": " A `semantic-release` plugin that creates a changelog comment on Github PRs.",
   "main": "src/index.js",
-  "files": ["src", "bin"],
+  "files": [
+    "src",
+    "bin"
+  ],
   "repository": "https://github.com/Updater/semantic-release-github-pr.git",
   "scripts": {
     "format": "prettier --write --single-quote --trailing-comma es5",
@@ -22,7 +25,7 @@
     "parse-github-url": "^1.0.1",
     "ramda": "^0.25.0",
     "read-pkg": "^3.0.0",
-    "semantic-release-plugin-decorators": "^1.2.1"
+    "semantic-release-plugin-decorators": "^2.0.0"
   },
   "devDependencies": {
     "debug": "^3.1.0",

src/github-init.js

@@ -7,11 +7,12 @@ const { parse } = require('url');
  * https://github.com/semantic-release/github/blob/d49ce22a7c2d4b0861de31ba00c0b213b23e5051/lib/publish.js#L11
  *
  * @param pluginConfig The config object passed to `semantic-release` plugins.
+ * @param context The context object passed to `semantic-release` plugins.
  * @returns An initialized instance of `github`.
  */
-module.exports = pluginConfig => {
+module.exports = (pluginConfig, context) => {
   const { githubToken, githubUrl, githubApiPathPrefix } = resolveConfig(
-    pluginConfig
+    pluginConfig, context
   );
 
   let { port, protocol, hostname: host } = githubUrl ? parse(githubUrl) : {};

src/index.js

@@ -1,5 +1,8 @@
 const { compose } = require('ramda');
-const { wrapPlugin } = require('semantic-release-plugin-decorators');
+const {
+  wrapPlugin,
+  appendMultiPlugin,
+} = require('semantic-release-plugin-decorators');
 const pluginDefinitions = require('semantic-release/lib/definitions/plugins');
 
 const { parse } = require('./comment-tag');
@@ -12,7 +15,7 @@ const withMatchingPullRequests = require('./with-matching-pull-requests');
 
 const NAMESPACE = 'githubPr';
 
-const decoratePlugins = compose(
+const decoratePlugin = compose(
   withGithub,
   withGitHead,
   withMatchingPullRequests,
@@ -25,14 +28,14 @@ const decoratePlugins = compose(
 const analyzeCommits = wrapPlugin(
   NAMESPACE,
   'analyzeCommits',
-  plugin => async (pluginConfig, config) => {
+  plugin => async (pluginConfig, context) => {
     const { githubRepo, pullRequests } = pluginConfig;
-    const nextRelease = await plugin(pluginConfig, config);
+    const nextRelease = await plugin(pluginConfig, context);
 
     if (!nextRelease) {
       await pullRequests.forEach(async pr => {
         const { number } = pr;
-        const createChangelogOnPr = createChangelog(pluginConfig, config);
+        const createChangelogOnPr = createChangelog(pluginConfig, context);
         const { data: comments } = await githubRepo.getIssueComments({
           number,
         });
@@ -49,35 +52,35 @@ const analyzeCommits = wrapPlugin(
     // Clean up stale changelog comments, possibly sparing the "no release"
     // comment if this package doesn't have a new release.
     await pullRequests.forEach(
-      deleteStaleChangelogs(!nextRelease)(pluginConfig, config)
+      deleteStaleChangelogs(!nextRelease)(pluginConfig, context)
     );
 
     return nextRelease;
   },
   pluginDefinitions.analyzeCommits.default
 );
 
-const generateNotes = wrapPlugin(
+// Append a plugin that generates PR comments from the release notes resulting
+// from the configured `generateNotes` plugins that run ahead of it.
+const generateNotes = appendMultiPlugin(
   NAMESPACE,
   'generateNotes',
-  plugin => async (pluginConfig, config) => {
+  decoratePlugin(async (pluginConfig, context) => {
     const { pullRequests } = pluginConfig;
-    const { nextRelease } = config;
-
-    nextRelease.notes = await plugin(pluginConfig, config);
+    const { nextRelease } = context;
 
     await pullRequests.forEach(
       // Create "release" comment
-      createChangelog(pluginConfig, { ...config, nextRelease })
+      createChangelog(pluginConfig, context)
     );
 
     return nextRelease.notes;
-  },
+  }),
   pluginDefinitions.generateNotes.default
 );
 
 module.exports = {
   verifyConditions: '@semantic-release/github',
-  analyzeCommits: decoratePlugins(analyzeCommits),
-  generateNotes: decoratePlugins(generateNotes),
+  analyzeCommits: decoratePlugin(analyzeCommits),
+  generateNotes,
 };

src/with-git-head.js

@@ -8,12 +8,12 @@ const { gitHead: getGitHead } = require('semantic-release/lib/git');
  * https://github.com/semantic-release/semantic-release/blob/754b420fd6f26444eea53155fc0dbd08a51b4dcb/index.js#L38
  * @param plugin
  */
-const withGitHead = plugin => async (pluginConfig, config) => {
-  const { nextRelease } = config;
+const withGitHead = plugin => async (pluginConfig, context) => {
+  const { nextRelease } = context;
   const gitHead = nextRelease ? nextRelease.gitHead : await getGitHead();
 
   return plugin(pluginConfig, {
-    ...config,
+    ...context,
     nextRelease: {
       ...nextRelease,
       gitHead,

src/with-github.js

@@ -2,17 +2,17 @@ const githubInit = require('./github-init');
 const githubRepo = require('./github-repo');
 const parseGithubUrl = require('parse-github-url');
 
-const withGithub = plugin => (pluginConfig, config) => {
-  const github = githubInit(pluginConfig);
-  const { options: { repositoryUrl } } = config;
+const withGithub = plugin => (pluginConfig, context) => {
+  const github = githubInit(pluginConfig, context);
+  const { options: { repositoryUrl } } = context;
   const { name: repo, owner } = parseGithubUrl(repositoryUrl);
 
   return plugin(
     {
       ...pluginConfig,
       githubRepo: githubRepo(github, { owner, repo }),
     },
-    config
+    context
   );
 };
 

src/with-matching-pull-requests.js

@@ -1,9 +1,9 @@
 const isMatchingPullRequestFor = require('./is-matching-pull-request-for');
 const { getCurrentBranchName } = require('./git-utils');
 
-const withMatchingPullRequests = plugin => async (pluginConfig, config) => {
+const withMatchingPullRequests = plugin => async (pluginConfig, context) => {
   const { githubRepo } = pluginConfig;
-  const { nextRelease: { gitHead }, options: { branch } } = config;
+  const { nextRelease: { gitHead }, options: { branch } } = context;
   const matchingPrFilter = isMatchingPullRequestFor(gitHead);
   const { data: openPullRequests = [] } = await githubRepo.getAllPullRequests({
     // Determine whether the user provided a custom `branch` value.
@@ -17,7 +17,7 @@ const withMatchingPullRequests = plugin => async (pluginConfig, config) => {
       ...pluginConfig,
       pullRequests: openPullRequests.filter(matchingPrFilter),
     },
-    config
+    context
   );
 };
 

src/with-npm-package.js

@@ -1,8 +1,8 @@
 const readPkg = require('read-pkg');
 
-const withNpmPackage = plugin => async (pluginConfig, config) => {
+const withNpmPackage = plugin => async (pluginConfig, context) => {
   const npmPackage = await readPkg();
-  return plugin({ ...pluginConfig, npmPackage }, config);
+  return plugin({ ...pluginConfig, npmPackage }, context);
 };
 
 module.exports = withNpmPackage;