fix(package): update hook-std to version 1.0.0

added quotes around plugin name to set it apart from the message. without the quotes, some consumers
were missunderstanding the successful loading of the `fail` plugin as a load failure and assuming
something was broken

resolves #811

README.md

@@ -68,9 +68,9 @@ Here is an example of the release type that will be done based on a commit messa
 
 ### Triggering a release
 
-When pushing new commits to the release branch (i.e. `master`) with `git push` or by merging a pull request or merging from another branch, a CI build is triggered and runs the `semantic-release` command to make a release if there are relevant codebase changes since the last release.
+For each new commits added to the release branch (i.e. `master`) with `git push` or by merging a pull request or merging from another branch, a CI build is triggered and runs the `semantic-release` command to make a release if there are codebase changes since the last release that affect the package functionalities.
 
-By default a release will be done for each push to the release branch that contains relevant code changes. If you need more control over the timing of releases you have a couple of options:
+If you need more control over the timing of releases you have a couple of options:
 - Publish releases on a distribution channel (for example npm’s [dist-tags](https://docs.npmjs.com/cli/dist-tag)). This way you can keep control over what your users end up using by default, and you can decide when to make an automatically released version available to the stable channel, and promote it.
 - Develop on a `dev` branch and merge it to the release branch (i.e. `master`) once you are ready to publish. **semantic-release** will run only on pushes to the release branch.
 
@@ -83,11 +83,11 @@ After running the tests the command `semantic-release` will execute the followin
 | Verify Conditions | Verify all the conditions to proceed with the release with the [verify conditions plugins](docs/usage/plugins.md#verifyconditions-plugin).                            |
 | Get last release  | Obtain the commit corresponding to the last release by analyzing [Git tags](https://git-scm.com/book/en/v2/Git-Basics-Tagging).                                       |
 | Analyze commits   | Determine the type of release with the [analyze commits plugin](docs/usage/plugins.md#analyzecommits-plugin) based on the commits added since the last release.       |
-| Verify release    | Verify the release conformity with the [verify release plugins](docs/usage/plugins.md#verifyrelease-plugin).                                                           |
+| Verify release    | Verify the release conformity with the [verify release plugins](docs/usage/plugins.md#verifyrelease-plugin).                                                          |
 | Generate notes    | Generate release notes with the [generate notes plugin](docs/usage/plugins.md#generatenotes-plugin) for the commits added since the last release.                     |
 | Create Git tag    | Create a Git tag corresponding to the new release version                                                                                                             |
-| Prepare           | Prepare the release with the [prepare plugins](docs/usage/plugins.md#prepare-plugin).                                                                                  |
-| Publish           | Publish the release with the [publish plugins](docs/usage/plugins.md#publish-plugin).                                                                                  |
+| Prepare           | Prepare the release with the [prepare plugins](docs/usage/plugins.md#prepare-plugin).                                                                                 |
+| Publish           | Publish the release with the [publish plugins](docs/usage/plugins.md#publish-plugin).                                                                                 |
 | Notify            | Notify of new releases or errors with the [success](docs/usage/plugins.md#success-plugin) and [fail](docs/usage/plugins.md#fail-plugin) plugins.                      |
 
 ## Documentation

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/FAQ.md

@@ -164,6 +164,21 @@ You can trigger a release by pushing to your Git repository. You deliberately ca
 
 Yes, every commits that contains `[skip release]` or `[release skip]` in their message will be excluded from the commit analysis and won't participate in the release type determination.
 
+## How can I change the type of commits that trigger a release?
+
+By default **semantic-release** uses the [Angular Commit Message Conventions](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines) and triggers releases based on the following rules:
+
+| Commit                      | Release type               |
+|-----------------------------|----------------------------|
+| Commit with breaking change | ~~Major~~ Breaking release |
+| Commit with type `feat`     | ~~Minor~~ Feature release  |
+| Commit with type `fix`      | Patch release              |
+| Commit with type `perf`     | Patch release              |
+
+See the [`@semantic-release/npm`](https://github.com/semantic-release/npm#npm-configuration) plugin documentation for more details.
+
+This is fully customizable with the [`@semantic-release/commit-analyzer`](https://github.com/semantic-release/commit-analyzer) plugin's [`release-rules` option](https://github.com/semantic-release/commit-analyzer#release-rules).
+
 ## Is it *really* a good idea to release on every push?
 
 It is indeed a great idea because it *forces* you to follow best practices. If you don’t feel comfortable releasing every feature or fix on your `master` you might not treat your `master` branch as intended.
@@ -174,6 +189,8 @@ From [Understanding the GitHub Flow](https://guides.github.com/introduction/flow
 
 If you need more control over the timing of releases, see [Triggering a release](../../README.md#triggering-a-release) for different options.
 
+**Note**: Only the codebase changes altering the published package will trigger a release (for example new features, bug fixes or performance improvements would trigger a release while refactoring or changing code style would not). See [How can I change the type of commits that trigger a release?](#how-can-i-change-the-type-of-commits-that-trigger-a-release) for more details.
+
 ## Can I set the initial release version of my package to `0.0.1`?
 
 This is not supported by **semantic-release** as it's not considered a good practice, mostly because [Semantic Versioning](https://semver.org) rules applies differently to major version zero.
@@ -194,7 +211,7 @@ In addition the [verify conditions step](../../README.md#release-steps) verifies
 
 See [Node version requirement](../support/node-version.md#node-version-requirement) for more details and solutions.
 
-# What is npx?
+## What is npx?
 
 [`npx`](https://www.npmjs.com/package/npx) – short for "npm exec" – is a CLI to find and execute npm binaries within the local `node_modules` folder or in the $PATH. If a binary can't be located npx will download the required package and execute it from its cache location.
 The tool is bundled with [npm](https://www.npmjs.com/package/npm) >= 5.2, or can be installed via `npm install -g npx`.

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                              |

index.js

@@ -54,6 +54,7 @@ async function run(options, plugins) {
 
   await verify(options);
 
+  const {repositoryUrl} = options;
   options.repositoryUrl = await getGitAuthUrl(options);
 
   if (!(await isBranchUpToDate(options.branch))) {
@@ -68,7 +69,7 @@ async function run(options, plugins) {
     await verifyAuth(options.repositoryUrl, options.branch);
   } catch (err) {
     logger.error(`The command "${err.cmd}" failed with the error message %s.`, err.stderr);
-    throw getError('EGITNOPERMISSION', {options});
+    throw getError('EGITNOPERMISSION', {options, repositoryUrl});
   }
 
   logger.log('Run automated release from branch %s', options.branch);
@@ -178,7 +179,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,15 +27,17 @@ Please make sure to add the \`repositoryUrl\` to the [semantic-release configura
       'docs/usage/configuration.md'
     )}).`,
   }),
-  EGITNOPERMISSION: ({options}) => ({
+  EGITNOPERMISSION: ({options, repositoryUrl}) => ({
     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.
+    }\` on remote Git repository with URL \`${repositoryUrl}\`.
 
 Please refer to the [authentication configuration documentation](${linkify(
       'docs/usage/ci-configuration.md#authentication'
-    )}) to configure the Git credentials on your CI environment.`,
+    )}) to configure the Git credentials on your CI environment and make sure the [repositoryUrl](${linkify(
+      'docs/usage/configuration.md#repositoryurl'
+    )}) is configured with a [valid Git URL](https://git-scm.com/book/en/v2/Git-on-the-Server-The-Protocols).`,
   }),
   EINVALIDTAGFORMAT: ({tagFormat}) => ({
     message: 'Invalid `tagFormat` option.',

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

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,14 +30,15 @@
     "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.3.9",
-    "marked-terminal": "^2.0.0",
+    "marked": "^0.4.0",
+    "marked-terminal": "^3.0.0",
     "p-locate": "^2.0.0",
     "p-reduce": "^1.0.0",
     "read-pkg-up": "^3.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,7 +60,7 @@
     "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",

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