feat: allow to disable the publish plugin hook

`verifyConditions` explanation was wrong previously.

bin/semantic-release.js

@@ -3,11 +3,15 @@
 // 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 */
+/* eslint-disable no-var, promise/prefer-await-to-then, prefer-destructuring */
 
 var semver = require('semver');
+var execa = require('execa');
+var findVersions = require('find-versions');
 var pkg = require('../package.json');
 
+var MIN_GIT_VERSION = '2.0.0';
+
 if (!semver.satisfies(process.version, pkg.engines.node)) {
   console.error(
     `[semantic-release]: node version ${pkg.engines.node} is required. Found ${process.version}.
@@ -17,6 +21,21 @@ See https://github.com/semantic-release/semantic-release/blob/caribou/docs/suppo
   process.exit(1);
 }
 
+execa
+  .stdout('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}.`);
+      process.exit(1);
+    }
+  })
+  .catch(err => {
+    console.error(`[semantic-release]: Git version ${MIN_GIT_VERSION} is required. No git binary found.`);
+    console.error(err);
+    process.exit(1);
+  });
+
 // Node 8+ from this point on
 require('../cli')().catch(() => {
   process.exitCode = 1;

docs/extending/plugins-list.md

@@ -37,9 +37,13 @@
 
 [Open a Pull Request](https://github.com/semantic-release/semantic-release/blob/caribou/CONTRIBUTING.md#submitting-a-pull-request) to add your plugin to the list.
 
-- [semantic-release-docker](https://github.com/felixfbecker/semantic-release-docker) Set of semantic-release plugins for publishing a docker image to Docker Hub (tested on semantic-release **^11.0.0**)
+- [semantic-release-docker](https://github.com/felixfbecker/semantic-release-docker) Set of semantic-release plugins for publishing a docker image to Docker Hub
   - [verifyConditions](https://github.com/felixfbecker/semantic-release-docker#verifyconditions) Verify that all needed configuration is present and login to the Docker registry.
   - [publish](https://github.com/felixfbecker/semantic-release-docker#publish) Tag the image specified by `name` with the new version, push it to Docker Hub and update the latest tag.
+- [semantic-release-vsce](https://github.com/raix/semantic-release-vsce) Set of semantic-release plugins for publishing Visual Studio Code extensions to the marketplace
+  - **verifyConditions** Verify the presence and the validity of the vsce authentication and release configuration
+  - **prepare** Create a `.vsix` for distribution
+  - **publish** Publish the package to the Visual Studio Code marketplace
 - [semantic-release-verify-deps](https://github.com/piercus/semantic-release-verify-deps) 
   - [verifyConditions](https://github.com/piercus/semantic-release-verify-deps) Check the dependencies format against a regexp before a release
 - [semantic-release-chrome](https://github.com/GabrielDuarteM/semantic-release-chrome) Set of semantic-release plugins for publishing a Chrome extension release.

docs/support/troubleshooting.md

@@ -44,3 +44,13 @@ npm ERR! You do not have permission to publish "<package-name>". Are you logged
 This message is a little unclear, and might not have anything to with your `NPM_TOKEN` or authentication method. It might instead be related to the package name itself. If there is already a package with the same name as yours or, there is a very close match, it could trigger this error.
 
 Best way to be sure, is to search [npmjs.org](https://www.npmjs.com/)) using your package name. If there is a name conflict, rename your package in your `package.json`
+
+## Squashed commits are ignored by **semantic-release**
+
+**semantic-release** parses commits according to a [commit message convention](https://github.com/semantic-release/semantic-release#commit-message-format) to figure out how they affect the codebase. Commits that doesn't follow the project's commit message convention are simply ignored.
+
+When [squashing commits](https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History#_squashing) most Git tools will by default generate a new commit message with a summary of the squashed commits. This commit message will most likely not be compliant with the project's commit message convention and therefore will be ignored by **semantic-release**.
+
+When squashing commits make sure to rewrite the resulting commit message to be compliant with the project's commit message convention.
+
+**Note**: if the resulting squashed commit would encompasses multiple changes (for example multiple unrelated features or fixes) then it's probably not a good idea to squash those commits together. A commit should contain exactly one self-contained functional change and a functional change should be contained in exactly one commit. See [atomic commits](https://en.wikipedia.org/wiki/Atomic_commit).

docs/usage/configuration.md

@@ -6,7 +6,7 @@ In order to customize **semantic-release**’s behavior, [options](#options) and
 - A `release` key in the project's `package.json` file
 - CLI arguments
 
-The following two examples are the same.
+The following three examples are the same.
 
 Via CLI argument:
 
@@ -17,7 +17,20 @@ $ semantic-release --branch next
 Via `release` key in the project's `package.json` file:
 
 ```json
-"release": {
+{
+  "release": {
+    "branch": "next"
+  }
+}
+```
+```bash
+$ semantic-release
+```
+
+Via `.releaserc` file:
+
+```json
+{
   "branch": "next"
 }
 ```
@@ -29,6 +42,8 @@ $ semantic-release
 
 **Note**: Plugin options cannot be defined via CLI arguments and must be defined in the configuration file.
 
+**Note**: When configuring via `package.json`, the configuration must be under the `release` property. However, when using a `.releaserc` or a `release.config.js` file, the configuration must be set without a `release` property.
+
 ## Environment variables
 
 | Variable              | Description                                                                                                                                                                                                                    | Default                              |

docs/usage/plugins.md

@@ -91,7 +91,7 @@ For example:
 With this configuration:
 - the `custom-plugin` npm module will be used to [analyze commits](#analyzecommits-plugin)
 - the `./build/my-plugin.js` script will be used to [generate release notes](#generatenotes-plugin)
-- the [`@semantic-release/exec`](https://github.com/semantic-release/exec),  [`@semantic-release/npm`](https://github.com/semantic-release/npm) and [`@semantic-release/exec`](https://github.com/semantic-release/exec) plugins will be used to [verify conditions](#verifyconditions-plugin)
+- the [`@semantic-release/exec`](https://github.com/semantic-release/exec),  [`@semantic-release/npm`](https://github.com/semantic-release/npm) and [`@semantic-release/github`](https://github.com/semantic-release/github) plugins will be used to [verify conditions](#verifyconditions-plugin)
 - the [`@semantic-release/exec`](https://github.com/semantic-release/exec) plugin will be used to [verify the release](#verifyrelease-plugin)
 - the `cmd` option will be set to `verify-conditions.sh` only for the [`@semantic-release/exec`](https://github.com/semantic-release/exec) plugin used to [verify conditions](#verifyconditions-plugin)
 - the `cmd` option will be set to `verify-release.sh` only for the [`@semantic-release/exec`](https://github.com/semantic-release/exec) plugin used to [verify the release](#verifyrelease-plugin)

index.js

@@ -54,22 +54,20 @@ async function run(options, plugins) {
 
   await verify(options);
 
-  const {repositoryUrl} = options;
   options.repositoryUrl = await getGitAuthUrl(options);
 
-  if (!(await isBranchUpToDate(options.branch))) {
-    logger.log(
-      "The local branch %s is behind the remote one, therefore a new version won't be published.",
-      options.branch
-    );
-    return false;
-  }
-
   try {
     await verifyAuth(options.repositoryUrl, options.branch);
   } catch (err) {
+    if (!(await isBranchUpToDate(options.repositoryUrl, options.branch))) {
+      logger.log(
+        "The local branch %s is behind the remote one, therefore a new version won't be published.",
+        options.branch
+      );
+      return false;
+    }
     logger.error(`The command "${err.cmd}" failed with the error message %s.`, err.stderr);
-    throw getError('EGITNOPERMISSION', {options, repositoryUrl});
+    throw getError('EGITNOPERMISSION', {options});
   }
 
   logger.log('Run automated release from branch %s', options.branch);
@@ -179,7 +177,7 @@ async function callFail(plugins, options, error) {
 
 module.exports = async opts => {
   logger.log(`Running %s version %s`, pkg.name, pkg.version);
-  const unhook = hookStd({silent: false}, hideSensitive);
+  const {unhook} = hookStd({silent: false}, hideSensitive);
   try {
     const config = await getConfig(opts, logger);
     const {plugins, options} = config;

lib/definitions/errors.js

@@ -27,11 +27,11 @@ Please make sure to add the \`repositoryUrl\` to the [semantic-release configura
       'docs/usage/configuration.md'
     )}).`,
   }),
-  EGITNOPERMISSION: ({options, repositoryUrl}) => ({
+  EGITNOPERMISSION: ({options}) => ({
     message: 'The push permission to the Git repository is required.',
     details: `**semantic-release** cannot push the version tag to the branch \`${
       options.branch
-    }\` on remote Git repository with URL \`${repositoryUrl}\`.
+    }\` on remote Git repository with URL \`${options.repositoryUrl}\`.
 
 Please refer to the [authentication configuration documentation](${linkify(
       'docs/usage/ci-configuration.md#authentication'

lib/definitions/plugins.js

@@ -45,7 +45,7 @@ module.exports = {
   publish: {
     default: ['@semantic-release/npm', '@semantic-release/github'],
     config: {
-      validator: conf => Boolean(conf) && (isArray(conf) ? conf : [conf]).every(conf => validatePluginConfig(conf)),
+      validator: conf => !conf || (isArray(conf) ? conf : [conf]).every(conf => validatePluginConfig(conf)),
     },
     output: {
       validator: output => !output || isPlainObject(output),

lib/git.js

@@ -69,7 +69,7 @@ async function gitHead() {
  */
 async function repoUrl() {
   try {
-    return await execa.stdout('git', ['remote', 'get-url', 'origin']);
+    return await execa.stdout('git', ['config', '--get', 'remote.origin.url']);
   } catch (err) {
     debug(err);
   }
@@ -141,12 +141,19 @@ async function verifyTagName(tagName) {
 /**
  * Verify the local branch is up to date with the remote one.
  *
+ * @param {String} repositoryUrl The remote repository URL.
  * @param {String} branch The repository branch for which to verify status.
  *
  * @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) {
-  return isRefInHistory(await execa.stdout('git', ['rev-parse', `origin/${branch}`]));
+async function isBranchUpToDate(repositoryUrl, branch) {
+  try {
+    return await isRefInHistory(
+      (await execa.stdout('git', ['ls-remote', '--heads', repositoryUrl, branch])).match(/^(\w+)?/)[1]
+    );
+  } catch (err) {
+    debug(err);
+  }
 }
 
 module.exports = {

lib/plugins/normalize.js

@@ -15,9 +15,9 @@ module.exports = (pluginType, pluginsPath, globalOpts, pluginOpts, logger) => {
 
   if (!isFunction(pluginOpts)) {
     if (pluginsPath[path]) {
-      logger.log('Load plugin %s from %s in shareable config %s', pluginType, path, pluginsPath[path]);
+      logger.log('Load plugin "%s" from %s in shareable config %s', pluginType, path, pluginsPath[path]);
     } else {
-      logger.log('Load plugin %s from %s', pluginType, path);
+      logger.log('Load plugin "%s" from %s', pluginType, path);
     }
   }
 

package.json

@@ -30,17 +30,18 @@
     "debug": "^3.1.0",
     "env-ci": "^2.0.0",
     "execa": "^0.10.0",
+    "find-versions": "^2.0.0",
     "get-stream": "^3.0.0",
     "git-log-parser": "^1.2.0",
     "git-url-parse": "^9.0.0",
-    "hook-std": "^0.4.0",
+    "hook-std": "^1.0.1",
     "hosted-git-info": "^2.6.0",
     "lodash": "^4.17.4",
     "marked": "^0.4.0",
     "marked-terminal": "^3.0.0",
-    "p-locate": "^2.0.0",
+    "p-locate": "^3.0.0",
     "p-reduce": "^1.0.0",
-    "read-pkg-up": "^3.0.0",
+    "read-pkg-up": "^4.0.0",
     "resolve-from": "^4.0.0",
     "semver": "^5.4.1",
     "yargs": "^11.0.0"
@@ -51,7 +52,7 @@
     "codecov": "^3.0.0",
     "commitizen": "^2.9.6",
     "cz-conventional-changelog": "^2.0.0",
-    "delay": "^2.0.0",
+    "delay": "^3.0.0",
     "dockerode": "^2.5.2",
     "file-url": "^2.0.2",
     "fs-extra": "^6.0.0",
@@ -59,10 +60,10 @@
     "js-yaml": "^3.10.0",
     "mockserver-client": "^5.1.1",
     "nock": "^9.0.2",
-    "nyc": "^11.2.1",
+    "nyc": "^12.0.1",
     "p-retry": "^2.0.0",
     "proxyquire": "^2.0.0",
-    "sinon": "^5.0.1",
+    "sinon": "^6.0.0",
     "tempy": "^0.2.1",
     "xo": "^0.21.0"
   },

test/definitions/plugins.test.js

@@ -60,9 +60,9 @@ test('The "prepare" plugin, if defined, must be a single or an array of plugins
 test('The "publish" plugin is mandatory, and must be a single or an array of plugins definition', t => {
   t.false(plugins.publish.config.validator({}));
   t.false(plugins.publish.config.validator({path: null}));
-  t.false(plugins.publish.config.validator());
 
   t.true(plugins.publish.config.validator({path: 'plugin-path.js'}));
+  t.true(plugins.publish.config.validator());
   t.true(plugins.publish.config.validator('plugin-path.js'));
   t.true(plugins.publish.config.validator(() => {}));
   t.true(plugins.publish.config.validator([{path: 'plugin-path.js'}, 'plugin-path.js', () => {}]));

test/git.test.js

@@ -24,7 +24,6 @@ import {
   gitCommitTag,
   gitRemoteTagHead,
   push as pushUtil,
-  reset,
 } from './helpers/git-utils';
 
 // Save the current working diretory
@@ -189,31 +188,35 @@ test.serial('Throws error if obtaining the tags fails', async t => {
 });
 
 test.serial('Return "true" if repository is up to date', async t => {
-  await gitRepo(true);
+  const repositoryUrl = await gitRepo(true);
   await gitCommits(['First']);
   await pushUtil();
 
-  t.true(await isBranchUpToDate('master'));
+  t.true(await isBranchUpToDate(repositoryUrl, 'master'));
 });
 
 test.serial('Return falsy if repository is not up to date', async t => {
-  await gitRepo(true);
+  const repositoryUrl = await gitRepo(true);
+  const repoDir = process.cwd();
   await gitCommits(['First']);
   await gitCommits(['Second']);
   await pushUtil();
 
-  t.true(await isBranchUpToDate('master'));
+  t.true(await isBranchUpToDate(repositoryUrl, 'master'));
 
-  await reset();
+  await gitShallowClone(repositoryUrl);
+  await gitCommits(['Third']);
+  await pushUtil();
+  process.chdir(repoDir);
 
-  t.falsy(await isBranchUpToDate('master'));
+  t.falsy(await isBranchUpToDate(repositoryUrl, 'master'));
 });
 
 test.serial('Return "true" if local repository is ahead', async t => {
-  await gitRepo(true);
+  const repositoryUrl = await gitRepo(true);
   await gitCommits(['First']);
   await pushUtil();
   await gitCommits(['Second']);
 
-  t.true(await isBranchUpToDate('master'));
+  t.true(await isBranchUpToDate(repositoryUrl, 'master'));
 });

test/helpers/git-utils.js

@@ -212,12 +212,3 @@ export async function gitCommitTag(gitHead) {
 export async function push(repositoryUrl = 'origin', branch = 'master') {
   await execa('git', ['push', '--tags', repositoryUrl, `HEAD:${branch}`]);
 }
-
-/**
- * Reset repository to a commit.
- *
- * @param {String} [commit='HEAD~1'] Commit reference to reset the repo to.
- */
-export async function reset(commit = 'HEAD~1') {
-  await execa('git', ['reset', commit]);
-}

test/index.test.js

@@ -15,7 +15,6 @@ import {
   gitRemoteTagHead,
   push,
   gitShallowClone,
-  reset,
 } from './helpers/git-utils';
 
 // Save the current process.env
@@ -645,11 +644,15 @@ test.serial('Returns falsy value if triggered by a PR', async t => {
 test.serial('Returns falsy value if triggered on an outdated clone', async t => {
   // Create a git repository, set the current working directory at the root of the repo
   const repositoryUrl = await gitRepo(true);
+  const repoDir = process.cwd();
   // Add commits to the master branch
   await gitCommits(['First']);
   await gitCommits(['Second']);
   await push();
-  await reset();
+  await gitShallowClone(repositoryUrl);
+  await gitCommits(['Third']);
+  await push();
+  process.chdir(repoDir);
 
   const semanticRelease = proxyquire('..', {
     './lib/logger': t.context.logger,

test/integration.test.js

@@ -2,7 +2,7 @@ import test from 'ava';
 import {writeJson, readJson} from 'fs-extra';
 import {stub} from 'sinon';
 import execa from 'execa';
-import {gitHead as getGitHead, gitTagHead, gitRepo, gitCommits, gitRemoteTagHead} from './helpers/git-utils';
+import {gitHead as getGitHead, gitTagHead, gitRepo, gitCommits, gitRemoteTagHead, push} from './helpers/git-utils';
 import gitbox from './helpers/gitbox';
 import mockServer from './helpers/mockserver';
 import npmRegistry from './helpers/npm-registry';
@@ -609,6 +609,7 @@ test.serial('Exit with 1 if missing permission to push to the remote repository'
   /* Initial release */
   t.log('Commit a feature');
   await gitCommits(['feat: Initial commit']);
+  await push();
   t.log('$ semantic-release');
   const {stdout, code} = await execa(
     cli,

test/plugins/normalize.test.js

@@ -14,7 +14,7 @@ test('Normalize and load plugin from string', t => {
 
   t.is(plugin.pluginName, './test/fixtures/plugin-noop');
   t.is(typeof plugin, 'function');
-  t.deepEqual(t.context.log.args[0], ['Load plugin %s from %s', 'verifyConditions', './test/fixtures/plugin-noop']);
+  t.deepEqual(t.context.log.args[0], ['Load plugin "%s" from %s', 'verifyConditions', './test/fixtures/plugin-noop']);
 });
 
 test('Normalize and load plugin from object', t => {
@@ -22,7 +22,7 @@ test('Normalize and load plugin from object', t => {
 
   t.is(plugin.pluginName, './test/fixtures/plugin-noop');
   t.is(typeof plugin, 'function');
-  t.deepEqual(t.context.log.args[0], ['Load plugin %s from %s', 'publish', './test/fixtures/plugin-noop']);
+  t.deepEqual(t.context.log.args[0], ['Load plugin "%s" from %s', 'publish', './test/fixtures/plugin-noop']);
 });
 
 test('Normalize and load plugin from a base file path', t => {
@@ -37,7 +37,7 @@ test('Normalize and load plugin from a base file path', t => {
   t.is(plugin.pluginName, './plugin-noop');
   t.is(typeof plugin, 'function');
   t.deepEqual(t.context.log.args[0], [
-    'Load plugin %s from %s in shareable config %s',
+    'Load plugin "%s" from %s in shareable config %s',
     'verifyConditions',
     './plugin-noop',
     './test/fixtures',
@@ -85,7 +85,7 @@ test('Normalize and load plugin that retuns multiple functions', t => {
   const plugin = normalize('verifyConditions', {}, {}, './test/fixtures/multi-plugin', t.context.logger);
 
   t.is(typeof plugin, 'function');
-  t.deepEqual(t.context.log.args[0], ['Load plugin %s from %s', 'verifyConditions', './test/fixtures/multi-plugin']);
+  t.deepEqual(t.context.log.args[0], ['Load plugin "%s" from %s', 'verifyConditions', './test/fixtures/multi-plugin']);
 });
 
 test('Wrap "analyzeCommits" plugin in a function that validate the output of the plugin', async t => {