fix: revert to execa ^1.0.0

This patch documents that the `plugin` config option is an override, not
a merge with the default. This is significant, for example, if you
customise the github plugin as it will then prevent npm publishing by
default unless the npm plugin is also defined manually.

README.md

@@ -17,11 +17,6 @@
     <img alt="semantic-release" src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg">
   </a>
 </p>
-<p align="center">
-  <a href="https://waffle.io/semantic-release/semantic-release">
-    <img alt="Waffle.io" src="https://badge.waffle.io/semantic-release/semantic-release.svg?columns=all">
-  </a>
-</p>
 <p align="center">
   <a href="https://www.npmjs.com/package/semantic-release">
     <img alt="npm latest version" src="https://img.shields.io/npm/v/semantic-release/latest.svg">

bin/semantic-release.js

@@ -21,9 +21,8 @@ See https://github.com/semantic-release/semantic-release/blob/master/docs/suppor
   process.exit(1);
 }
 
-execa
-  .stdout('git', ['--version'])
-  .then(stdout => {
+execa('git', ['--version'])
+  .then(({stdout}) => {
     var gitVersion = findVersions(stdout)[0];
     if (semver.lt(gitVersion, MIN_GIT_VERSION)) {
       console.error(`[semantic-release]: Git version ${MIN_GIT_VERSION} is required. Found ${gitVersion}.`);

docs/extending/plugins-list.md

@@ -2,15 +2,19 @@
 
 ## Official plugins
 - [@semantic-release/commit-analyzer](https://github.com/semantic-release/commit-analyzer)
+  - **Note**: this is already part of semantic-release and does not have to be installed separately
   - `analyzeCommits`: Determine the type of release by analyzing commits with [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog)
 - [@semantic-release/release-notes-generator](https://github.com/semantic-release/release-notes-generator)
+  - **Note**: this is already part of semantic-release and does not have to be installed separately
   - `generateNotes`: Generate release notes for the commits added since the last release with [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog)
 - [@semantic-release/github](https://github.com/semantic-release/github)
+  - **Note**: this is already part of semantic-release and does not have to be installed separately
   - `verifyConditions`: Verify the presence and the validity of the GitHub authentication and release configuration
   - `publish`: Publish a [GitHub release](https://help.github.com/articles/about-releases)
   - `success`: Add a comment to GitHub issues and pull requests resolved in the release
   - `fail`: Open a GitHub issue when a release fails
 - [@semantic-release/npm](https://github.com/semantic-release/npm)
+  - **Note**: this is already part of semantic-release and does not have to be installed separately
   - `verifyConditions`: Verify the presence and the validity of the npm authentication and release configuration
   - `prepare`: Update the package.json version and create the npm package tarball
   - `publish`: Publish the package on the npm registry
@@ -41,6 +45,10 @@
 
 [Open a Pull Request](https://github.com/semantic-release/semantic-release/blob/master/CONTRIBUTING.md#submitting-a-pull-request) to add your plugin to the list.
 
+- [semantic-release-slack-bot](https://github.com/juliuscc/semantic-release-slack-bot)
+  - `verifyConditions`: Verify that the environment variable `SLACK_WEBHOOK` has been defined.
+  - `success`: Publish a message about the success to a slack channel.
+  - `fail`: Optionally publish a message about failure to a slack channel.
 - [semantic-release-docker](https://github.com/felixfbecker/semantic-release-docker)
   - `verifyConditions`: Verify that all needed configuration is present and login to the Docker registry.
   - `publish`: Tag the image specified by `name` with the new version, push it to Docker Hub and update the latest tag
@@ -72,4 +80,14 @@
   - `prepare`: Changes the version number in the `pom.xml` (or all `pom.xml` files in maven projects with multiple `pom.xml` files) and optionally creates a commit with this version number and pushes it to `master`
   - `publish`: Runs `mvn deploy` to deploy to maven central and optionally will update to next snapshot version and merge changes to development branch
 - [semantic-release-ado](https://github.com/lluchmk/semantic-release-ado)
-  - `prepare`: Stores the version number as an Azure DevOps pipeline variable availabe to downstream steps on the job
+  - `prepare`: Stores the version number as an Azure DevOps pipeline variable availabe to downstream steps on the job
+- [gradle-semantic-release](https://github.com/KengoTODA/gradle-semantic-release-plugin)
+  - `verifyConditions`: Verify that project has a Gradle wrapper script, and `build.gradle` contains a task to publish artifacts.
+  - `prepare`: Changes the version number in the `gradle.properties`
+  - `publish`: Triggers Gradle to publish artifacts.
+- [semantic-release-circleci-orb](https://github.com/matt-oakes/semantic-release-circleci-orb)
+  - `verifyConditions`: Verify the presence of the `CIRCLECI_API_TOKEN` environment variable, `orbName` option, and the `circleci` CLI.
+  - `publish`: Publish the CircleCI orb.
+- [semantic-release-github-pages](https://github.com/qiwi/semantic-release-gh-pages-plugin)
+  - `verifyConditions`: Verify the presence of the auth token set via environment variables.
+  - `publish`: Pushes commit to the documentation branch.

docs/usage/getting-started.md

@@ -1,6 +1,6 @@
 # Getting started
 
-In order to use **semantic-release** you must follows this steps:
+In order to use **semantic-release** you must follow these steps:
 - [Install](./installation.md#installation) **semantic-release** in your project
 - Configure your Continuous Integration service to [run **semantic-release**](./ci-configuration.md#run-semantic-release-only-after-all-tests-succeeded)
 - Configure your Git repository and package manager repository [authentication](ci-configuration.md#authentication) in your Continuous Integration service
@@ -19,4 +19,4 @@ semantic-release-cli setup
 
 See the [semantic-release-cli](https://github.com/semantic-release/cli#what-it-does) documentation for more details.
 
-**Note**: only a limited number of options, CI services and plugins is currently supported by `semantic-release-cli`.
+**Note**: only a limited number of options, CI services and plugins are currently supported by `semantic-release-cli`.

docs/usage/plugins.md

@@ -17,15 +17,26 @@ A plugin is a npm module that can implement one or more of the following steps:
 
 **Note:** If no plugin with a `analyzeCommits` step is defined `@semantic-release/commit-analyzer` will be used.
 
-See [available plugins](../extending/plugins-list.md).
+## Plugins installation
+
+These five plugins are already part of **semantic-release** and don't have to be installed separately:
+```
+"@semantic-release/commit-analyzer"	
+"@semantic-release/error"	
+"@semantic-release/github"	
+"@semantic-release/npm"	
+"@semantic-release/release-notes-generator"
+```
+
+[Additional plugins](../extending/plugins-list.md) have to be installed via npm:
+
+```bash
+$ npm install @semantic-release/git @semantic-release/changelog -D
+```
 
 ## Plugins configuration
 
-Each plugin must be installed and configured with the [`plugins` options](./configuration.md#plugins) by specifying the list of plugins by npm module name.
-
-```bash
-$ npm install @semantic-release/commit-analyzer @semantic-release/release-notes-generator @semantic-release/npm -D
-```
+Each plugin must be configured with the [`plugins` options](./configuration.md#plugins) by specifying the list of plugins by npm module name.
 
 ```json
 {
@@ -33,6 +44,8 @@ $ npm install @semantic-release/commit-analyzer @semantic-release/release-notes-
 }
 ```
 
+**Note:** If the `plugins` option is defined, it overrides the default plugin list, rather than merging with it.
+
 ## Plugin ordering
 
 For each [release step](../../README.md#release-steps) the plugins that implement that step will be executed in the order in which the are defined.

index.js

@@ -46,9 +46,7 @@ async function run(context, plugins) {
 
   if (ciBranch !== options.branch) {
     logger.log(
-      `This test run was triggered on the branch ${ciBranch}, while semantic-release is configured to only publish from ${
-        options.branch
-      }, therefore a new version won’t be published.`
+      `This test run was triggered on the branch ${ciBranch}, while semantic-release is configured to only publish from ${options.branch}, therefore a new version won’t be published.`
     );
     return false;
   }

lib/get-config.js

@@ -85,6 +85,6 @@ module.exports = async (context, opts) => {
 };
 
 async function pkgRepoUrl(opts) {
-  const {pkg} = await readPkgUp(opts);
+  const {package: pkg} = (await readPkgUp(opts)) || {};
   return pkg && (isPlainObject(pkg.repository) ? pkg.repository.url : pkg.repository);
 }

lib/get-git-auth-url.js

@@ -3,16 +3,6 @@ const {isNil} = require('lodash');
 const hostedGitInfo = require('hosted-git-info');
 const {verifyAuth} = require('./git');
 
-const GIT_TOKENS = {
-  GIT_CREDENTIALS: undefined,
-  GH_TOKEN: undefined,
-  GITHUB_TOKEN: undefined,
-  GL_TOKEN: 'gitlab-ci-token:',
-  GITLAB_TOKEN: 'gitlab-ci-token:',
-  BB_TOKEN: 'x-token-auth:',
-  BITBUCKET_TOKEN: 'x-token-auth:',
-};
-
 /**
  * Determine the the git repository URL to use to push, either:
  * - The `repositoryUrl` as is if allowed to push
@@ -25,6 +15,18 @@ const GIT_TOKENS = {
  * @return {String} The formatted Git repository URL.
  */
 module.exports = async ({cwd, env, options: {repositoryUrl, branch}}) => {
+  const GIT_TOKENS = {
+    GIT_CREDENTIALS: undefined,
+    GH_TOKEN: undefined,
+    // GitHub Actions require the "x-access-token:" prefix for git access
+    // https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#http-based-git-access-by-an-installation
+    GITHUB_TOKEN: isNil(env.GITHUB_ACTION) ? undefined : 'x-access-token:',
+    GL_TOKEN: 'gitlab-ci-token:',
+    GITLAB_TOKEN: 'gitlab-ci-token:',
+    BB_TOKEN: 'x-token-auth:',
+    BITBUCKET_TOKEN: 'x-token-auth:',
+  };
+
   const info = hostedGitInfo.fromUrl(repositoryUrl, {noGitPlus: true});
   const {protocol, ...parsed} = parse(repositoryUrl);
 

lib/git.js

@@ -11,7 +11,7 @@ const debug = require('debug')('semantic-release:git');
  */
 async function getTagHead(tagName, execaOpts) {
   try {
-    return await execa.stdout('git', ['rev-list', '-1', tagName], execaOpts);
+    return (await execa('git', ['rev-list', '-1', tagName], execaOpts)).stdout;
   } catch (error) {
     debug(error);
   }
@@ -26,7 +26,7 @@ async function getTagHead(tagName, execaOpts) {
  * @throws {Error} If the `git` command fails.
  */
 async function getTags(execaOpts) {
-  return (await execa.stdout('git', ['tag'], execaOpts))
+  return (await execa('git', ['tag'], execaOpts)).stdout
     .split('\n')
     .map(tag => tag.trim())
     .filter(Boolean);
@@ -75,8 +75,8 @@ async function fetch(repositoryUrl, execaOpts) {
  *
  * @return {String} the sha of the HEAD commit.
  */
-function getGitHead(execaOpts) {
-  return execa.stdout('git', ['rev-parse', 'HEAD'], execaOpts);
+async function getGitHead(execaOpts) {
+  return (await execa('git', ['rev-parse', 'HEAD'], execaOpts)).stdout;
 }
 
 /**
@@ -88,7 +88,7 @@ function getGitHead(execaOpts) {
  */
 async function repoUrl(execaOpts) {
   try {
-    return await execa.stdout('git', ['config', '--get', 'remote.origin.url'], execaOpts);
+    return (await execa('git', ['config', '--get', 'remote.origin.url'], execaOpts)).stdout;
   } catch (error) {
     debug(error);
   }
@@ -176,7 +176,7 @@ async function verifyTagName(tagName, execaOpts) {
  * @return {Boolean} `true` is the HEAD of the current local branch is the same as the HEAD of the remote branch, falsy otherwise.
  */
 async function isBranchUpToDate(branch, execaOpts) {
-  const remoteHead = await execa.stdout('git', ['ls-remote', '--heads', 'origin', branch], execaOpts);
+  const {stdout: remoteHead} = await execa('git', ['ls-remote', '--heads', 'origin', branch], execaOpts);
   try {
     return await isRefInHistory(remoteHead.match(/^(\w+)?/)[1], execaOpts);
   } catch (error) {

package.json

@@ -3,6 +3,14 @@
   "description": "Automated semver compliant package publishing",
   "version": "0.0.0-development",
   "author": "Stephan Bönnemann <stephan@boennemann.me> (http://boennemann.me)",
+  "ava": {
+    "files": [
+      "test/**/*.test.js"
+    ],
+    "helpers": [
+      "test/helpers/**/*"
+    ]
+  },
   "bin": {
     "semantic-release": "bin/semantic-release.js"
   },
@@ -27,9 +35,9 @@
     "aggregate-error": "^3.0.0",
     "cosmiconfig": "^5.0.1",
     "debug": "^4.0.0",
-    "env-ci": "^3.0.0",
+    "env-ci": "^4.0.0",
     "execa": "^1.0.0",
-    "figures": "^2.0.0",
+    "figures": "^3.0.0",
     "find-versions": "^3.0.0",
     "get-stream": "^5.0.0",
     "git-log-parser": "^1.2.0",
@@ -40,14 +48,14 @@
     "marked-terminal": "^3.2.0",
     "p-locate": "^4.0.0",
     "p-reduce": "^2.0.0",
-    "read-pkg-up": "^5.0.0",
+    "read-pkg-up": "^6.0.0",
     "resolve-from": "^5.0.0",
     "semver": "^6.0.0",
     "signale": "^1.2.1",
     "yargs": "^13.1.0"
   },
   "devDependencies": {
-    "ava": "^1.3.1",
+    "ava": "^2.0.0",
     "clear-module": "^3.0.0",
     "codecov": "^3.0.0",
     "commitizen": "^3.0.0",
@@ -55,17 +63,17 @@
     "delay": "^4.0.0",
     "dockerode": "^2.5.2",
     "file-url": "^3.0.0",
-    "fs-extra": "^7.0.0",
+    "fs-extra": "^8.0.0",
     "got": "^9.0.0",
     "js-yaml": "^3.10.0",
     "mockserver-client": "^5.1.1",
     "nock": "^10.0.0",
-    "nyc": "^13.1.0",
+    "nyc": "^14.0.0",
     "p-retry": "^4.0.0",
     "proxyquire": "^2.0.0",
     "sinon": "^7.2.7",
     "stream-buffers": "^3.0.2",
-    "tempy": "^0.2.1",
+    "tempy": "^0.3.0",
     "xo": "^0.24.0"
   },
   "engines": {

test/cli.test.js

@@ -66,7 +66,7 @@ test.serial('Pass options to semantic-release API', async t => {
   ];
   const cli = requireNoCache('../cli', {'.': run, process: {...process, argv}});
 
-  const exitCode = await cli();
+  const code = await cli();
 
   t.is(run.args[0][0].branch, 'master');
   t.is(run.args[0][0].repositoryUrl, 'https://github/com/owner/repo.git');
@@ -84,7 +84,7 @@ test.serial('Pass options to semantic-release API', async t => {
   t.is(run.args[0][0].debug, true);
   t.is(run.args[0][0].dryRun, true);
 
-  t.is(exitCode, 0);
+  t.is(code, 0);
 });
 
 test.serial('Pass options to semantic-release API with alias arguments', async t => {
@@ -108,7 +108,7 @@ test.serial('Pass options to semantic-release API with alias arguments', async t
   ];
   const cli = requireNoCache('../cli', {'.': run, process: {...process, argv}});
 
-  const exitCode = await cli();
+  const code = await cli();
 
   t.is(run.args[0][0].branch, 'master');
   t.is(run.args[0][0].repositoryUrl, 'https://github/com/owner/repo.git');
@@ -117,7 +117,7 @@ test.serial('Pass options to semantic-release API with alias arguments', async t
   t.deepEqual(run.args[0][0].extends, ['config1', 'config2']);
   t.is(run.args[0][0].dryRun, true);
 
-  t.is(exitCode, 0);
+  t.is(code, 0);
 });
 
 test.serial('Pass unknown options to semantic-release API', async t => {
@@ -125,13 +125,13 @@ test.serial('Pass unknown options to semantic-release API', async t => {
   const argv = ['', '', '--bool', '--first-option', 'value1', '--second-option', 'value2', '--second-option', 'value3'];
   const cli = requireNoCache('../cli', {'.': run, process: {...process, argv}});
 
-  const exitCode = await cli();
+  const code = await cli();
 
   t.is(run.args[0][0].bool, true);
   t.is(run.args[0][0].firstOption, 'value1');
   t.deepEqual(run.args[0][0].secondOption, ['value2', 'value3']);
 
-  t.is(exitCode, 0);
+  t.is(code, 0);
 });
 
 test.serial('Pass empty Array to semantic-release API for list option set to "false"', async t => {
@@ -139,11 +139,11 @@ test.serial('Pass empty Array to semantic-release API for list option set to "fa
   const argv = ['', '', '--publish', 'false'];
   const cli = requireNoCache('../cli', {'.': run, process: {...process, argv}});
 
-  const exitCode = await cli();
+  const code = await cli();
 
   t.deepEqual(run.args[0][0].publish, []);
 
-  t.is(exitCode, 0);
+  t.is(code, 0);
 });
 
 test.serial('Do not set properties in option for which arg is not in command line', async t => {
@@ -168,10 +168,10 @@ test.serial('Display help', async t => {
   const argv = ['', '', '--help'];
   const cli = requireNoCache('../cli', {'.': run, process: {...process, argv}});
 
-  const exitCode = await cli();
+  const code = await cli();
 
   t.regex(t.context.logs, /Run automated package publishing/);
-  t.is(exitCode, 0);
+  t.is(code, 0);
 });
 
 test.serial('Return error code and prints help if called with a command', async t => {
@@ -179,11 +179,11 @@ test.serial('Return error code and prints help if called with a command', async
   const argv = ['', '', 'pre'];
   const cli = requireNoCache('../cli', {'.': run, process: {...process, argv}});
 
-  const exitCode = await cli();
+  const code = await cli();
 
   t.regex(t.context.errors, /Run automated package publishing/);
   t.regex(t.context.errors, /Too many non-option arguments/);
-  t.is(exitCode, 1);
+  t.is(code, 1);
 });
 
 test.serial('Return error code if multiple plugin are set for single plugin', async t => {
@@ -191,11 +191,11 @@ test.serial('Return error code if multiple plugin are set for single plugin', as
   const argv = ['', '', '--analyze-commits', 'analyze1', 'analyze2'];
   const cli = requireNoCache('../cli', {'.': run, process: {...process, argv}});
 
-  const exitCode = await cli();
+  const code = await cli();
 
   t.regex(t.context.errors, /Run automated package publishing/);
   t.regex(t.context.errors, /Too many non-option arguments/);
-  t.is(exitCode, 1);
+  t.is(code, 1);
 });
 
 test.serial('Return error code if semantic-release throw error', async t => {
@@ -203,10 +203,10 @@ test.serial('Return error code if semantic-release throw error', async t => {
   const argv = ['', ''];
   const cli = requireNoCache('../cli', {'.': run, process: {...process, argv}});
 
-  const exitCode = await cli();
+  const code = await cli();
 
   t.regex(t.context.errors, /semantic-release error/);
-  t.is(exitCode, 1);
+  t.is(code, 1);
 });
 
 test.serial('Hide sensitive environment variable values from the logs', async t => {
@@ -215,8 +215,8 @@ test.serial('Hide sensitive environment variable values from the logs', async t
   const argv = ['', ''];
   const cli = requireNoCache('../cli', {'.': run, process: {...process, argv, env: {...process.env, ...env}}});
 
-  const exitCode = await cli();
+  const code = await cli();
 
   t.regex(t.context.errors, new RegExp(`Throw error: Exposing token ${escapeRegExp(SECRET_REPLACEMENT)}`));
-  t.is(exitCode, 1);
+  t.is(code, 1);
 });

test/get-config.test.js

@@ -482,6 +482,6 @@ test('Throw an Error if one of the shareable config cannot be found', async t =>
 
   const error = await t.throwsAsync(t.context.getConfig({cwd}), Error);
 
-  t.is(error.message, "Cannot find module 'non-existing-path'");
+  t.regex(error.message, /Cannot find module 'non-existing-path'/);
   t.is(error.code, 'MODULE_NOT_FOUND');
 });

test/get-git-auth-url.test.js

@@ -244,6 +244,19 @@ test('Return the "https" formatted URL if "gitCredentials" is defined with "BITB
   );
 });
 
+test('Return the "https" formatted URL if "GITHUB_ACTION" is set', async t => {
+  const {cwd} = await gitRepo();
+
+  t.is(
+    await getAuthUrl({
+      cwd,
+      env: {...env, GITHUB_ACTION: 'foo', GITHUB_TOKEN: 'token'},
+      options: {branch: 'master', repositoryUrl: 'git@host.null:owner/repo.git'},
+    }),
+    'https://x-access-token:token@host.null/owner/repo.git'
+  );
+});
+
 test('Handle "https" URL with group and subgroup, with "GIT_CREDENTIALS"', async t => {
   const {cwd} = await gitRepo();
 

test/helpers/git-utils.js

@@ -69,8 +69,10 @@ export async function initBareRepo(repositoryUrl, branch = 'master') {
  * @returns {Array<Commit>} The created commits, in reverse order (to match `git log` order).
  */
 export async function gitCommits(messages, execaOpts) {
-  await pReduce(messages, (_, message) =>
-    execa.stdout('git', ['commit', '-m', message, '--allow-empty', '--no-gpg-sign'], execaOpts)
+  await pReduce(
+    messages,
+    async (_, message) =>
+      (await execa('git', ['commit', '-m', message, '--allow-empty', '--no-gpg-sign'], execaOpts)).stdout
   );
   return (await gitGetCommits(undefined, execaOpts)).slice(0, messages.length);
 }
@@ -112,8 +114,8 @@ export async function gitCheckout(branch, create = true, execaOpts) {
  *
  * @return {String} The sha of the head commit in the current git repository.
  */
-export function gitHead(execaOpts) {
-  return execa.stdout('git', ['rev-parse', 'HEAD'], execaOpts);
+export async function gitHead(execaOpts) {
+  return (await execa('git', ['rev-parse', 'HEAD'], execaOpts)).stdout;
 }
 
 /**
@@ -181,8 +183,8 @@ export async function gitAddConfig(name, value, execaOpts) {
  *
  * @return {String} The sha of the commit associated with `tagName` on the local repository.
  */
-export function gitTagHead(tagName, execaOpts) {
-  return execa.stdout('git', ['rev-list', '-1', tagName], execaOpts);
+export async function gitTagHead(tagName, execaOpts) {
+  return (await execa('git', ['rev-list', '-1', tagName], execaOpts)).stdout;
 }
 
 /**
@@ -195,7 +197,7 @@ export function gitTagHead(tagName, execaOpts) {
  * @return {String} The sha of the commit associated with `tagName` on the remote repository.
  */
 export async function gitRemoteTagHead(repositoryUrl, tagName, execaOpts) {
-  return (await execa.stdout('git', ['ls-remote', '--tags', repositoryUrl, tagName], execaOpts))
+  return (await execa('git', ['ls-remote', '--tags', repositoryUrl, tagName], execaOpts)).stdout
     .split('\n')
     .filter(tag => Boolean(tag))
     .map(tag => tag.match(/^(\S+)/)[1])[0];
@@ -209,8 +211,8 @@ export async function gitRemoteTagHead(repositoryUrl, tagName, execaOpts) {
  *
  * @return {String} The tag associatedwith the sha in parameter or `null`.
  */
-export function gitCommitTag(gitHead, execaOpts) {
-  return execa.stdout('git', ['describe', '--tags', '--exact-match', gitHead], execaOpts);
+export async function gitCommitTag(gitHead, execaOpts) {
+  return (await execa('git', ['describe', '--tags', '--exact-match', gitHead], execaOpts)).stdout;
 }
 
 /**

test/plugins/normalize.test.js

@@ -255,6 +255,6 @@ test('Throws an error if the plugin is not found', t => {
     Error
   );
 
-  t.is(error.message, "Cannot find module 'non-existing-path'");
+  t.regex(error.message, /Cannot find module 'non-existing-path'/);
   t.is(error.code, 'MODULE_NOT_FOUND');
 });