fix: pass custom env and cwd to env-ci

[Fixes #924]

bin/semantic-release.js

@@ -30,9 +30,9 @@ execa
       process.exit(1);
     }
   })
-  .catch(err => {
+  .catch(error => {
     console.error(`[semantic-release]: Git version ${MIN_GIT_VERSION} is required. No git binary found.`);
-    console.error(err);
+    console.error(error);
     process.exit(1);
   });
 

cli.js

@@ -27,7 +27,7 @@ Usage:
     .option('verify-conditions', {...stringList, group: 'Plugins'})
     .option('analyze-commits', {type: 'string', group: 'Plugins'})
     .option('verify-release', {...stringList, group: 'Plugins'})
-    .option('generate-notes', {type: 'string', group: 'Plugins'})
+    .option('generate-notes', {...stringList, group: 'Plugins'})
     .option('prepare', {...stringList, group: 'Plugins'})
     .option('publish', {...stringList, group: 'Plugins'})
     .option('success', {...stringList, group: 'Plugins'})
@@ -57,9 +57,9 @@ Usage:
     }
     await require('.')(opts);
     return 0;
-  } catch (err) {
-    if (err.name !== 'YError') {
-      stderr.write(hideSensitive(env)(util.inspect(err, {colors: true})));
+  } catch (error) {
+    if (error.name !== 'YError') {
+      stderr.write(hideSensitive(env)(util.inspect(error, {colors: true})));
     }
     return 1;
   }

docs/support/FAQ.md

@@ -98,7 +98,7 @@ See the [CI configuration recipes](../recipes/README.md#ci-configurations) for m
 
 ## Can I run semantic-release on my local machine rather than on a CI server?
 
-Yes, you can by explicitly setting the [`--no-ci` CLI option](../usage/configuration.md#options) option. You will also have to set the required [authentication](../usage/ci-configuration.md#authentication) via environment variables on your local machine, for example:
+Yes, you can by explicitly setting the [`--no-ci` CLI option](../usage/configuration.md#ci) option. You will also have to set the required [authentication](../usage/ci-configuration.md#authentication) via environment variables on your local machine, for example:
 
 ```bash
 $ NPM_TOKEN=<your_npm_token> GH_TOKEN=<your_github_token> npx semantic-release --no-ci

docs/usage/ci-configuration.md

@@ -10,14 +10,12 @@ See [CI configuration recipes](../recipes/README.md#ci-configurations) for more
 
 **semantic-release** requires push access to the project Git repository in order to create [Git tags](https://git-scm.com/book/en/v2/Git-Basics-Tagging). The Git authentication can be set with one of the following environment variables:
 
-| Variable                        | Description                                                                                                                   |
-|---------------------------------|-------------------------------------------------------------------------------------------------------------------------------|
-| `GH_TOKEN` or `GITHUB_TOKEN`    | A GitHub [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line).     |
-| `GL_TOKEN` or `GITLAB_TOKEN`    | A GitLab [personal access token](https://docs.gitlab.com/ce/user/profile/personal_access_tokens.html).                        |
-| `BB_TOKEN` or `BITBUCKET_TOKEN` | A Bitbucket [personal access token](https://confluence.atlassian.com/bitbucketserver/personal-access-tokens-939515499.html).  |
-| `GIT_CREDENTIALS`               | [URL encoded basic HTTP Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication#URL_encoding) credentials). |
-
-`GIT_CREDENTIALS` must be the Git username and password in the format `<username>:<password>`.
+| Variable                        | Description                                                                                                                                                                                                                  |
+|---------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `GH_TOKEN` or `GITHUB_TOKEN`    | A GitHub [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line).                                                                                                    |
+| `GL_TOKEN` or `GITLAB_TOKEN`    | A GitLab [personal access token](https://docs.gitlab.com/ce/user/profile/personal_access_tokens.html).                                                                                                                       |
+| `BB_TOKEN` or `BITBUCKET_TOKEN` | A Bitbucket [personal access token](https://confluence.atlassian.com/bitbucketserver/personal-access-tokens-939515499.html).                                                                                                 |
+| `GIT_CREDENTIALS`               | [URL encoded](https://en.wikipedia.org/wiki/Percent-encoding) Git username and password in the format `<username>:<password>`. The username and password must each be individually URL encoded, not the `:` separating them. |
 
 Alternatively the Git authentication can be set up via [SSH keys](../recipes/git-auth-ssh-keys.md).
 

docs/usage/configuration.md

@@ -100,13 +100,15 @@ CLI arguments: `-d`, `--dry-run`
 
 Dry-run mode, skip publishing, print next version and release notes.
 
-### noCi
+### ci
 
 Type: `Boolean`<br>
-Default: `false`<br>
-CLI arguments: `--no-ci`
+Default: `true`<br>
+CLI arguments: `--ci` / `--no-ci`
 
-Skip Continuous Integration environment verifications. This allows for making releases from a local machine.
+Set to `fasle` to skip Continuous Integration environment verifications. This allows for making releases from a local machine.
+
+**Note**: The CLI arguments `--no-ci` is equivalent to `--ci false`.
 
 ### debug
 
@@ -128,7 +130,7 @@ See [Plugins configuration](plugins.md#configuration) for more details.
 
 ### analyzeCommits
 
-Type: `Array`, `String`, `Object`<br>
+Type: `String`, `Object`<br>
 Default: `'@semantic-release/commit-analyzer'`<br>
 CLI argument: `--analyze-commits`
 

index.js

@@ -20,8 +20,8 @@ const {COMMIT_NAME, COMMIT_EMAIL} = require('./lib/definitions/constants');
 marked.setOptions({renderer: new TerminalRenderer()});
 
 async function run(context, plugins) {
-  const {isCi, branch: ciBranch, isPr} = envCi();
   const {cwd, env, options, logger} = context;
+  const {isCi, branch: ciBranch, isPr} = envCi({env, cwd});
 
   if (!isCi && !options.dryRun && !options.noCi) {
     logger.log('This run was not triggered in a known CI environment, running in dry-run mode.');
@@ -60,14 +60,14 @@ async function run(context, plugins) {
 
   try {
     await verifyAuth(options.repositoryUrl, options.branch, {cwd, env});
-  } catch (err) {
+  } catch (error) {
     if (!(await isBranchUpToDate(options.branch, {cwd, env}))) {
       logger.log(
         `The local branch ${options.branch} is behind the remote one, therefore a new version won't be published.`
       );
       return false;
     }
-    logger.error(`The command "${err.cmd}" failed with the error message ${err.stderr}.`);
+    logger.error(`The command "${error.cmd}" failed with the error message ${error.stderr}.`);
     throw getError('EGITNOPERMISSION', {options});
   }
 
@@ -131,13 +131,13 @@ function logErrors({logger, stderr}, err) {
   }
 }
 
-async function callFail(context, plugins, error) {
-  const errors = extractErrors(error).filter(error => error.semanticRelease);
+async function callFail(context, plugins, err) {
+  const errors = extractErrors(err).filter(err => err.semanticRelease);
   if (errors.length > 0) {
     try {
       await plugins.fail({...context, errors});
-    } catch (err) {
-      logErrors(context, err);
+    } catch (error) {
+      logErrors(context, error);
     }
   }
 }
@@ -157,15 +157,15 @@ module.exports = async (opts = {}, {cwd = process.cwd(), env = process.env, stdo
       const result = await run(context, plugins);
       unhook();
       return result;
-    } catch (err) {
+    } catch (error) {
       if (!options.dryRun) {
-        await callFail(context, plugins, err);
+        await callFail(context, plugins, error);
       }
-      throw err;
+      throw error;
     }
-  } catch (err) {
-    logErrors(context, err);
+  } catch (error) {
+    logErrors(context, error);
     unhook();
-    throw err;
+    throw error;
   }
 };

lib/get-git-auth-url.js

@@ -43,7 +43,7 @@ module.exports = async ({cwd, env, options: {repositoryUrl, branch}}) => {
   // Test if push is allowed without transforming the URL (e.g. is ssh keys are set up)
   try {
     await verifyAuth(repositoryUrl, branch, {cwd, env});
-  } catch (err) {
+  } catch (error) {
     const envVar = Object.keys(GIT_TOKENS).find(envVar => !isUndefined(env[envVar]));
     const gitCredentials = `${GIT_TOKENS[envVar] || ''}${env[envVar] || ''}`;
     const {protocols, ...parsed} = gitUrlParse(repositoryUrl);

lib/git.js

@@ -12,8 +12,8 @@ const debug = require('debug')('semantic-release:git');
 async function gitTagHead(tagName, execaOpts) {
   try {
     return await execa.stdout('git', ['rev-list', '-1', tagName], execaOpts);
-  } catch (err) {
-    debug(err);
+  } catch (error) {
+    debug(error);
   }
 }
 
@@ -44,13 +44,13 @@ async function isRefInHistory(ref, execaOpts) {
   try {
     await execa('git', ['merge-base', '--is-ancestor', ref, 'HEAD'], execaOpts);
     return true;
-  } catch (err) {
-    if (err.code === 1) {
+  } catch (error) {
+    if (error.code === 1) {
       return false;
     }
 
-    debug(err);
-    throw err;
+    debug(error);
+    throw error;
   }
 }
 
@@ -63,7 +63,7 @@ async function isRefInHistory(ref, execaOpts) {
 async function fetch(repositoryUrl, execaOpts) {
   try {
     await execa('git', ['fetch', '--unshallow', '--tags', repositoryUrl], execaOpts);
-  } catch (err) {
+  } catch (error) {
     await execa('git', ['fetch', '--tags', repositoryUrl], execaOpts);
   }
 }
@@ -75,7 +75,7 @@ async function fetch(repositoryUrl, execaOpts) {
  *
  * @return {string} the sha of the HEAD commit.
  */
-async function gitHead(execaOpts) {
+function gitHead(execaOpts) {
   return execa.stdout('git', ['rev-parse', 'HEAD'], execaOpts);
 }
 
@@ -89,8 +89,8 @@ async function gitHead(execaOpts) {
 async function repoUrl(execaOpts) {
   try {
     return await execa.stdout('git', ['config', '--get', 'remote.origin.url'], execaOpts);
-  } catch (err) {
-    debug(err);
+  } catch (error) {
+    debug(error);
   }
 }
 
@@ -104,8 +104,8 @@ async function repoUrl(execaOpts) {
 async function isGitRepo(execaOpts) {
   try {
     return (await execa('git', ['rev-parse', '--git-dir'], execaOpts)).code === 0;
-  } catch (err) {
-    debug(err);
+  } catch (error) {
+    debug(error);
   }
 }
 
@@ -121,9 +121,9 @@ async function isGitRepo(execaOpts) {
 async function verifyAuth(repositoryUrl, branch, execaOpts) {
   try {
     await execa('git', ['push', '--dry-run', repositoryUrl, `HEAD:${branch}`], execaOpts);
-  } catch (err) {
-    debug(err);
-    throw err;
+  } catch (error) {
+    debug(error);
+    throw error;
   }
 }
 
@@ -163,8 +163,8 @@ async function push(repositoryUrl, branch, execaOpts) {
 async function verifyTagName(tagName, execaOpts) {
   try {
     return (await execa('git', ['check-ref-format', `refs/tags/${tagName}`], execaOpts)).code === 0;
-  } catch (err) {
-    debug(err);
+  } catch (error) {
+    debug(error);
   }
 }
 
@@ -182,8 +182,8 @@ async function isBranchUpToDate(branch, execaOpts) {
       (await execa.stdout('git', ['ls-remote', '--heads', 'origin', branch], execaOpts)).match(/^(\w+)?/)[1],
       execaOpts
     );
-  } catch (err) {
-    debug(err);
+  } catch (error) {
+    debug(error);
   }
 }
 

lib/plugins/normalize.js

@@ -42,10 +42,10 @@ module.exports = ({cwd, stdout, stderr, options, logger}, type, pluginOpt, plugi
       }
       logger.success(`Completed step "${type}" of plugin "${pluginName}"`);
       return result;
-    } catch (err) {
+    } catch (error) {
       logger.error(`Failed step "${type}" of plugin "${pluginName}"`);
-      extractErrors(err).forEach(err => Object.assign(err, {pluginName}));
-      throw err;
+      extractErrors(error).forEach(err => Object.assign(err, {pluginName}));
+      throw error;
     }
   };
 

lib/plugins/pipeline.js

@@ -36,12 +36,12 @@ module.exports = (steps, {settleAll = false, getNextInput = identity, transform
         // Call the step with the input computed at the end of the previous iteration and save intermediary result
         result = await transform(await step(lastInput), step, lastInput);
         results.push(result);
-      } catch (err) {
+      } catch (error) {
         if (settleAll) {
-          errors.push(...extractErrors(err));
-          result = err;
+          errors.push(...extractErrors(error));
+          result = error;
         } else {
-          throw err;
+          throw error;
         }
       }
       // Prepare input for the next step, passing the input of the last iteration (or initial parameter for the first iteration) and the result of the current one

package.json

@@ -27,7 +27,7 @@
     "aggregate-error": "^1.0.0",
     "cosmiconfig": "^5.0.1",
     "debug": "^3.1.0",
-    "env-ci": "^2.0.0",
+    "env-ci": "^2.4.0",
     "execa": "^1.0.0",
     "figures": "^2.0.0",
     "find-versions": "^2.0.0",
@@ -53,7 +53,7 @@
     "codecov": "^3.0.0",
     "commitizen": "^2.9.6",
     "cz-conventional-changelog": "^2.0.0",
-    "delay": "^3.0.0",
+    "delay": "^4.0.0",
     "dockerode": "^2.5.2",
     "file-url": "^2.0.2",
     "fs-extra": "^7.0.0",
@@ -67,7 +67,7 @@
     "sinon": "^6.0.0",
     "stream-buffers": "^3.0.2",
     "tempy": "^0.2.1",
-    "xo": "^0.22.0"
+    "xo": "^0.23.0"
   },
   "engines": {
     "node": ">=8.3"

test/cli.test.js

@@ -72,7 +72,7 @@ test.serial('Pass options to semantic-release API', async t => {
   t.deepEqual(run.args[0][0].verifyConditions, ['condition1', 'condition2']);
   t.is(run.args[0][0].analyzeCommits, 'analyze');
   t.deepEqual(run.args[0][0].verifyRelease, ['verify1', 'verify2']);
-  t.is(run.args[0][0].generateNotes, 'notes');
+  t.deepEqual(run.args[0][0].generateNotes, ['notes']);
   t.deepEqual(run.args[0][0].prepare, ['prepare1', 'prepare2']);
   t.deepEqual(run.args[0][0].publish, ['publish1', 'publish2']);
   t.deepEqual(run.args[0][0].success, ['success1', 'success2']);

test/helpers/git-utils.js

@@ -69,7 +69,7 @@ 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, async (_, message) =>
+  await pReduce(messages, (_, message) =>
     execa.stdout('git', ['commit', '-m', message, '--allow-empty', '--no-gpg-sign'], execaOpts)
   );
   return (await gitGetCommits(undefined, execaOpts)).slice(0, messages.length);
@@ -112,7 +112,7 @@ export async function gitCheckout(branch, create = true, execaOpts) {
  *
  * @return {String} The sha of the head commit in the current git repository.
  */
-export async function gitHead(execaOpts) {
+export function gitHead(execaOpts) {
   return execa.stdout('git', ['rev-parse', 'HEAD'], execaOpts);
 }
 
@@ -181,7 +181,7 @@ export async function gitAddConfig(name, value, execaOpts) {
  *
  * @return {String} The sha of the commit associated with `tagName` on the local repository.
  */
-export async function gitTagHead(tagName, execaOpts) {
+export function gitTagHead(tagName, execaOpts) {
   return execa.stdout('git', ['rev-list', '-1', tagName], execaOpts);
 }
 
@@ -209,7 +209,7 @@ export async function gitRemoteTagHead(repositoryUrl, tagName, execaOpts) {
  *
  * @return {String} The tag associatedwith the sha in parameter or `null`.
  */
-export async function gitCommitTag(gitHead, execaOpts) {
+export function gitCommitTag(gitHead, execaOpts) {
   return execa.stdout('git', ['describe', '--tags', '--exact-match', gitHead], execaOpts);
 }
 

test/helpers/mockserver.js

@@ -30,7 +30,7 @@ async function start() {
       minTimeout: 1000,
       factor: 2,
     });
-  } catch (err) {
+  } catch (error) {
     throw new Error(`Couldn't start mock-server after 2 min`);
   }
 }
@@ -96,7 +96,7 @@ async function mock(
  * @param {Object} expectation The expectation created with `mock` function.
  * @return {Promise} A Promise that resolves if the expectation is met or reject otherwise.
  */
-async function verify(expectation) {
+function verify(expectation) {
   return client.verify(expectation);
 }
 

test/helpers/npm-registry.js

@@ -39,7 +39,7 @@ async function start() {
       minTimeout: 1000,
       factor: 2,
     });
-  } catch (err) {
+  } catch (error) {
     throw new Error(`Couldn't start npm-registry-docker after 2 min`);
   }