feat: allow to disable the publish plugin hook

`verifyConditions` explanation was wrong previously.

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);

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

@@ -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 = {

package.json

@@ -41,7 +41,7 @@
     "marked-terminal": "^3.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"

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,