chore(package): update xo to version 0.24.0

bin/semantic-release.js

@@ -3,7 +3,7 @@
 // Bad news: We have to write plain ES5 in this file
 // Good news: It's the only file of the entire project
 
-/* eslint-disable no-var, promise/prefer-await-to-then, prefer-destructuring */
+/* eslint-disable no-var */
 
 var semver = require('semver');
 var execa = require('execa');

cli.js

@@ -1,4 +1,4 @@
-const {argv, env, stderr} = require('process');
+const {argv, env, stderr} = require('process'); // eslint-disable-line node/prefer-global/process
 const util = require('util');
 const hideSensitive = require('./lib/hide-sensitive');
 
@@ -51,12 +51,14 @@ Usage:
       // Debug must be enabled before other requires in order to work
       require('debug').enable('semantic-release:*');
     }
+
     await require('.')(opts);
     return 0;
   } catch (error) {
     if (error.name !== 'YError') {
       stderr.write(hideSensitive(env)(util.inspect(error, {colors: true})));
     }
+
     return 1;
   }
 };

docs/extending/plugins-list.md

@@ -71,3 +71,5 @@
   - `verifyRelease`: Checks and warns (does not error by default) if the version numbers found on maven central and within the Git project differ by quite a bit
   - `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

docs/recipes/git-auth-ssh-keys.md

@@ -158,6 +158,6 @@ Commit the encrypted private key and the `.circleci/config.yml` file to your rep
 
 ```bash
 $ git add git_deploy_key.enc .circleci/config.yml
-$ git commit -m "ci(cicle): Add the encrypted private ssh key"
+$ git commit -m "ci(circle): Add the encrypted private ssh key"
 $ git push
 ```

docs/support/FAQ.md

@@ -145,7 +145,7 @@ If you have introduced a breaking bug in a release you have 2 options:
 
 In both cases **semantic-release** will publish a new release, so your package users' will get the fixed/reverted version.
 
-Depending on the package manager you are using, you might be able to un-publish or deprecate a release, in order to prevent users to download it by accident. For example npm allows you to [un-publish](https://docs.npmjs.com/cli/unpublish) in [next 72 hours](https://www.npmjs.com/policies/unpublish) after releasing or to [deprecate](https://docs.npmjs.com/cli/deprecate) a release.
+Depending on the package manager you are using, you might be able to un-publish or deprecate a release, in order to prevent users from downloading it by accident. For example npm allows you to [un-publish](https://docs.npmjs.com/cli/unpublish) [within 72 hours](https://www.npmjs.com/policies/unpublish) after releasing. You may also [deprecate](https://docs.npmjs.com/cli/deprecate) a release if you would rather avoid un-publishing.
 
 In any case **do not remove the Git tag associated with the buggy version**, otherwise **semantic-release** will later try to republish that version. Publishing a version after un-publishing is not supported by most package managers.
 

docs/support/troubleshooting.md

@@ -12,7 +12,7 @@ npm ERR! You do not have permission to publish "<package-name>". Are you logged
 
 This is most likely related to a misconfiguration of the [npm registry authentication](https://github.com/semantic-release/npm#npm-registry-authentication) or to your user [missing permission](https://docs.npmjs.com/cli/team) for publishing.
 
-It might also happen if the package name you are trying to publish already exists (in such case npm consider you are trying to publish a new version of a package that is not yours, hence the permission error).
+It might also happen if the package name you are trying to publish already exists (in the case of npm, you may be trying to publish a new version of a package that is not yours, hence the permission error).
 
 To verify if your package name is available you can use [npm-name-cli](https://github.com/sindresorhus/npm-name-cli):
 ```bash

docs/usage/ci-configuration.md

@@ -26,7 +26,7 @@ Most **semantic-release** [plugins](plugins.md) require setting up authenticatio
 | `NPM_TOKEN` | npm token created via [npm token create](https://docs.npmjs.com/getting-started/working_with_tokens#how-to-create-new-tokens).<br/>**Note**: Only the `auth-only` [level of npm two-factor authentication](https://docs.npmjs.com/getting-started/using-two-factor-authentication#levels-of-authentication) is supported. |
 | `GH_TOKEN`  | GitHub authentication token.<br/>**Note**: Only the [personal token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line) authentication is supported.                                                                                                                                 |
 
-See each plugin documentation for the environment variables to set up.
+See each plugin's documentation for the environment variables required.
 
 The authentication token/credentials have to be made available in the CI service via environment variables.
 

docs/usage/shareable-configurations.md

@@ -1,6 +1,6 @@
 # Shareable configurations
 
-A sharable configuration is an [npm](https://www.npmjs.com/) package that exports a **semantic-release** configuration object. It allows for use of the same configuration across several projects.
+A shareable configuration is an [npm](https://www.npmjs.com/) package that exports a **semantic-release** configuration object. It allows for use of the same configuration across several projects.
 
 The shareable configurations to use can be set with the [extends](configuration.md#extends) option.
 

index.js

@@ -64,6 +64,7 @@ async function run(context, plugins) {
     );
     return false;
   }
+
   logger[options.dryRun ? 'warn' : 'success'](
     `Run automated release from branch ${ciBranch}${options.dryRun ? ' in dry-run mode' : ''}`
   );
@@ -82,6 +83,7 @@ async function run(context, plugins) {
         );
         return false;
       }
+
       throw error;
     }
   } catch (error) {

lib/branches/normalize.js

@@ -60,6 +60,7 @@ function release({release}) {
   if (release.length === 0) {
     return release;
   }
+
   const breakpoints = release.length > 2 ? ['minor', 'major'] : ['major'];
 
   // The intial bound is the last release from the base branch of `FIRST_RELEASE` (1.0.0)
@@ -80,6 +81,7 @@ function release({release}) {
       // The upper bound is the lowest version between `nextFirstVersion` and the default upper bound
       bound = lowest(nextFirstVersion, upperBound);
     }
+
     const diff = bound ? semverDiff(min, bound) : null;
     return {
       ...rest,

lib/definitions/errors.js

@@ -1,10 +1,9 @@
-const url = require('url');
 const {inspect} = require('util');
 const {toLower, isString, trim} = require('lodash');
 const pkg = require('../../package.json');
 const {RELEASE_TYPE} = require('./constants');
 
-const homepage = url.format({...url.parse(pkg.homepage), hash: null});
+const [homepage] = pkg.homepage.split('#');
 const stringify = obj => (isString(obj) ? obj : inspect(obj, {breakLength: Infinity, depth: 2, maxArrayLength: 5}));
 const linkify = file => `${homepage}/blob/master/${file}`;
 const wordsList = words =>
@@ -211,8 +210,8 @@ The following commit${commits.length > 1 ? 's are' : ' is'} responsible for the
 ${commits.map(({commit: {short}, subject}) => `- ${subject} (${short})`).join('\n')}
 
 ${
-      commits.length > 1 ? 'Those commits' : 'This commit'
-    } should be moved to a valid branch with [git merge](https://git-scm.com/docs/git-merge) or [git cherry-pick](https://git-scm.com/docs/git-cherry-pick) and removed from branch \`${name}\` with [git revert](https://git-scm.com/docs/git-revert) or [git reset](https://git-scm.com/docs/git-reset).
+  commits.length > 1 ? 'Those commits' : 'This commit'
+} should be moved to a valid branch with [git merge](https://git-scm.com/docs/git-merge) or [git cherry-pick](https://git-scm.com/docs/git-cherry-pick) and removed from branch \`${name}\` with [git revert](https://git-scm.com/docs/git-revert) or [git reset](https://git-scm.com/docs/git-reset).
 
 A valid branch could be ${wordsList(validBranches.map(({name}) => `\`${name}\``))}.
 

lib/definitions/plugins.js

@@ -59,6 +59,7 @@ module.exports = {
           // Regenerate the release notes
           context.nextRelease.notes = await generateNotes(context);
         }
+
         // Call the next prepare plugin with the updated `nextRelease`
         return context;
       },

lib/get-config.js

@@ -30,6 +30,7 @@ module.exports = async (context, opts) => {
   if (options.ci === false) {
     options.noCi = true;
   }
+
   const pluginsPath = {};
   let extendPaths;
   ({extends: extendPaths, ...options} = options);

lib/get-git-auth-url.js

@@ -1,4 +1,4 @@
-const {parse, format} = require('url');
+const {parse, format} = require('url'); // eslint-disable-line node/no-deprecated-api
 const {isNil} = require('lodash');
 const hostedGitInfo = require('hosted-git-info');
 const {verifyAuth} = require('./git');
@@ -44,7 +44,7 @@ module.exports = async ({cwd, env, branch, options: {repositoryUrl}}) => {
     const gitCredentials = `${GIT_TOKENS[envVar] || ''}${env[envVar] || ''}`;
 
     if (gitCredentials) {
-      // If credentials are set via anvironment variables, convert the URL to http/https and add basic auth, otherwise return `repositoryUrl` as is
+      // If credentials are set via environment variables, convert the URL to http/https and add basic auth, otherwise return `repositoryUrl` as is
       const [match, auth, host, path] = /^(?!.+:\/\/)(?:(.*)@)?(.*?):(.*)$/.exec(repositoryUrl) || [];
       return format({
         ...parse(match ? `ssh://${auth ? `${auth}@` : ''}${host}/${path}` : repositoryUrl),

lib/get-last-release.js

@@ -23,9 +23,9 @@ const {makeTag} = require('./utils');
  *
  * @return {LastRelease} The last tagged release or empty object if none is found.
  */
-module.exports = ({branch: {tags, type}, options: {tagFormat}}, {before} = {}) => {
-  const [{version, gitTag, gitHead, channel} = {}] = tags
-    .filter(tag => type === 'prerelease' || !semver.prerelease(tag.version))
+module.exports = ({branch, options: {tagFormat}}, {before} = {}) => {
+  const [{version, gitTag, gitHead, channel} = {}] = branch.tags
+    .filter(tag => (branch.type === 'prerelease' && branch.channel === tag.channel) || !semver.prerelease(tag.version))
     .filter(tag => isUndefined(before) || semver.lt(tag.version, before))
     .sort((a, b) => semver.rcompare(a.version, b.version));
 

lib/git.js

@@ -99,6 +99,7 @@ async function isRefInHistory(ref, branch, findRebasedTags, execaOpts) {
         );
         return (await getBranchCommits(branch, execaOpts)).some(matches(pick(tagCommit, ['message', 'author'])));
       }
+
       return false;
     }
 

lib/plugins/index.js

@@ -57,10 +57,12 @@ module.exports = (context, pluginsPath) => {
             plugin ? [plugin[0], Object.assign(plugin[1], options[type])] : plugin
           );
         }
+
         if (!validateStep({required}, options[type])) {
           errors.push(getError('EPLUGINCONF', {type, required, pluginConf: options[type]}));
           return pluginsConf;
         }
+
         pluginOpts = options[type];
       }
 

lib/plugins/normalize.js

@@ -40,9 +40,11 @@ module.exports = (context, type, pluginOpt, pluginsPath) => {
         if (outputValidator && !outputValidator(result)) {
           throw getError(`E${type.toUpperCase()}OUTPUT`, {result, pluginName});
         }
+
         logger.success(`Completed step "${type}" of plugin "${pluginName}"`);
         return result;
       }
+
       logger.warn(`Skip step "${type}" of plugin "${pluginName}" in dry-run mode`);
     } catch (error) {
       logger.error(`Failed step "${type}" of plugin "${pluginName}"`);

lib/plugins/pipeline.js

@@ -4,7 +4,7 @@ const AggregateError = require('aggregate-error');
 const {extractErrors} = require('../utils');
 
 /**
- * A Function that execute a list of function sequencially. If at least one Function ins the pipeline throw an Error or rejects, the pipeline function rejects as well.
+ * A Function that execute a list of function sequencially. If at least one Function ins the pipeline throws an Error or rejects, the pipeline function rejects as well.
  *
  * @typedef {Function} Pipeline
  * @param {Any} input Argument to pass to the first step in the pipeline.
@@ -44,6 +44,7 @@ module.exports = (steps, {settleAll = false, getNextInput = identity, transform
           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
       return getNextInput(lastInput, result);
     },
@@ -52,5 +53,6 @@ module.exports = (steps, {settleAll = false, getNextInput = identity, transform
   if (errors.length > 0) {
     throw new AggregateError(errors);
   }
+
   return results;
 };

lib/plugins/utils.js

@@ -12,6 +12,7 @@ const validateSteps = conf => {
     ) {
       return true;
     }
+
     conf = castArray(conf);
 
     if (conf.length !== 1) {
@@ -39,6 +40,7 @@ function validateStep({required}, conf) {
   if (required) {
     return conf.length >= 1 && validateSteps(conf);
   }
+
   return conf.length === 0 || validateSteps(conf);
 }
 
@@ -59,6 +61,7 @@ function parseConfig(plugin) {
   } else {
     path = plugin;
   }
+
   return [path, config || {}];
 }
 

lib/utils.js

@@ -59,6 +59,7 @@ function getFirstVersion(versions, lowerBranches) {
   if (lowerVersion[0]) {
     return versions.sort(semver.compare).find(version => semver.gt(version, lowerVersion[0]));
   }
+
   return getEarliestVersion(versions);
 }
 

package.json

@@ -36,8 +36,8 @@
     "hook-std": "^1.1.0",
     "hosted-git-info": "^2.7.1",
     "lodash": "^4.17.4",
-    "marked": "^0.5.0",
-    "marked-terminal": "^3.0.0",
+    "marked": "^0.6.0",
+    "marked-terminal": "^3.2.0",
     "micromatch": "3.1.5",
     "p-each-series": "^1.0.0",
     "p-reduce": "^1.0.0",
@@ -68,7 +68,7 @@
     "sinon": "^7.1.1",
     "stream-buffers": "^3.0.2",
     "tempy": "^0.2.1",
-    "xo": "^0.23.0"
+    "xo": "^0.24.0"
   },
   "engines": {
     "node": ">=8.3"

test/get-last-release.test.js

@@ -18,6 +18,31 @@ test('Get the highest non-prerelease valid tag', t => {
   t.deepEqual(result, {version: '2.0.0', gitTag: 'v2.0.0', name: 'v2.0.0', gitHead: '222', channel: undefined});
 });
 
+test('Get the highest prerelease valid tag, ignoring other tags from other prerelease channels', t => {
+  const result = getLastRelease({
+    branch: {
+      name: 'beta',
+      prerelease: 'beta',
+      channel: 'beta',
+      tags: [
+        {version: '1.0.0-beta.1', gitTag: 'v1.0.0-beta.1@beta', gitHead: '111', channel: 'beta'},
+        {version: '1.0.0-beta.2', gitTag: 'v1.0.0-beta.2@beta', gitHead: '222', channel: 'beta'},
+        {version: '1.0.0-alpha.1', gitTag: 'v1.0.0-alpha.1@alpha', gitHead: '333', channel: 'alpha'},
+      ],
+      type: 'prerelease',
+    },
+    options: {tagFormat: `v\${version}`},
+  });
+
+  t.deepEqual(result, {
+    version: '1.0.0-beta.2',
+    gitTag: 'v1.0.0-beta.2@beta',
+    name: 'v1.0.0-beta.2',
+    gitHead: '222',
+    channel: 'beta',
+  });
+});
+
 test('Return empty object if no valid tag is found', t => {
   const result = getLastRelease({
     branch: {