WIP just debugging nevermind me

*Total -- 258.67kb -> 182.47kb (29.46%)

/media/semantic-release-cli.png -- 116.80kb -> 65.42kb (43.99%)
/media/bender.png -- 141.88kb -> 117.05kb (17.5%)

.github/ISSUE_TEMPLATE/01_bug_report.md

@@ -0,0 +1,21 @@
+---
+name: Bug report
+about: Something not working as expected
+
+---
+
+## Current behavior
+
+<!-- Describe how the issue manifests. -->
+
+## Expected behavior
+
+<!-- Describe what the desired behavior would be. -->
+
+## Environment
+
+- **semantic-release** version: <!-- Version set in package.json devDpendencies -->
+- CI environment: <!-- CI service name -->
+- Plugins used: <!-- List semantic-release plugin used if any -->
+- **semantic-release** configuration: <!-- link to your repository or relevant part of the semantic-release config -->
+- CI logs: <!-- link to your CI logs or semantic-release logs -->

.github/ISSUE_TEMPLATE/02_feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Wouldn’t it be nice if semantic-release could ...
+
+---
+
+## New feature motivation
+
+<!-- Describe the context, the use-case and the advantages of the feature request. -->
+
+## New feature description
+
+<!-- Describe the functional changes that would have to be made in semantic-release or its plugins. -->
+
+## New feature implementation
+
+<!-- Optionally describe the technical changes to be made in semantic-release or its plugins. -->

.github/ISSUE_TEMPLATE/03_plugin_suggestion.md

@@ -0,0 +1,13 @@
+---
+name: New plugin suggestion
+about: Integrate with a new platform, etc
+
+---
+
+## New plugin motivation
+
+<!-- Describe the reasons to create a new plugin and why it's not covered by the existing ones. -->
+
+## Third-party documentation
+
+<!-- Provide explanation and documentation links for the platform to integrate with. -->

.github/airtable-crm.yml

@@ -0,0 +1 @@
+base: app0ZOxG0FnHmOiuU

.gitignore

@@ -125,11 +125,9 @@ $RECYCLE.BIN/
 # Windows shortcuts
 *.lnk
 
-# End of https://www.gitignore.io/api/macos,windows,linux,node
-
+# Lockfiles
 package-lock.json
 yarn.lock
 
-# Registry tests
-test/helpers/registry/couch
-test/helpers/registry/data
+# Gitbook
+_book

.travis.yml

@@ -1,17 +1,17 @@
 language: node_js
+
 services:
-  - couchdb
   - docker
-notifications:
-  email: false
+
 node_js:
+  - 10
   - 8
 
-# Trigger a push build on caribou and greenkeeper branches + PRs build on every branches
+# Trigger a push build on master and greenkeeper branches + PRs build on every branches
 # Avoid double build on PRs (See https://github.com/travis-ci/travis-ci/issues/1147)
 branches:
   only:
-    - caribou
+    - master
     - /^greenkeeper.*$/
 
 # Retry install on fail to avoid failing a build on network/disk/external errors
@@ -23,4 +23,10 @@ script:
 
 after_success:
   - npm run codecov
-  - npm run semantic-release
+
+jobs:
+  include:
+    - stage: release
+      node_js: lts/*
+      script:
+        - npm run semantic-release

CONTRIBUTING.md

@@ -0,0 +1,251 @@
+# Contributing to semantic-release
+
+✨ Thanks for contributing to **semantic-release**! ✨
+
+As a contributor, here are the guidelines we would like you to follow:
+- [Code of conduct](#code-of-conduct)
+- [How can I contribute?](#how-can-i-contribute)
+- [Using the issue tracker](#using-the-issue-tracker)
+- [Submitting a Pull Request](#submitting-a-pull-request)
+- [Coding rules](#coding-rules)
+- [Working with the code](#working-with-the-code)
+
+We also recommend that you read [How to Contribute to Open Source](https://opensource.guide/how-to-contribute).
+
+## Code of conduct
+
+Help us keep **semantic-release** open and inclusive. Please read and follow our [Code of conduct](CODE_OF_CONDUCT.md).
+
+## How can I contribute?
+
+### Improve documentation
+
+As a **semantic-release** user, you are the perfect candidate to help us improve our documentation: typo corrections, clarifications, more examples, new [recipes](docs/recipes/README.md), etc. Take a look at the [documentation issues that need help](https://github.com/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+user%3Asemantic-release+archived%3Afalse+label%3A%22help+wanted%22+label%3Adocs+).
+
+Please follow the [Documentation guidelines](#documentation).
+
+### Give feedback on issues
+
+Some issues are created without information requested in the [Bug report guideline](#bug-report). Help make them easier to resolve by adding any relevant information.
+
+Issues with the [design label](https://github.com/issues?q=is%3Aopen+is%3Aissue+user%3Asemantic-release+archived%3Afalse+label%3Adesign) are meant to discuss the implementation of new features. Participating in the discussion is a good opportunity to get involved and influence the future direction of **semantic-release**.
+
+### Fix bugs and implement features
+
+Confirmed bugs and ready-to-implement features are marked with the [help wanted label](https://github.com/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+user%3Asemantic-release+archived%3Afalse+label%3A%22help+wanted%22). Post a comment on an issue to indicate you would like to work on it and to request help from the [@semantic-release/maintainers](https://github.com/orgs/semantic-release/teams/contributors) and the community.
+
+## Using the issue tracker
+
+The issue tracker is the channel for [bug reports](#bug-report), [features requests](#feature-request) and [submitting pull requests](#submitting-a-pull-request) only. Please use the [Support](docs/support/README.md) and [Get help](README.md#get-help) sections for support, troubleshooting and questions.
+
+Before opening an issue or a Pull Request, please use the [GitHub issue search](https://github.com/issues?utf8=%E2%9C%93&q=user%3Asemantic-release) to make sure the bug or feature request hasn't been already reported or fixed.
+
+### Bug report
+
+A good bug report shouldn't leave others needing to chase you for more information. Please try to be as detailed as possible in your report and fill the information requested in the [Bug report template](https://github.com/semantic-release/semantic-release/issues/new?template=bug-report.md).
+
+### Feature request
+
+Feature requests are welcome, but take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible and fill the information requested in the [Feature request template](https://github.com/semantic-release/semantic-release/issues/new?template=feature-request.md).
+
+### New plugin request
+
+[Plugins](docs/usage/plugins.md) are a great way to extend **semantic-release** capabilities, integrate with other systems and support new project type. Please provide as much detail and context as possible and fill the information requested in the [New plugin request template](https://github.com/semantic-release/semantic-release/issues/new?template=plugin-request.md).
+
+## Submitting a Pull Request
+
+Good pull requests, whether patches, improvements, or new features, are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.
+
+**Please ask first** before embarking on any significant pull requests (e.g. implementing features, refactoring code), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.
+
+If you have never created a pull request before, welcome 🎉 😄. [Here is a great tutorial](https://opensource.guide/how-to-contribute/#opening-a-pull-request) on how to send one :)
+
+Here is a summary of the steps to follow:
+
+1. [Set up the workspace](#set-up-the-workspace)
+2. If you cloned a while ago, get the latest changes from upstream and update dependencies:
+```bash
+$ git checkout master
+$ git pull upstream master
+$ rm -rf node_modules
+$ npm install
+```
+3. Create a new topic branch (off the main project development branch) to contain your feature, change, or fix:
+```bash
+$ git checkout -b <topic-branch-name>
+```
+4. Make your code changes, following the [Coding rules](#coding-rules)
+5. Push your topic branch up to your fork:
+```bash
+$ git push origin <topic-branch-name>
+```
+6. [Open a Pull Request](https://help.github.com/articles/creating-a-pull-request/#creating-the-pull-request) with a clear title and description.
+
+**Tips**:
+- For ambitious tasks, open a Pull Request as soon as possible with the `[WIP]` prefix in the title, in order to get feedback and help from the community.
+- [Allow semantic-release maintainers to make changes to your Pull Request branch](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork). This way, we can rebase it and make some minor changes if necessary. All changes we make will be done in new commit and we'll ask for your approval before merging them.
+
+## Coding rules
+
+### Source code
+
+To ensure consistency and quality throughout the source code, all code modifications must have:
+- No [linting](#lint) errors
+- A [test](#tests) for every possible case introduced by your code change
+- **100%** test coverage
+- [Valid commit message(s)](#commit-message-guidelines)
+- Documentation for new features
+- Updated documentation for modified features
+
+### Documentation
+
+To ensure consistency and quality, all documentation modifications must:
+- Refer to brand in [bold](https://help.github.com/articles/basic-writing-and-formatting-syntax/#styling-text) with proper capitalization, i.e. **GitHub**, **semantic-release**, **npm**
+- Prefer [tables](https://help.github.com/articles/organizing-information-with-tables) over [lists](https://help.github.com/articles/basic-writing-and-formatting-syntax/#lists) when listing key values, i.e. List of options with their description
+- Use [links](https://help.github.com/articles/basic-writing-and-formatting-syntax/#links) when you are referring to:
+  - a **semantic-release** concept described somewhere else in the documentation, i.e. How to [contribute](CONTRIBUTING.md)
+  - a third-party product/brand/service, i.e. Integrate with [GitHub](https://github.com)
+  - an external concept or feature, i.e. Create a [GitHub release](https://help.github.com/articles/creating-releases)
+  - a package or module, i.e. The [`@semantic-release/github`](https://github.com/semantic-release/github) module
+- Use the the [single backtick `code` quoting](https://help.github.com/articles/basic-writing-and-formatting-syntax/#quoting-code) for:
+  - commands inside sentences, i.e. the `semantic-release` command
+  - programming language keywords, i.e. `function`, `async`, `String`
+  - packages or modules, i.e. The [`@semantic-release/github`](https://github.com/semantic-release/github) module
+- Use the the [triple backtick `code` formatting](https://help.github.com/articles/creating-and-highlighting-code-blocks) for:
+  - code examples
+  - configuration examples
+  - sequence of command lines
+
+### Commit message guidelines
+
+#### Atomic commits
+
+If possible, make [atomic commits](https://en.wikipedia.org/wiki/Atomic_commit), which means:
+- a commit should contain exactly one self-contained functional change
+- a functional change should be contained in exactly one commit
+- a commit should not create an inconsistent state (such as test errors, linting errors, partial fix, feature with documentation etc...)
+
+A complex feature can be broken down into multiple commits as long as each one maintains a consistent state and consists of a self-contained change.
+
+#### Commit message format
+
+Each commit message consists of a **header**, a **body** and a **footer**. The header has a special format that includes a **type**, a **scope** and a **subject**:
+
+```commit
+<type>(<scope>): <subject>
+<BLANK LINE>
+<body>
+<BLANK LINE>
+<footer>
+```
+
+The **header** is mandatory and the **scope** of the header is optional.
+
+The **footer** can contain a [closing reference to an issue](https://help.github.com/articles/closing-issues-via-commit-messages).
+
+#### Revert
+
+If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
+
+#### Type
+
+The type must be one of the following:
+
+| Type         | Description                                                                                                 |
+|--------------|-------------------------------------------------------------------------------------------------------------|
+| **build**    | Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)         |
+| **ci**       | Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs) |
+| **docs**     | Documentation only changes                                                                                  |
+| **feat**     | A new feature                                                                                               |
+| **fix**      | A bug fix                                                                                                   |
+| **perf**     | A code change that improves performance                                                                     |
+| **refactor** | A code change that neither fixes a bug nor adds a feature                                                   |
+| **style**    | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)      |
+| **test**     | Adding missing tests or correcting existing tests                                                           |
+
+#### Subject
+
+The subject contains succinct description of the change:
+
+- use the imperative, present tense: "change" not "changed" nor "changes"
+- don't capitalize first letter
+- no dot (.) at the end
+
+#### Body
+Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
+The body should include the motivation for the change and contrast this with previous behavior.
+
+#### Footer
+The footer should contain any information about **Breaking Changes** and is also the place to reference GitHub issues that this commit **Closes**.
+
+**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.
+
+#### Examples
+
+```commit
+`fix(pencil): stop graphite breaking when too much pressure applied`
+```
+
+```commit
+`feat(pencil): add 'graphiteWidth' option`
+
+Fix #42
+```
+
+```commit
+perf(pencil): remove graphiteWidth option`
+
+BREAKING CHANGE: The graphiteWidth option has been removed.
+
+The default graphite width of 10mm is always used for performance reasons.
+```
+
+## Working with the code
+
+### Set up the workspace
+
+[Fork](https://guides.github.com/activities/forking/#fork) the project, [clone](https://guides.github.com/activities/forking/#clone) your fork, configure the remotes and install the dependencies:
+
+```bash
+# Clone your fork of the repo into the current directory
+$ git clone https://github.com/semantic-release/<repo-name>
+# Navigate to the newly cloned directory
+$ cd <repo-name>
+# Assign the original repo to a remote called "upstream"
+$ git remote add upstream https://github.com/semantic-release/<repo-name>
+# Install the dependencies
+$ npm install
+```
+
+### Lint
+
+All the [semantic-release](https://github.com/semantic-release) repositories use [XO](https://github.com/sindresorhus/xo) for linting and [Prettier](https://prettier.io) for formatting. Prettier formatting will be automatically verified and fixed by XO.
+
+Before pushing your code changes make sure there are no linting errors with `npm run lint`.
+
+**Tips**:
+- Most linting errors can be automatically fixed with `npm run lint --fix`.
+- Install the [XO plugin](https://github.com/sindresorhus/xo#editor-plugins) for your editor to see linting errors directly in your editor and automatically fix them on save.
+
+### Tests
+
+Running the integration test requires you to install [Docker](https://docs.docker.com/engine/installation) on your machine.
+
+All the [semantic-release](https://github.com/semantic-release) repositories use [AVA](https://github.com/avajs/ava) for writing and running tests.
+
+Before pushing your code changes make sure all **tests pass** and the **coverage is 100%**:
+
+```bash
+$ npm run test
+```
+
+**Tips:** During development you can:
+- run only a subset of test files with `ava <glob>`, for example `ava test/mytestfile.test.js`
+- run in watch mode with `ava -w` to automatically run a test file when you modify it
+- run only the test you are working on by adding [`.only` to the test definition](https://github.com/avajs/ava#running-specific-tests)
+
+### Commits
+
+All the [semantic-release](https://github.com/semantic-release) repositories use [Commitizen](https://github.com/commitizen/cz-cli) to help you create [valid commit messages](#commit-message-guidelines).
+
+After staging your changes with `git add`, run `npm run cm` to start the interactive commit message CLI.

README.md

@@ -1,297 +1,130 @@
-# :package::rocket: semantic-release
+<h1 align="center" style="border-bottom: none;">📦🚀 semantic-release</h1>
+<h3 align="center">Fully automated version management and package publishing</h3>
+<p align="center">
+  <a href="https://spectrum.chat/semantic-release">
+    <img alt="Join the community on Spectrum" src="https://withspectrum.github.io/badge/badge.svg">
+  </a>
+  <a href="https://travis-ci.org/semantic-release/semantic-release">
+    <img alt="Travis" src="https://img.shields.io/travis/semantic-release/semantic-release/master.svg">
+  </a>
+  <a href="https://codecov.io/gh/semantic-release/semantic-release">
+    <img alt="Codecov" src="https://img.shields.io/codecov/c/github/semantic-release/semantic-release/master.svg">
+  </a>
+  <a href="https://greenkeeper.io">
+    <img alt="Greenkeeper" src="https://badges.greenkeeper.io/semantic-release/semantic-release.svg">
+  </a>
+  <a href="#badge">
+    <img alt="semantic-release" src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg">
+  </a>
+</p>
+<p align="center">
+  <a href="https://www.npmjs.com/package/semantic-release">
+    <img alt="npm latest version" src="https://img.shields.io/npm/v/semantic-release/latest.svg">
+  </a>
+  <a href="https://www.npmjs.com/package/semantic-release">
+    <img alt="npm next version" src="https://img.shields.io/npm/v/semantic-release/next.svg">
+  </a>
+</p>
 
-**fully automated package publishing**
+**semantic-release** automates the whole package release workflow including: determining the next version number, generating the release notes and publishing the package.
 
-> **Trust us, this will change your workflow for the better.**
+This removes the immediate connection between human emotions and version numbers, strictly following the [Semantic Versioning](http://semver.org) specification.
 
-> – [egghead.io](https://egghead.io/lessons/javascript-how-to-write-a-javascript-library-automating-releases-with-semantic-release)
+> Trust us, this will change your workflow for the better. – [egghead.io](https://egghead.io/lessons/javascript-how-to-write-a-javascript-library-automating-releases-with-semantic-release)
 
-[![Join the chat at https://gitter.im/semantic-release/semantic-release](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/semantic-release/semantic-release?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-[![npm](https://img.shields.io/npm/v/semantic-release.svg)](https://www.npmjs.com/package/semantic-release)
-[![Greenkeeper badge](https://badges.greenkeeper.io/semantic-release/semantic-release.svg)](https://greenkeeper.io/)
-[![license](https://img.shields.io/github/license/semantic-release/semantic-release.svg)](https://github.com/semantic-release/semantic-release/blob/master/LICENSE)
-[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
-[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
-[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
+## Highlights
 
-[![Travis](https://img.shields.io/travis/semantic-release/semantic-release/caribou.svg)](https://travis-ci.org/semantic-release/semantic-release)
-[![Codecov](https://img.shields.io/codecov/c/github/semantic-release/semantic-release/caribou.svg)](https://codecov.io/gh/semantic-release/semantic-release)
-
-Out of the box this is just about _commit-messages_, but you can do so much more.
-
-* **Detect breaking changes** using the test suite of your last release: [cracks](https://github.com/semantic-release/cracks)
-* Detect breaking changes using your dependents’ test suites: [Help out! Implement the **dont-break** plugin](https://github.com/semantic-release/semantic-release/issues/65)
-* Detect breaking changes diffing your JSDoc interface: [Help out! Implement the **india** plugin](https://github.com/semantic-release/semantic-release/issues/66)
-* Abort releases with **insufficient test coverage**: [Help out! Implement the **istanbul** plugin](https://github.com/semantic-release/semantic-release/issues/68)
-* Abort releases with **vulnerable dependencies** in the tree: [Help out! Implement the **nsp** plugin](https://github.com/semantic-release/semantic-release/issues/67)
-* Everything you can imagine: [Build Plugins!](https://github.com/semantic-release/semantic-release#plugins)
-
-&nbsp; | Commands | Comment
---- | --- | ---
-| **manual/before** | <pre><code><div>npm version major</div><div>git push origin master --tags</div><div>npm publish</div></code></pre> | You **manually decide** what the **next version** is. You have to remember what major, minor and patch means. You have to remember to push both commits and tags. You have to wait for the CI to pass. |
-| **semantic-release/after** | <pre><code><div>git commit -m "fix: &lt;message&gt;"</div><div>git push</div></code></pre> | You **describe the changes** you’ve made. A new version is automatically published with the correct version number.
-
-This removes the immediate connection between human emotions and version numbers, so strictly following the [SemVer](http://semver.org/) spec is not a problem anymore – and that’s ultimately `semantic-release`’s goal.
-
-<table>
-  <tr>
-    <th colspan="2">
-      “How to Write a JavaScript Library - Automating Releases with semantic-release” – egghead.io
-    </th>
-  </tr>
-  <tr>
-    <td colspan="2">
-      <a href="https://egghead.io/lessons/javascript-how-to-write-a-javascript-library-automating-releases-with-semantic-release"><img src="https://cloud.githubusercontent.com/assets/908178/9730739/7b1da5d8-5610-11e5-88b6-5c75fdda7ee2.png" alt="egghead.io session"></a>
-    </td>
-  </tr>
-  <tr>
-    <td colspan="2">
-      A free egghead.io tutorial series on how to write an open source library featuring semantic-release.
-    </td>
-  </tr>
-  <tr>
-    <th>
-      “We fail to follow SemVer – and why it needn’t matter”
-    </th>
-    <th>
-      “semantic-release Q&A with Kent C. Dodds”
-    </th>
-  </tr>
-  <tr>
-    <td>
-      <a href="https://www.youtube.com/watch?v=tc2UgG5L7WM&amp;index=6&amp;list=PLFZ5NyC0xHDaaTy6tY9p0C0jd_rRRl5Zm"><img alt="JSConfBP Talk" src="https://cloud.githubusercontent.com/assets/908178/9428178/c337ed26-49a2-11e5-8ad0-a602500a65bf.png"></a>
-    </td>
-    <td>
-      <a href="https://www.youtube.com/watch?v=g6y3DnhkjrI"><img alt="Hangout on Air with Kent C. Dodds" src="https://cloud.githubusercontent.com/assets/908178/9428179/c3387318-49a2-11e5-9f5f-dccd3fbb0c1d.png"></a>
-    </td>
-  </tr>
-  <tr>
-    <td>
-      This talk gives you a complete introduction to the underlying concepts of this module. 38:30
-    </td>
-    <td>
-      A “Hangouts on Air” conversation with hands on questions and answers about how to use semantic-release. 53:52
-    </td>
-  </tr>
-</table>
+- Fully automated release
+- Enforce [Semantic Versioning](https://semver.org) specification
+- New features and fixes are immediately available to users
+- Notify maintainers and users of new releases
+- Use formalized commit message convention to document changes in the codebase
+- Integrate with your [continuous integration workflow](docs/recipes/README.md#ci-configurations)
+- Avoid potential errors associated with manual releases
+- Support any [package managers and languages](docs/recipes/README.md#package-managers-and-languages) via [plugins](docs/usage/plugins.md)
+- Simple and reusable configuration via [shareable configurations](docs/usage/shareable-configurations.md)
 
 ## How does it work?
 
-Instead of writing [meaningless commit messages](http://whatthecommit.com/), we can take our time to think about the changes in the codebase and write them down. Following formalized conventions it is then possible to generate a helpful changelog and to derive the next semantic version number from them.
-
-When `semantic-release` is set up it will do that after every successful continuous integration build of your master branch (or any other branch you specify) and publish the new version for you. This way no human is directly involved in the release process and your releases are guaranteed to be [unromantic and unsentimental](http://sentimentalversioning.org/).
-
-If you fear the loss of control over timing and marketing implications of software releases you should know that `semantic-release` supports [release channels](https://github.com/npm/npm/issues/2718) using `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, you can decide when to promote an automatically released version to the stable channel, and you can choose which versions to write blogposts and tweets about. You can use the same mechanism to [support older versions of your software](https://gist.github.com/boennemann/54042374e49c7ade8910), for example with important security fixes.
-
-When pushing new commits with `git push` a CI build is triggered. After running the tests the command `semantic-release` will execute the following tasks in series:
-
-| Step               | Description                                                                                 |
-| ------------------ | ------------------------------------------------------------------------------------------- |
-| Verify Conditions` | Run the [verifyConditions](#verifyConditions) plugin)                                       |
-| Get last release`  | Obtain last release with the [getLastRelease](#getLastRelease) plugin                       |
-| Analyze commits    | Determine the type of release to do with the [analyzeCommits](#analyzeCommits) plugin       |
-| Verify release     | Call the [verifyRelease](#verifyRelease) plugin                                             |
-| npm publish        | Update the version in `package.json` and call `npm publish`                                 |
-| Generate notes     | Generate release notes with plugin [generateNotes](#generateNotes)                          |
-| Github release     | A git tag and [Github release](https://help.github.com/articles/about-releases/) is created |
-
-_Note:_ The current release/tag implementation is tied to GitHub, but could be opened up to Bitbucket, GitLab, et al. Feel free to send PRs for these services.
-
-## Default Commit Message Format
-
-This module ships with the [AngularJS Commit Message Conventions](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit) and changelog generator, but you can [define your own](#plugins) style.
-
-Each commit message consists of a **header**, a **body** and a **footer**.  The header has a special
-format that includes a **type**, a **scope** and a **subject** ([full explanation](https://github.com/stevemao/conventional-changelog-angular/blob/master/convention.md)):
-
-```
-<type>(<scope>): <subject>
-<BLANK LINE>
-<body>
-<BLANK LINE>
-<footer>
-```
-
-You can simplify using this convention for yourself and contributors by using [commitizen](https://github.com/commitizen/cz-cli) and [commitlint](https://github.com/marionebl/commitlint) or [semantic-git-commit-cli](https://github.com/JPeer264/node-semantic-git-commit-cli).
-
-### Patch Release
-
-```
-fix(pencil): stop graphite breaking when too much pressure applied
-```
-
-### ~~Minor~~ Feature Release
-
-```
-feat(pencil): add 'graphiteWidth' option
-```
-
-### ~~Major~~ Breaking Release
-
-```
-perf(pencil): remove graphiteWidth option
-
-BREAKING CHANGE: The graphiteWidth option has been removed. The default graphite width of 10mm is always used for performance reasons.
-```
-
-## Setup
-
-[![NPM](https://nodei.co/npm/semantic-release.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/semantic-release/)
-
-```bash
-npm install -g semantic-release-cli
-
-cd your-module
-semantic-release-cli setup
-```
-
-![dialogue](https://cloud.githubusercontent.com/assets/908178/9428123/3628dfec-499f-11e5-8bdd-8f3042dd95ed.png)
-
-_[This is what happens under the hood.](https://github.com/semantic-release/cli#what-it-does)_
-
-## Options
-
-You can pass options either via command line (in [kebab-case](https://lodash.com/docs#kebabCase)) or in the `release` field of your `package.json` (in [camelCase](https://lodash.com/docs#camelCase)). The following two examples are the same, but CLI arguments take precedence.
-
-##### CLI
-```bash
-semantic-release --branch next
-```
-
-##### package.json
-```json
-"release": {
-  "branch": "next"
-}
-```
-```bash
-semantic-release
-```
-
-These options are currently available:
-- `branch`: The branch on which releases should happen. Default: `'master'`
-- `dry-run`: Dry-run mode, skipping verifyConditions, publishing and release, printing next version and release notes
-- `debug`: Output debugging information
-- `githubToken`: The token used to authenticate with GitHub. Default: `process.env.GH_TOKEN`
-- `githubUrl`: Optional. Pass your GitHub Enterprise endpoint.
-- `githubApiPathPrefix`: Optional. The path prefix for your GitHub Enterprise API.
-
-_A few notes on `npm` config_:
-1. The `npm` token can only be defined in the environment as `NPM_TOKEN`, because that’s where `npm` itself is going to read it from.
-
-2. In order to publish to a different `npm` registry you can specify that inside the `package.json`’s [`publishConfig`](https://docs.npmjs.com/files/package.json#publishconfig) field.
-
-3. If you want to use another dist-tag for your publishes than `'latest'` you can specify that inside the `package.json`’s [`publishConfig`](https://docs.npmjs.com/files/package.json#publishconfig) field.
-
-4. `semantic-release` generally tries to orientate itself towards `npm` – it inherits the loglevel for example.
-
-## Plugins
-
-There are numerous steps where you can customize `semantic-release`’s behaviour using plugins. A plugin is a regular [option](#options), but passed inside the `release` block of `package.json`:
-
-```json
-{
-  "release": {
-    "analyzeCommits": "npm-module-name",
-    "generateNotes": "./path/to/a/local/module",
-    "verifyConditions": {
-      "path": "./path/to/a/module",
-      "additional": "config"
-    }
-  }
-}
-```
-
-```
-semantic-release --analyze-commits="npm-module-name"
-```
-
-A plugin itself is an async function that always receives three arguments.
-
-```js
-module.exports = function (pluginConfig, config, callback) {}
-```
-
-- `pluginConfig`: If the user of your plugin specifies additional plugin config in the `package.json` (see the `verifyConditions` example above) then it’s this object.
-- `config`: A config object containing a lot of information to act upon.
-  - `env`: All environment variables
-  - `npm`: Select npm configuration bits like `registry`, `tag` and `auth`
-  - `options`: `semantic-release` options like `debug`, or `branch`
-  - `pkg`: Parsed `package.json`
-  - For certain plugins the `config` object contains even more information. See below.
-- `callback`: If an error occurs pass it as first argument. Otherwise pass your result as second argument.
-
-
-### `analyzeCommits`
-
-This plugin is responsible for determining the type of the next release. It additionally receives a `commits` array inside `config`. One commit is an object with a `message` and `hash` property. Call the callback with `'major'`, `'premajor'`, `'minor'`, `'preminor'`, `'patch'`, `'prepatch'`, `'prerelease'`, or `null` if nothing changed.
-
-While it may be tempting to use `'prepatch'`, `'preminor'` & `'prerelease'` as part of a release process, this is strongly discouraged. A better approach is to use [dist-tags](https://docs.npmjs.com/cli/dist-tag) to create release channels (such as 'latest', 'next', 'stable') and to return only `'major'`, `'premajor'` and `'minor'` from the commit analyzer.
-
-Have a look at the [default implementation](https://github.com/semantic-release/commit-analyzer/).
-
-### `generateNotes`
-
-This plugin is responsible for generating release notes. Call the callback with the notes as a string. Have a look at the [default implementation](https://github.com/semantic-release/release-notes-generator/).
-It receives a `commits` array, the `lastRelease` and `nextRelease` inside `config`.
-
-### `verifyConditions`
-
-This plugins is responsible for verifying that a release should happen in the first place. For example, the [default implementation](https://github.com/semantic-release/condition-travis/) verifies that the publish is happening on Travis, that it’s the right branch, and that all other build jobs succeeded. There are more use cases for this, e.g. verifying that test coverage is above a certain threshold or that there are no [vulnerabilities](https://nodesecurity.io/) in your dependencies. Be creative.
-
-Passing an array of plugins will run them in series.
-
-### `verifyRelease`
-
-This plugin is responsible for verifying a release that was determined before and is about to be published. There is no default implementation. It additionally receives `nextRelease`, `lastRelease` and `commits` inside `config`. While `commits` is the same as with analyzeCommits, `nextRelease` contains a `type` (e.g. `'major'`) and the new version (e.g. `'1.0.0'`) and `lastRelease` contains the old `version`, the `gitHead` at the time of the release and the npm dist-`tag` (e.g. `'latest'`). Using this information you could [detect breaking changes](https://github.com/semantic-release/cracks) or hold back certain types of releases. Again: Be creative.
-
-Passing an array of plugins will run them in series.
-
-### `getLastRelease`
-
-This plugin is responsible for determining a package’s last release version. The [default implementation](https://github.com/semantic-release/last-release-npm) uses the last published version on a npm registry.
-
-## ITYM*FAQ*LT
-> I think you might frequently ask questions like these
-
-### Why is the `package.json`’s version not updated in my repository?
-
-The `npm` docs even state:
-
-> The most important things in your package.json are the name and version fields. Those are actually required, and your package won’t install without them.
-> – [npm docs](https://docs.npmjs.com/files/package.json#version)
-
-While this entirely true the version number doesn’t have to be checked into source control. `semantic-release` takes care of the version field right before `npm publish` uses it – and this is the only point where it _really_ is required.
-
-### Is there a way to preview which version would currently get published?
-
-If you run `npm run semantic-release` locally a dry run gets performed, which logs the version that would currently get published.
-
-### Can I run this on my own machine rather than on a CI server?
-
-Of course you can, but this doesn’t necessarily mean you should. Running your tests on an independent machine before releasing software is a crucial part of this workflow. Also it is a pain to set this up locally, with tokens lying around and everything. That said, you can run the scripts with `--debug=false` explicitly. You have to export `GH_TOKEN=<your_token>` and `NPM_TOKEN=<your_other_token>`.
-
-### Can I manually trigger the release of a specific version?
-
-You can trigger a release by pushing to your GitHub repository. You deliberately cannot trigger a _specific_ version release, because this is the whole point of `semantic-release`. Start your packages with `1.0.0` and semver on.  
-
-### 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 making every passing feature or fix on your master branch addressable via `npm` you might not treat your master right. Have a look at [branch workflows](https://guides.github.com/introduction/flow/index.html). If you still think you should have control over the exact point in time of your release, e.g. because you are following a release schedule, you can release only on the `production`/`deploy`/`release` branch and push your code there in certain intervals, or better yet use [dist-tags](https://docs.npmjs.com/cli/dist-tag).
-
-### Why should I trust `semantic-release` with my releases?
-
-`semantic-release` has a full unit- and integration-test-suite that tests _actual_ `npm` publishes against the [npm-registry-couchapp](https://github.com/npm/npm-registry-couchapp/). A new version won’t get published if it doesn’t pass on all these engines.
-
-### Why does `semantic-release` require node version >= 8
-
-Being able to write code for just the most recent node versions greatly simplifies development. More language features are available, no transpilation is required, less test builds are to be run, awaited and debugged.
-
-For a special purpose tool like `semantic-release`, that's only meant to be used in controlled CI environments, we think it's okay to have such a high version requirement. As `semantic-release` handles package publishing we expect almost every project to have at least one build job running node 8 already – and that's all it takes. Even if that's not that case `semantic-release` can still be executed with the help of [npx](https://www.npmjs.com/package/npx) (`npx -p node@8 npm run semantic-release`).
+### Commit message format
+
+**semantic-release** uses the commit messages to determine the type of changes in the codebase. Following formalized conventions for commit messages, **semantic-release** automatically determines the next [semantic version](https://semver.org) number, generates a changelog and publishes the release.
+
+By default **semantic-release** uses [Angular Commit Message Conventions](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines). The commit message format can be changed with the [`preset` or `config` options](docs/usage/configuration.md#options) of the [@semantic-release/commit-analyzer](https://github.com/semantic-release/commit-analyzer#options) and [@semantic-release/release-notes-generator](https://github.com/semantic-release/release-notes-generator#options) plugins.
+
+Tools such as [commitizen](https://github.com/commitizen/cz-cli), [commitlint](https://github.com/conventional-changelog/commitlint) or [semantic-git-commit-cli](https://github.com/JPeer264/node-semantic-git-commit-cli) can be used to help contributors and enforce valid commit messages.
+
+Here is an example of the release type that will be done based on a commit messages:
+
+| Commit message                                                                                                                                                                                   | Release type               |
+|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------|
+| `fix(pencil): stop graphite breaking when too much pressure applied`                                                                                                                             | Patch Release              |
+| `feat(pencil): add 'graphiteWidth' option`                                                                                                                                                       | ~~Minor~~ Feature Release  |
+| `perf(pencil): remove graphiteWidth option`<br><br>`BREAKING CHANGE: The graphiteWidth option has been removed.`<br>`The default graphite width of 10mm is always used for performance reasons.` | ~~Major~~ Breaking Release |
+
+### Automation with CI
+
+**semantic-release** is meant to be executed on the CI environment after every successful build on the release branch. This way no human is directly involved in the release process and the releases are guaranteed to be [unromantic and unsentimental](http://sentimentalversioning.org).
+
+### Triggering a 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.
+
+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.
+
+### Release steps
+
+After running the tests, the command `semantic-release` will execute the following steps:
+
+| Step              | Description                                                                                                                     |
+|-------------------|---------------------------------------------------------------------------------------------------------------------------------|
+| Verify Conditions | Verify all the conditions to proceed with the release.                                                                          |
+| 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 based on the commits added since the last release.                                                |
+| Verify release    | Verify the release conformity.                                                                                                  |
+| Generate notes    | Generate release notes 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.                                                                                                            |
+| Publish           | Publish the release.                                                                                                            |
+| Notify            | Notify of new releases or errors.                                                                                               |
+
+## Documentation
+
+- Usage
+  - [Getting started](docs/usage/getting-started.md#getting-started)
+  - [Installation](docs/usage/installation.md#installation)
+  - [CI Configuration](docs/usage/ci-configuration.md#ci-configuration)
+  - [Configuration](docs/usage/configuration.md#configuration)
+  - [Plugins](docs/usage/plugins.md)
+  - [Shareable configurations](docs/usage/shareable-configurations.md)
+- Extending
+  - [Plugins](docs/extending/plugins-list.md)
+  - [Shareable configuration](docs/extending/shareable-configurations-list.md)
+- Recipes
+  - [CI configurations](docs/recipes/README.md)
+  - [Package managers and languages](docs/recipes/README.md)
+- Developer guide
+  - [JavaScript API](docs/developer-guide/js-api.md)
+  - [Plugins](docs/developer-guide/plugin.md)
+  - [Shareable configuration](docs/developer-guide/shareable-configuration.md)
+- Support
+  - [Resources](docs/support/resources.md)
+  - [Frequently Asked Questions](docs/support/FAQ.md)
+  - [Troubleshooting](docs/support/troubleshooting.md)
+  - [Node version requirement](docs/support/node-version.md)
+  - [Node Support Policy](docs/support/node-support-policy.md)
+
+## Get help
+
+- [Stack Overflow](https://stackoverflow.com/questions/tagged/semantic-release)
+- [Spectrum community](https://spectrum.chat/semantic-release)
+- [Twitter](https://twitter.com/SemanticRelease)
 
 ## Badge
 
-Use this in one of your projects? Include one of these badges in your README.md to let people know that your package is published using `semantic-release`.
+Let people know that your package is published using **semantic-release** by including this badge in your readme.
 
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
 
@@ -299,21 +132,12 @@ Use this in one of your projects? Include one of these badges in your README.md
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
 ```
 
-[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=plastic)](https://github.com/semantic-release/semantic-release)
+## Team
 
-```md
-[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=plastic)](https://github.com/semantic-release/semantic-release)
-```
+| [![Stephan Bönnemann](https://github.com/boennemann.png?size=100)](https://github.com/boennemann) | [![Rolf Erik Lekang](https://github.com/relekang.png?size=100)](https://github.com/relekang) | [![Johannes Jörg Schmidt](https://github.com/jo.png?size=100)](https://github.com/jo) | [![Gregor Martynus](https://github.com/gr2m.png?size=100)](https://github.com/gr2m) | [![Pierre Vanduynslager](https://github.com/finnp.png?size=100)](https://github.com/finnp) | [![Pierre Vanduynslager](https://github.com/pvdlg.png?size=100)](https://github.com/pvdlg) | [![Christoph Witzko](https://github.com/christophwitzko.png?size=100)](https://github.com/christophwitzko) |
+|---------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------|
+| [Stephan Bönnemann](https://github.com/boennemann)                                                | [Rolf Erik Lekang](https://github.com/relekang)                                              | [Johannes Jörg Schmidt](https://github.com/jo)                                        | [Gregor Martynus](https://github.com/gr2m)                                          | [Finn Pauls](https://github.com/finnp)                                                     | [Pierre Vanduynslager](https://github.com/pvdlg)                                           | [Christoph Witzko](https://github.com/christophwitzko)                                                     |
 
-[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)](https://github.com/semantic-release/semantic-release)
-
-```md
-[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)](https://github.com/semantic-release/semantic-release)
-```
-
-## License
-
-MIT License
-2015 © Stephan Bönnemann and [contributors](https://github.com/semantic-release/semantic-release/graphs/contributors)
-
-[![](https://cloud.githubusercontent.com/assets/908178/6091690/cc86f58c-aeb8-11e4-94cb-15f15f486cde.png)](https://twitter.com/trodrigues/status/509301317467373571)
+<p align="center">
+  <img alt="Kill all humans" src="media/bender.png">
+</p>

SUMMARY.md

@@ -0,0 +1,34 @@
+# Summary
+
+## Usage
+- [Installation](docs/usage/installation.md#installation)
+- [CI Configuration](docs/usage/ci-configuration.md#ci-configuration)
+- [Configuration](docs/usage/configuration.md#configuration)
+- [Plugins](docs/usage/plugins.md)
+- [Shareable configurations](docs/usage/shareable-configurations.md)
+
+## Extending
+- [Plugins](docs/extending/plugins-list.md)
+- [Shareable configuration](docs/extending/shareable-configurations-list.md)
+
+## Recipes
+- [CI configurations](docs/recipes/README.md)
+	- [CircleCI 2.0 workflows](docs/recipes/circleci-workflows.md)
+	- [Travis CI](docs/recipes/travis.md)
+	- [Travis CI with build stages](docs/recipes/travis-build-stages.md)
+	- [GitLab CI](docs/recipes/gitlab-ci.md)
+- [Git hosted services](docs/recipes/README.md)
+	- [Git authentication with SSH keys](docs/recipes/git-auth-ssh-keys.md)
+- [Package managers and languages](docs/recipes/README.md)
+
+## Developer guide
+- [JavaScript API](docs/developer-guide/js-api.md)
+- [Plugin](docs/developer-guide/plugin.md)
+- [Shareable configuration](docs/developer-guide/shareable-configuration.md)
+
+## Support
+- [Resources](docs/support/resources.md)
+- [Frequently Asked Questions](docs/support/FAQ.md)
+- [Troubleshooting](docs/support/troubleshooting.md)
+- [Node version requirement](docs/support/node-version.md)
+- [Node Support Policy](docs/support/node-support-policy.md)

TROUBLESHOOTING.md

@@ -1,34 +0,0 @@
-# Troubleshooting semantic-release
-
-### ENOTINHISTORY Commit not in history
-
-```
-semantic-release ERR! commits The commit the last release of this package was derived from is not in the direct history of the "master" branch.
-semantic-release ERR! commits This means semantic-release can not extract the commits between now and then.
-semantic-release ERR! commits This is usually caused by force pushing, releasing from an unrelated branch, or using an already existing package name.
-semantic-release ERR! commits You can recover from this error by publishing manually or restoring the commit "123".
-semantic-release ERR! pre Failed to determine new version.
-semantic-release ERR! pre ENOTINHISTORY Commit not in history
-```
-
-To restore semantic-release, follow these steps:
-
-```
-git pull
-git reset --hard origin/master
-npm version x.y.z # check your current version and set this based on semver rules manually
-
-# if you have a PR workflow, create a new branch, otherwise commit to master
-
-git checkout -B chore/release
-git commit -am 'chore: release'
-git push
-
-# merge (not squash-merge) on github (this is important before running git push). This is only required when you work with branches
-git checkout master
-
-# definitely required
-git pull
-git push --tags
-npm publish
-```

bin/semantic-release.js

@@ -3,26 +3,44 @@
 // 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 */
+
 var semver = require('semver');
+var execa = require('execa');
+var findVersions = require('find-versions');
+var pkg = require('../package.json');
 
-if (semver.lt(process.version, '8.0.0')) {
+var MIN_GIT_VERSION = '2.0.0';
+
+if (!semver.satisfies(process.version, pkg.engines.node)) {
   console.error(
-    `semantic-release: node version >= 8 is required. Found ${process.version}.
+    `[semantic-release]: node version ${pkg.engines.node} is required. Found ${process.version}.
 
-If there is another job running on node version >= 8, it will be picked as
-the build leader and you can safely ignore this message.
-
-If you don't have node 8 in your build matrix you can use "npx" to restore
-compatibility with minimal overhead:
-
-$ npx -p node@8 npm run semantic-release
-
-npx is bundled with npm >= 5.4, or available via npm. More info: npm.im/npx`
+See https://github.com/semantic-release/semantic-release/blob/master/docs/support/node-version.md for more details and solutions.`
   );
   process.exit(1);
 }
 
-// node 8+ from this point on
-require('../src/cli')().catch(() => {
-  process.exitCode = 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(error => {
+    console.error(`[semantic-release]: Git version ${MIN_GIT_VERSION} is required. No git binary found.`);
+    console.error(error);
+    process.exit(1);
+  });
+
+// Node 8+ from this point on
+require('../cli')()
+  .then(exitCode => {
+    process.exitCode = exitCode;
+  })
+  .catch(() => {
+    process.exitCode = 1;
+  });

cli.js

@@ -0,0 +1,64 @@
+const {argv, env, stderr} = require('process'); // eslint-disable-line node/prefer-global/process
+const util = require('util');
+const hideSensitive = require('./lib/hide-sensitive');
+
+const stringList = {
+  type: 'string',
+  array: true,
+  coerce: values =>
+    values.length === 1 && values[0].trim() === 'false'
+      ? []
+      : values.reduce((values, value) => values.concat(value.split(',').map(value => value.trim())), []),
+};
+
+module.exports = async () => {
+  const cli = require('yargs')
+    .command('$0', 'Run automated package publishing', yargs => {
+      yargs.demandCommand(0, 0).usage(`Run automated package publishing
+
+Usage:
+  semantic-release [options] [plugins]`);
+    })
+    .option('b', {alias: 'branch', describe: 'Git branch to release from', type: 'string', group: 'Options'})
+    .option('r', {alias: 'repository-url', describe: 'Git repository URL', type: 'string', group: 'Options'})
+    .option('t', {alias: 'tag-format', describe: 'Git tag format', type: 'string', group: 'Options'})
+    .option('p', {alias: 'plugins', describe: 'Plugins', ...stringList, group: 'Options'})
+    .option('e', {alias: 'extends', describe: 'Shareable configurations', ...stringList, group: 'Options'})
+    .option('ci', {describe: 'Toggle CI verifications', type: 'boolean', group: 'Options'})
+    .option('verify-conditions', {...stringList, group: 'Plugins'})
+    .option('analyze-commits', {type: 'string', group: 'Plugins'})
+    .option('verify-release', {...stringList, group: 'Plugins'})
+    .option('generate-notes', {...stringList, group: 'Plugins'})
+    .option('prepare', {...stringList, group: 'Plugins'})
+    .option('publish', {...stringList, group: 'Plugins'})
+    .option('success', {...stringList, group: 'Plugins'})
+    .option('fail', {...stringList, group: 'Plugins'})
+    .option('debug', {describe: 'Output debugging information', type: 'boolean', group: 'Options'})
+    .option('d', {alias: 'dry-run', describe: 'Skip publishing', type: 'boolean', group: 'Options'})
+    .option('h', {alias: 'help', group: 'Options'})
+    .option('v', {alias: 'version', group: 'Options'})
+    .strict(false)
+    .exitProcess(false);
+
+  try {
+    const {help, version, ...opts} = cli.parse(argv.slice(2));
+
+    if (Boolean(help) || Boolean(version)) {
+      return 0;
+    }
+
+    if (opts.debug) {
+      // 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;
+  }
+};

codecov.yml

@@ -1,2 +0,0 @@
-codecov:
-  branch: caribou

docs/README.md

@@ -0,0 +1,7 @@
+# semantic-release documentation
+
+- [Usage](usage/README.md) - **semantic-release** installation and configuration
+- [Extending](extending/README.md)- Extending **semantic-release** with plugins and shareable configurations
+- [Recipes](recipes/README.md) - Community written recipes for common **semantic-release** use-cases
+- [Developer Guide](developer-guide/README.md) - The essentials of writing a **semantic-release** plugin or shareable configurations
+- [Support](support/README.md) - FAQ and troubleshooting

docs/developer-guide/README.md

@@ -0,0 +1,5 @@
+# Developer guide
+
+- [JavaScript API](js-api.md)
+- [Plugins](plugin.md)
+- [Shareable configuration](shareable-configuration.md)

docs/developer-guide/js-api.md

@@ -0,0 +1,270 @@
+# JavaScript API
+
+## Usage
+
+```js
+const semanticRelease = require('semantic-release');
+const {WritableStreamBuffer} = require('stream-buffers');
+
+const stdoutBuffer = WritableStreamBuffer();
+const stderrBuffer = WritableStreamBuffer();
+
+try {
+  const result = await semanticRelease({
+    // Core options
+    branch: 'master',
+    repositoryUrl: 'https://github.com/me/my-package.git',
+    // Shareable config
+    extends: 'my-shareable-config',
+    // Plugin options
+    githubUrl: 'https://my-ghe.com',
+    githubApiPathPrefix: '/api-prefix'
+  }, {
+    // Run semantic-release from `/path/to/git/repo/root` without having to change local process `cwd` with `process.chdir()`
+    cwd: '/path/to/git/repo/root',
+    // Pass the variable `MY_ENV_VAR` to semantic-release without having to modify the local `process.env`
+    env: {...process.env, MY_ENV_VAR: 'MY_ENV_VAR_VALUE'},
+    // Store stdout and stderr to use later instead of writing to `process.stdout` and `process.stderr`
+    stdout: stdoutBuffer,
+    stderr: stderrBuffer
+  });
+
+  if (result) {
+    const {lastRelease, commits, nextRelease, releases} = result;
+
+    console.log(`Published ${nextRelease.type} release version ${nextRelease.version} containing ${commits.length} commits.`);
+
+    if (lastRelease.version) {
+      console.log(`The last release was "${lastRelease.version}".`);
+    }
+
+    for (const release of releases) {
+      console.log(`The release was published with plugin "${release.pluginName}".`);
+    }
+  } else {
+    console.log('No release published.');
+  }
+
+  // Get stdout and stderr content
+  const logs = stdoutBuffer.getContentsAsString('utf8');
+  const errors = stderrBuffer.getContentsAsString('utf8');
+} catch (err) {
+  console.error('The automated release failed with %O', err)
+}
+```
+
+## API
+
+### semanticRelease([options], [config]) => Promise<Result>
+
+Run **semantic-release** and returns a `Promise` that resolves to a [Result](#result) object.
+
+#### options
+
+Type: `Object`
+
+**semantic-release** options.
+
+Can be used to set any [core option](../usage/configuration.md#configuration) or [plugin options](../usage/plugins.md#configuration).
+
+Each option, will take precedence over options configured in the [configuration file](../usage/configuration.md#configuration) and [shareable configurations](../usage/configuration.md#extends).
+
+#### config
+
+Type: `Object`
+
+**semantic-release** configuration specific for API usage.
+
+##### cwd
+
+Type: `String`<br>
+Default: `process.cwd()`
+
+The current working directory to use. It should be configured to the root of the Git repository to release from.
+
+It allows to run **semantic-release** from a specific path without having to change the local process `cwd` with `process.chdir()`.
+
+##### env
+
+Type: `Object`<br>
+Default: `process.env`
+
+The environment variables to use.
+
+It allows to run **semantic-release** with specific environment variables without having to modify the local `process.env`.
+
+##### stdout
+
+Type: [`stream.Writable`](https://nodejs.org/api/stream.html#stream_writable_streams)<br>
+Default: `process.stdout`
+
+The [writable stream](https://nodejs.org/api/stream.html#stream_writable_streams) used to log information.
+
+It allows to configure **semantic-release** to write logs to a specific stream rather than the local `process.stdout`.
+
+##### stderr
+
+Type: [`stream.Writable`](https://nodejs.org/api/stream.html#stream_writable_streams)<br>
+Default: `process.stderr`
+
+The [writable stream](https://nodejs.org/api/stream.html#stream_writable_streams) used to log errors.
+
+It allows to configure **semantic-release** to write errors to a specific stream rather than the local `process.stderr`.
+
+### Result
+
+Type: `Object` `Boolean`<br>
+
+And object with [`lastRelease`](#lastrelease), [`nextRelease`](#nextrelease), [`commits`](#commits) and [`releases`](#releases) if a release is published or `false` if no release was published.
+
+#### lastRelease
+
+Type: `Object`
+
+Information related to the last release found:
+
+| Name    | Type     | Description                                                                                        |
+|---------|----------|----------------------------------------------------------------------------------------------------|
+| version | `String` | The version of the last release.                                                                   |
+| gitHead | `String` | The sha of the last commit being part of the last release.                                         |
+| gitTag  | `String` | The [Git tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging) associated with the last release. |
+
+**Notes**: If no previous release is found, `lastRelease` will be an empty `Object`.
+
+Example:
+```js
+{
+  gitHead: 'da39a3ee5e6b4b0d3255bfef95601890afd80709',
+  version: '1.0.0',
+  gitTag: 'v1.0.0',
+}
+```
+
+#### commits
+
+Type: `Array<Object>`
+
+The list of commit included in the new release.<br>
+Each commit object has the following properties:
+
+| Name            | Type     | Description                                     |
+|-----------------|----------|-------------------------------------------------|
+| commit          | `Object` | The commit abbreviated and full hash.           |
+| commit.long     | `String` | The commit hash.                                |
+| commit.short    | `String` | The commit abbreviated hash.                    |
+| tree            | `Object` | The commit abbreviated and full tree hash.      |
+| tree.long       | `String` | The commit tree hash.                           |
+| tree.short      | `String` | The commit abbreviated tree hash.               |
+| author          | `Object` | The commit author information.                  |
+| author.name     | `String` | The commit author name.                         |
+| author.email    | `String` | The commit author email.                        |
+| author.short    | `String` | The commit author date.                         |
+| committer       | `Object` | The committer information.                      |
+| committer.name  | `String` | The committer name.                             |
+| committer.email | `String` | The committer email.                            |
+| committer.short | `String` | The committer date.                             |
+| subject         | `String` | The commit subject.                             |
+| body            | `String` | The commit body.                                |
+| message         | `String` | The commit full message (`subject` and `body`). |
+| hash            | `String` | The commit hash.                                |
+| committerDate   | `String` | The committer date.                             |
+
+Example:
+```js
+[
+  {
+    commit: {
+      long: '68eb2c4d778050b0701136ca129f837d7ed494d2',
+      short: '68eb2c4'
+    },
+    tree: {
+      long: '7ab515d12bd2cf431745511ac4ee13fed15ab578',
+      short: '7ab515d'
+    },
+    author: {
+      name: 'Me',
+      email: 'me@email.com',
+      date: 2018-07-22T20:52:44.000Z
+    },
+    committer: {
+      name: 'Me',
+      email: 'me@email.com',
+      date: 2018-07-22T20:52:44.000Z
+    },
+    subject: 'feat: a new feature',
+    body: 'Description of the new feature',
+    hash: '68eb2c4d778050b0701136ca129f837d7ed494d2',
+    message: 'feat: a new feature\n\nDescription of the new feature',
+    committerDate: 2018-07-22T20:52:44.000Z
+  }
+ ]
+```
+
+#### nextRelease
+
+Type: `Object`
+
+Information related to the newly published release:
+
+| Name    | Type     | Description                                                                                       |
+|---------|----------|---------------------------------------------------------------------------------------------------|
+| type    | `String` | The [semver](https://semver.org) type of the release (`patch`, `minor` or `major`).               |
+| version | `String` | The version of the new release.                                                                   |
+| gitHead | `String` | The sha of the last commit being part of the new release.                                         |
+| gitTag  | `String` | The [Git tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging) associated with the new release. |
+| notes   | `String` | The release notes for the new release.                                                            |
+
+Example:
+```js
+{
+  type: 'minor',
+  gitHead: '68eb2c4d778050b0701136ca129f837d7ed494d2',
+  version: '1.1.0',
+  gitTag: 'v1.1.0',
+  notes: 'Release notes for version 1.1.0...',
+}
+```
+
+#### releases
+
+Type: `Array<Object>`
+
+The list of releases published, one release per [publish plugin](../usage/plugins.md#publish-plugin).<br>
+Each release object has the following properties:
+
+| Name       | Type     | Description                                                                                   |
+|------------|----------|-----------------------------------------------------------------------------------------------|
+| name       | `String` | **Optional.** The release name, only if set by the corresponding `publish` plugin.            |
+| url        | `String` | **Optional.** The release URL, only if set by the corresponding `publish` plugin.             |
+| type       | `String` | The [semver](https://semver.org) type of the release (`patch`, `minor` or `major`).           |
+| version    | `String` | The version of the release.                                                                   |
+| gitHead    | `String` | The sha of the last commit being part of the release.                                         |
+| gitTag     | `String` | The [Git tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging) associated with the release. |
+| notes      | `String` | The release notes for the release.                                                            |
+| pluginName | `String` | The name of the plugin that published the release.                                            |
+
+Example:
+```js
+[
+  {
+    name: 'GitHub release',
+    url: 'https://github.com/me/my-package/releases/tag/v1.1.0',
+    type: 'minor',
+    gitHead: '68eb2c4d778050b0701136ca129f837d7ed494d2',
+    version: '1.1.0',
+    gitTag: 'v1.1.0',
+    notes: 'Release notes for version 1.1.0...',
+    pluginName: '@semantic-release/github'
+  },
+  {
+    name: 'npm package (@latest dist-tag)',
+    url: 'https://www.npmjs.com/package/my-package',
+    type: 'minor',
+    gitHead: '68eb2c4d778050b0701136ca129f837d7ed494d2',
+    version: '1.1.0',
+    gitTag: 'v1.1.0',
+    notes: 'Release notes for version 1.1.0...',
+    pluginName: '@semantic-release/npm'
+   }
+ ]
+```

docs/developer-guide/plugin.md

@@ -0,0 +1 @@
+# Plugin developer guide

docs/developer-guide/shareable-configuration.md

@@ -0,0 +1 @@
+# Shareable configuration developer guide

docs/extending/README.md

@@ -0,0 +1,4 @@
+# Extending semantic-release
+
+- [Plugins list](plugins-list.md)
+- [Shareable configuration list](shareable-configurations-list.md)

docs/extending/plugins-list.md

@@ -0,0 +1,93 @@
+# Plugins list
+
+## Official plugins
+- [@semantic-release/commit-analyzer](https://github.com/semantic-release/commit-analyzer)
+  - **Note**: this is already part of semantic-release and does not have to be installed separately
+  - `analyzeCommits`: Determine the type of release by analyzing commits with [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog)
+- [@semantic-release/release-notes-generator](https://github.com/semantic-release/release-notes-generator)
+  - **Note**: this is already part of semantic-release and does not have to be installed separately
+  - `generateNotes`: Generate release notes for the commits added since the last release with [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog)
+- [@semantic-release/github](https://github.com/semantic-release/github)
+  - **Note**: this is already part of semantic-release and does not have to be installed separately
+  - `verifyConditions`: Verify the presence and the validity of the GitHub authentication and release configuration
+  - `publish`: Publish a [GitHub release](https://help.github.com/articles/about-releases)
+  - `success`: Add a comment to GitHub issues and pull requests resolved in the release
+  - `fail`: Open a GitHub issue when a release fails
+- [@semantic-release/npm](https://github.com/semantic-release/npm)
+  - **Note**: this is already part of semantic-release and does not have to be installed separately
+  - `verifyConditions`: Verify the presence and the validity of the npm authentication and release configuration
+  - `prepare`: Update the package.json version and create the npm package tarball
+  - `publish`: Publish the package on the npm registry
+- [@semantic-release/gitlab](https://github.com/semantic-release/gitlab)
+  - `verifyConditions`: Verify the presence and the validity of the GitLab authentication and release configuration
+  - `publish`: Publish a [GitLab release](https://docs.gitlab.com/ce/workflow/releases.html)
+- [@semantic-release/git](https://github.com/semantic-release/git)
+  - `verifyConditions`: Verify the presence and the validity of the Git authentication and release configuration
+  - `prepare`: Push a release commit and tag, including configurable files
+- [@semantic-release/changelog](https://github.com/semantic-release/changelog)
+  - `verifyConditions`: Verify the presence and the validity of the configuration
+  - `prepare`: Create or update the changelog file in the local project repository
+- [@semantic-release/exec](https://github.com/semantic-release/exec)
+  - `verifyConditions`: Execute a shell command to verify if the release should happen
+  - `analyzeCommits`: Execute a shell command to determine the type of release
+  - `verifyRelease`: Execute a shell command to verifying a release that was determined before and is about to be published
+  - `generateNotes`: Execute a shell command to generate the release note
+  - `prepare`: Execute a shell command to prepare the release
+  - `publish`: Execute a shell command to publish the release
+  - `success`: Execute a shell command to notify of a new release
+  - `fail`: Execute a shell command to notify of a failed release
+- [@semantic-release/apm](https://github.com/semantic-release/apm)
+  - `verifyConditions`: Verify the presence of the `ATOM_ACCESS_TOKEN` environment variable and the [`apm`](https://github.com/atom/apm) CLI
+  - `prepare`: Update the `package.json` version with [`npm version`](https://docs.npmjs.com/cli/version)
+  - `publish`: Publish the [Atom package](https://flight-manual.atom.io/hacking-atom/sections/publishing)
+
+## Community plugins
+
+[Open a Pull Request](https://github.com/semantic-release/semantic-release/blob/master/CONTRIBUTING.md#submitting-a-pull-request) to add your plugin to the list.
+
+- [semantic-release-slack-bot](https://github.com/juliuscc/semantic-release-slack-bot)
+  - `verifyConditions`: Verify that the environment variable `SLACK_WEBHOOK` has been defined.
+  - `success`: Publish a message about the success to a slack channel.
+  - `fail`: Optionally publish a message about failure to a slack channel.
+- [semantic-release-docker](https://github.com/felixfbecker/semantic-release-docker)
+  - `verifyConditions`: Verify that all needed configuration is present and login to the Docker registry.
+  - `publish`: Tag the image specified by `name` with the new version, push it to Docker Hub and update the latest tag
+- [semantic-release-gcr](https://github.com/carlos-cubas/semantic-release-gcr)
+  - `verifyConditions`: Verify that all needed configuration is present and login to the Docker registry
+  - `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)
+  - `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`: Check the dependencies format against a regexp before a release
+- [semantic-release-chrome](https://github.com/GabrielDuarteM/semantic-release-chrome)
+  - `verifyConditions`: Verify the presence of the authentication (set via environment variables)
+  - `prepare`: Write the correct version to the `manifest.json` and creates a zip file of the whole dist folder
+  - `publish`: Uploads the generated zip file to the webstore, and publish the item
+- [semantic-release-firefox](https://github.com/felixfbecker/semantic-release-firefox)
+  - `verifyConditions`: Verify the presence of the authentication (set via environment variables)
+  - `prepare`: Write the correct version to the `manifest.json`, creates a `xpi` file of the dist folder and a zip of the sources
+  - `publish`: Submit the generated archives to the webstore for review, and publish the item including release notes
+- [semantic-release-gerrit](https://github.com/pascalMN/semantic-release-gerrit)
+  - `generateNotes`: Generate release notes with Gerrit reviews URL
+- [semantic-release-expo](https://github.com/bycedric/semantic-release-expo)
+  - `verifyConditions`: Verify Expo manifest(s) are readable and valid.
+  - `prepare`: Update version, ios build number and android version code in the Expo manifest(s).
+- [maven-semantic-release](https://github.com/conveyal/maven-semantic-release)
+  - `verifyConditions`: Verifies that the `pom.xml` file and other files exist and are setup to allow releases
+  - `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
+- [gradle-semantic-release](https://github.com/KengoTODA/gradle-semantic-release-plugin)
+  - `verifyConditions`: Verify that project has a Gradle wrapper script, and `build.gradle` contains a task to publish artifacts.
+  - `prepare`: Changes the version number in the `gradle.properties`
+  - `publish`: Triggers Gradle to publish artifacts.
+- [semantic-release-circleci-orb](https://github.com/matt-oakes/semantic-release-circleci-orb)
+  - `verifyConditions`: Verify the presence of the `CIRCLECI_API_TOKEN` environment variable, `orbName` option, and the `circleci` CLI.
+  - `publish`: Publish the CircleCI orb.
+- [semantic-release-github-pages](https://github.com/qiwi/semantic-release-gh-pages-plugin)
+  - `verifyConditions`: Verify the presence of the auth token set via environment variables.
+  - `publish`: Pushes commit to the documentation branch.

docs/extending/shareable-configurations-list.md

@@ -0,0 +1,7 @@
+# Shareable configurations list
+
+## Official configurations
+- [@semantic-release/apm-config](https://github.com/semantic-release/apm-config) - semantic-release shareable configuration for releasing atom packages
+- [@semantic-release/gitlab-config](https://github.com/semantic-release/gitlab-config) - semantic-release shareable configuration for GitLab
+
+## Community configurations

docs/recipes/README.md

@@ -0,0 +1,11 @@
+# Recipes
+
+## CI configurations
+- [CircleCI 2.0 workflows](circleci-workflows.md)
+- [Travis CI](travis.md)
+- [GitLab CI](gitlab-ci.md)
+
+## Git hosted services
+- [Git authentication with SSH keys](git-auth-ssh-keys.md)
+
+## Package managers and languages

docs/recipes/circleci-workflows.md

@@ -0,0 +1,65 @@
+# Using semantic-release with [CircleCI 2.0 workflows](https://circleci.com/docs/2.0/workflows)
+
+## Environment variables
+
+The [Authentication](../usage/ci-configuration.md#authentication) environment variables can be configured in [CircleCi Project Settings](https://circleci.com/docs/2.0/env-vars/#adding-environment-variables-in-the-app)..
+
+Alternatively, the default `NPM_TOKEN` and `GH_TOKEN` can be easily [setup with semantic-release-cli](../usage/getting-started.md#getting-started).
+
+## Multiple Node jobs configuration
+
+### `.circleci/config.yml` configuration for multiple Node jobs
+
+This example is a minimal configuration for **semantic-release** with a build running Node 6 and 8. See [CircleCI documentation](https://circleci.com/docs/2.0) for additional configuration options.
+
+This example create the workflows `test_node_4`, `test_node_6`, `test_node_8` and `release`. The release workflows will [run `semantic-release` only after the all the `test_node_*` are successful](../usage/ci-configuration.md#run-semantic-release-only-after-all-tests-succeeded).
+
+```yaml
+version: 2
+jobs:
+  test_node_6:
+    docker:
+      - image: circleci/node:6
+    steps:
+      # Configure your test steps here (checkout, npm install, cache management, tests etc...)
+
+  test_node_8:
+    docker:
+      - image: circleci/node:8
+    steps:
+      # Configure your test steps here (checkout, npm install, cache management, tests etc...)
+
+  release:
+    docker:
+      - image: circleci/node:8
+    steps:
+      - checkout
+      - run: npm install
+      # Run optional required steps before releasing
+      # - run: npm run build-script
+      - run: npx semantic-release
+
+workflows:
+  version: 2
+  test_and_release:
+    # Run the test jobs first, then the release only when all the test jobs are successful
+    jobs:
+      - test_node_6
+      - test_node_8
+      - release:
+          requires:
+            - test_node_6
+            - test_node_8
+```
+
+### `package.json` configuration for multiple Node jobs
+
+A `package.json` is required only for [local](../usage/installation.md#local-installation) **semantic-release** installation.
+
+```json
+{
+  "devDependencies": {
+    "semantic-release": "^15.0.0"
+  }
+}
+```

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

@@ -0,0 +1,163 @@
+# Git authentication with SSH keys
+
+When using [environment variables](../usage/ci-configuration.md#authentication) to set up the Git authentication, the remote Git repository will automatically be accessed via [https](https://git-scm.com/book/en/v2/Git-on-the-Server-The-Protocols#_the_http_protocols), independently of the [`repositoryUrl`](../usage/configuration.md#repositoryurl) format configured in the **semantic-release** [Configuration](../usage/configuration.md#configuration) (the format will be automatically converted as needed).
+
+Alternatively the Git repository can be accessed via [SSH](https://git-scm.com/book/en/v2/Git-on-the-Server-The-Protocols#_the_ssh_protocol) by creating SSH keys, adding the public one to your Git hosted account and making the private one available on the CI environment.
+
+**Note:** SSH keys allow to push the [Git release tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging) associated to the released version. Some plugins might also require an API token. See each plugin documentation for additional information.
+
+## Generating the SSH keys
+
+In your local repository root:
+
+```bash
+$ ssh-keygen -t rsa -b 4096 -C "<your_email>" -f git_deploy_key -N "<ssh_passphrase>"
+```
+
+`your_email` must be the email associated with your Git hosted account. `ssh_passphrase` must be a long and hard to guess string. It will be used later.
+
+This will generate a public key in `git_deploy_key.pub` and a private key in `git_deploy_key`.
+
+## Adding the SSH public key to the Git hosted account
+
+Step by step instructions are provided for the following Git hosted services:
+- [GitHub](#adding-the-ssh-public-key-to-github)
+
+### Adding the SSH public key to GitHub
+
+Open the `git_deploy_key.pub` file (public key) and copy the entire content.
+
+In GitHub **Settings**, click on **SSH and GPG keys** in the sidebar, then on the **New SSH Key** button.
+
+Paste the entire content of `git_deploy_key.pub` file (public key) and click the **Add SSH Key** button.
+
+Delete the `git_deploy_key.pub` file:
+
+```bash
+$ rm git_deploy_key.pub
+```
+
+See [Adding a new SSH key to your GitHub account](https://help.github.com/articles/adding-a-new-ssh-key-to-your-github-account/) for more details.
+
+## Adding the SSH private key to the CI environment
+
+In order to be available on the CI environment, the SSH private key must be encrypted, committed to the Git repository and decrypted by the CI service.
+
+Step by step instructions are provided for the following environments:
+- [Travis CI](#adding-the-ssh-private-key-to-travis-ci)
+- [Circle CI](#adding-the-ssh-private-key-to-circle-ci)
+
+### Adding the SSH private key to Travis CI
+
+Install the [Travis CLI](https://github.com/travis-ci/travis.rb#installation):
+
+```bash
+$ gem install travis
+```
+
+[Login](https://github.com/travis-ci/travis.rb#login) to Travis with the CLI:
+
+```bash
+$ travis login
+```
+
+Add the [environment](https://github.com/travis-ci/travis.rb#env) variable `SSH_PASSPHRASE` to Travis with the value set during the [SSH keys generation](#generating-the-ssh-keys) step:
+
+```bash
+$ travis env set SSH_PASSPHRASE <ssh_passphrase>
+```
+
+[Encrypt](https://github.com/travis-ci/travis.rb#encrypt) the `git_deploy_key` (private key) using a symmetric encryption (AES-256), and store the secret in a secure environment variable in the Travis environment:
+
+```bash
+$ travis encrypt-file git_deploy_key
+```
+
+The `travis encrypt-file` will encrypt the private key into the `git_deploy_key.enc` file and output in the console the command to add to your `.travis.yml` file. It should look like `openssl aes-256-cbc -K $encrypted_KKKKKKKKKKKK_key -iv $encrypted_VVVVVVVVVVVV_iv -in git_deploy_key.enc -out git_deploy_key -d`.
+
+Copy this command to your `.travis.yml` file in the `before_install` step. Change the output path to write the unencrypted key in `/tmp`: `-out git_deploy_key` => `/tmp/git_deploy_key`. This will avoid to commit / modify / delete the unencrypted key by mistake on the CI. Then add the commands to decrypt the ssh private key and make it available to `git`:
+
+```yaml
+before_install:
+  # Decrypt the git_deploy_key.enc key into /tmp/git_deploy_key
+  - openssl aes-256-cbc -K $encrypted_KKKKKKKKKKKK_key -iv $encrypted_VVVVVVVVVVVV_iv -in git_deploy_key.enc -out /tmp/git_deploy_key -d
+  # Make sure only the current user can read the private key
+  - chmod 600 /tmp/git_deploy_key
+  # Create a script to return the passphrase environment variable to ssh-add
+  - echo 'echo ${SSH_PASSPHRASE}' > /tmp/askpass && chmod +x /tmp/askpass
+  # Start the authentication agent
+  - eval "$(ssh-agent -s)"
+  # Add the key to the authentication agent
+  - DISPLAY=":0.0" SSH_ASKPASS="/tmp/askpass" setsid ssh-add /tmp/git_deploy_key </dev/null
+```
+
+See [Encrypting Files](https://docs.travis-ci.com/user/encrypting-files) for more details.
+
+Delete the local private key as it won't be used anymore:
+
+```bash
+$ rm git_deploy_key
+```
+
+Commit the encrypted private key and the `.travis.yml` file to your repository:
+
+```bash
+$ git add git_deploy_key.enc .travis.yml
+$ git commit -m "ci(travis): Add the encrypted private ssh key"
+$ git push
+```
+
+### Adding the SSH private key to Circle CI
+
+First we encrypt the `git_deploy_key` (private key) using a symmetric encryption (AES-256).  Run the following `openssl` command and *make sure to note the output which we'll need later*:
+
+```bash
+$ openssl aes-256-cbc -e -p -in git_deploy_key -out git_deploy_key.enc -K `openssl rand -hex 32` -iv `openssl rand -hex 16`
+salt=SSSSSSSSSSSSSSSS
+key=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK
+iv =VVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVV
+```
+
+Add the following [environment variables](https://circleci.com/docs/2.0/env-vars/#adding-environment-variables-in-the-app) to Circle CI:
+- `SSL_PASSPHRASE` - the value set during the [SSH keys generation](#generating-the-ssh-keys) step.
+- `REPO_ENC_KEY` - the `key` (KKK) value from the `openssl` step above.
+- `REPO_ENC_IV` - the `iv` (VVV) value from the `openssl` step above.
+
+Then add to your `.circleci/config.yml` the commands to decrypt the ssh private key and make it available to `git`:
+
+```yaml
+version: 2
+jobs:
+  coverage_test_publish:
+    # docker, working_dir, etc
+    steps:
+      - run:
+          # Decrypt the git_deploy_key.enc key into /tmp/git_deploy_key
+          - openssl aes-256-cbc -d -K $REPO_ENC_KEY -iv $REPO_ENC_IV -in git_deploy_key.enc -out /tmp/git_deploy_key
+          # Make sure only the current user can read the private key
+          - chmod 600 /tmp/git_deploy_key
+          # Create a script to return the passphrase environment variable to ssh-add
+          - echo 'echo ${SSL_PASSPHRASE}' > /tmp/askpass && chmod +x /tmp/askpass
+          # Start the authentication agent
+          - eval "$(ssh-agent -s)"
+          # Add the key to the authentication agent
+          - DISPLAY=":0.0" SSH_ASKPASS="/tmp/askpass" setsid ssh-add /tmp/git_deploy_key </dev/null
+      # checkout, restore_cache, run: yarn install, save_cache, etc.
+      # Run semantic-release after all the above is set.
+```
+
+The unencrypted key is written to `/tmp` to avoid to commit / modify / delete the unencrypted key by mistake on the CI environment.
+
+Delete the local private key as it won't be used anymore:
+
+```bash
+$ rm git_deploy_key
+```
+
+Commit the encrypted private key and the `.circleci/config.yml` file to your repository:
+
+```bash
+$ git add git_deploy_key.enc .circleci/config.yml
+$ git commit -m "ci(circle): Add the encrypted private ssh key"
+$ git push
+```

docs/recipes/gitlab-ci.md

@@ -0,0 +1,57 @@
+# Using semantic-release with [GitLab CI](https://about.gitlab.com/features/gitlab-ci-cd)
+
+## Environment variables
+
+The [Authentication](../usage/ci-configuration.md#authentication) environment variables can be configured with [Secret variables](https://docs.gitlab.com/ce/ci/variables/README.html#secret-variables).
+
+## Node project configuration
+
+GitLab CI supports [Pipelines](https://docs.gitlab.com/ee/ci/pipelines.html) allowing to test on multiple Node versions and publishing a release only when all test pass.
+
+**Note**: The publish pipeline must run a [Node >= 8 version](../support/FAQ.md#why-does-semantic-release-require-node-version--83).
+
+### `.gitlab-ci.yml` configuration for Node projects
+
+This example is a minimal configuration for **semantic-release** with a build running Node 6 and 8. See [GitLab CI - Configuration of your jobs with .gitlab-ci.yml](https://docs.gitlab.com/ee/ci/yaml/README.html) for additional configuration options.
+
+**Note**: The`semantic-release` execution command varies depending if you are using a [local](../usage/installation.md#local-installation) or [global](../usage/installation.md#global-installation) **semantic-release** installation.
+
+```yaml
+# The release pipeline will run only if all jobs in the test pipeline are successful
+stages:
+    - test
+    - release
+
+before_script:
+  - npm install
+
+node:6:
+  image: node:6
+  stage: test
+  script:
+    - npm test
+
+node:8:
+  image: node:8
+  stage: test
+  script:
+    - npm test
+
+publish:
+  image: node:8
+  stage: release
+  script:
+    - npx semantic-release
+```
+
+### `package.json` configuration
+
+A `package.json` is required only for [local](../usage/installation.md#local-installation) **semantic-release** installation.
+
+```json
+{
+  "devDependencies": {
+    "semantic-release": "^15.0.0"
+  }
+}
+```

docs/recipes/travis.md

@@ -0,0 +1,95 @@
+# Using semantic-release with [Travis CI](https://travis-ci.org)
+
+## Environment variables
+
+The [Authentication](../usage/ci-configuration.md#authentication) environment variables can be configured in [Travis Repository Settings](https://docs.travis-ci.com/user/environment-variables/#defining-variables-in-repository-Settings) or with the [travis env set CLI](https://github.com/travis-ci/travis.rb#env).
+
+Alternatively, the default `NPM_TOKEN` and `GH_TOKEN` can be easily [setup with semantic-release-cli](../usage/getting-started.md#getting-started).
+
+## Node.js projects configuration
+
+### `.travis.yml` configuration for multiple Node.js jobs
+
+This example is a minimal configuration for **semantic-release** with a build running Node 6 and 8. See [Travis - Customizing the Build](https://docs.travis-ci.com/user/customizing-the-build) for additional configuration options.
+
+This example creates a `release` [build stage](https://docs.travis-ci.com/user/build-stages) that [runs `semantic-release` only after all test jobs are successful](../usage/ci-configuration.md#run-semantic-release-only-after-all-tests-succeeded).
+
+It's recommended to run the `semantic-release` command in the [Travis `deploy` step](https://docs.travis-ci.com/user/customizing-the-build/#The-Build-Lifecycle) so if an error occurs the build will fail and Travis will send a notification.
+
+**Note**: It's not recommended to run the `semantic-release` command in the Travis `script` step as each script in this step will be executed regardless of the outcome of the previous one. See [travis-ci/travis-ci#1066](https://github.com/travis-ci/travis-ci/issues/1066).
+
+**Advanced configuration**: Running the tests in the `script` step of the `release` stage is not necessary as the previous stage(s) already ran them. To increase speed, the `script` step of the `release` stage can be overwritten to skip the tests. Note that other commands such as build or compilation might still be required.
+
+```yaml
+language: node_js
+
+node_js:
+  - 8
+  - 6
+
+jobs:
+  include:
+    # Define the release stage that runs semantic-release
+    - stage: release
+      node_js: lts/*
+      # Advanced: optionally overwrite your default `script` step to skip the tests
+      # script: skip
+      deploy:
+        provider: script
+        skip_cleanup: true
+        script:
+          - npx semantic-release
+```
+
+### `package.json` configuration for multiple Node jobs
+
+A `package.json` is required only for [local](../usage/installation.md#local-installation) **semantic-release** installation.
+
+```json
+{
+  "devDependencies": {
+    "semantic-release": "^15.0.0"
+  }
+}
+```
+
+## Non-Node.js projects configuration
+
+For projects that require to be tested with one or multiple version of a Non-JavaScript [language](https://docs.travis-ci.com/user/languages), optionally on multiple [Operating Systems](https://docs.travis-ci.com/user/multi-os).
+
+This recipe cover the Travis specifics only. See [Non JavaScript projects recipe](../support/FAQ.md#can-i-use-semantic-release-to-publish-non-javascript-packages) for more information on the **semantic-release** configuration.
+
+### `.travis.yml` configuration for non-JavaScript projects
+
+This example is a minimal configuration for **semantic-release** with a build running [Go 1.6 and 1.7](https://docs.travis-ci.com/user/languages/go). See [Travis - Customizing the Build](https://docs.travis-ci.com/user/customizing-the-build) for additional configuration options.
+
+This example creates a `release` [build stage](https://docs.travis-ci.com/user/build-stages) that [runs `semantic-release` only after all test jobs are successful](../usage/ci-configuration.md#run-semantic-release-only-after-all-tests-succeeded).
+
+It's recommended to run the `semantic-release` command in the [Travis `deploy` step](https://docs.travis-ci.com/user/customizing-the-build/#The-Build-Lifecycle) so if an error occurs the build will fail and Travis will send a notification.
+
+**Note**: It's not recommended to run the `semantic-release` command in the Travis `script` step as each script in this step will be executed regardless of the outcome of the previous one. See [travis-ci/travis-ci#1066](https://github.com/travis-ci/travis-ci/issues/1066).
+
+**Advanced configuration**: Running the tests in the `script` step of the `release` stage is not necessary as the previous stage(s) already ran them. To increase speed, the `script` step of the `release` stage can be overwritten to skip the tests. Note that other commands such as build or compilation might still be required.
+
+```yaml
+language: go
+
+go:
+  - 1.6
+  - 1.7
+
+jobs:
+  include:
+    # Define the release stage that runs semantic-release
+    - stage: release
+      # Advanced: optionally overwrite your default `script` step to skip the tests
+      # script:
+      #   - make
+      deploy:
+        provider: script
+        skip_cleanup: true
+        script:
+          # Use nvm to install and use the Node LTS version (nvm is installed on all Travis images)
+          - nvm install lts/*
+          - npx semantic-release
+```

docs/support/FAQ.md

@@ -0,0 +1,245 @@
+# Frequently Asked Questions
+
+## Why is the `package.json`’s version not updated in my repository?
+
+**semantic-release** takes care of updating the `package.json`’s version before publishing to [npm](https://www.npmjs.com).
+
+By default, only the published package will contains the version, which is the only place where it is *really* required, but the updated `package.json` will not be pushed to the Git repository
+
+However, the [`@semantic-release/git`](https://github.com/semantic-release/git) plugin can be used to push the updated `package.json` as well as other files to the Git repository.
+
+## How can I use a npm build script that requires the `package.json`’s version ?
+
+The `package.json`’s version will be updated by the `semantic-release` command just before publishing to [npm](https://www.npmjs.com), therefore it won't be available for scripts ran before the `semantic-release` command.
+
+As the [`@semantic-release/npm`](https://github.com/semantic-release/npm) plugin uses the [npm CLI](https://docs.npmjs.com/cli/npm) to update the `package.json` version and publish the package, all [npm hook scripts](https://docs.npmjs.com/misc/scripts#description) will be executed.
+
+You can run your build script in:
+- the `prepublishOnly` or `prepack` hook so it will be executed during the `publish` step of `@semantic-release/npm`
+- the `postversion` hook so it will be executed during the `prepare` step of `@semantic-release/npm`, which allow for example to update files before committing them with the [`@semantic-release/git`](https://github.com/semantic-release/git) plugin
+
+If using npm hook scripts is not possible, and alternative solution is to [`@semantic-release/exec`](https://github.com/semantic-release/exec) plugin to run your script in the `prepare` step:
+```json
+{
+  "plugins": [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    "@semantic-release/npm",
+    ["@semantic-release/exec", {
+      "prepareCmd": "./my-build-script.sh ${nextRelease.version}",
+    }],
+  ]
+}
+```
+
+## Is there a way to preview which version would currently get published?
+
+Yes with the [dry-run options](../usage/configuration.md#dryrun) which prints to the console the next version to be published and the release notes.
+
+## Can I use semantic-release with Yarn?
+
+If you are using a [local](../usage/installation.md#local-installation) **semantic-release** installation and run multiple CI jobs with different versions, the `yarn install` command will fail on jobs running with Node < 8 as **semantic-release** requires [Node >= 8.3](#why-does-semantic-release-require-node-version--83) and specifies it in its `package.json`s [`engines`](https://docs.npmjs.com/files/package.json#engines) key.
+
+The recommended solution is to use the [Yarn](https://yarnpkg.com) [--ignore-engines](https://yarnpkg.com/en/docs/cli/install#toc-yarn-install-ignore-engines) option to install the project dependencies on the CI environment, so Yarn will ignore the **semantic-release**'s `engines` key:
+
+```bash
+$ yarn install --ignore-engines
+```
+
+**Note**: Several CI services use Yarn by default if your repository contains a `yarn.lock` file. So you should override the install step to specify `yarn install --ignore-engines`.
+
+Alternatively you can use a [global](../usage/installation.md#global-installation) **semantic-release** installation and make sure to install and run the `semantic-release` command only in a CI jobs running with Node >= 8.3.
+
+If your CI environment provides [nvm](https://github.com/creationix/nvm) you can switch to Node 8 before installing and running the `semantic-release` command:
+
+```bash
+$ nvm install 8 && yarn global add semantic-release && semantic-release
+```
+
+See the [CI configuration recipes](../recipes/README.md#ci-configurations) for more details on specific CI environments.
+
+As `semantic-release` is recommended to be executed with [`npx`](https://www.npmjs.com/package/npx) an alternative is required for usage with Yarn. Even though it is possible to install npx with Yarn, it's not recommended. Yarn and npx would be using different cache locations.
+
+For [local installation](../usage/installation.md#local-installation) replace
+`npx semantic-release` with `yarn run semantic-release`.
+
+For [global installation](../usage/installation.md#global-installation) replace
+`npx semantic-release` with `yarn global add semantic-release && semantic-release`.
+
+## Can I use semantic-release to publish non-JavaScript packages?
+
+Yes, **semantic-release** is a Node CLI application but it can be used to publish any type of packages.
+
+To publish a non-Node package (without a `package.json`) you would need to:
+- Use a [global](../usage/installation.md#global-installation) **semantic-release** installation
+- Set **semantic-release** [options](../usage/configuration.md#options) via [CLI arguments or rc file](../usage/configuration.md#configuration)
+- Make sure your CI job executing the `semantic-release` command has access to [Node >= 8](#why-does-semantic-release-require-node-version--83) to execute the `semantic-release` command
+
+See the [CI configuration recipes](../recipes/README.md#ci-configurations) for more details on specific CI environments.
+
+In addition you will need to configure the **semantic-release** [plugins](../usage/plugins.md#plugins) to disable the [`@semantic-release/npm`](https://github.com/semantic-release/npm) plugin which is used by default and use a plugin for your project type.
+
+If there is no specific plugin for your project type you can use the [`@semantic-release/exec`](https://github.com/semantic-release/exec) plugin to publish the release with a shell command.
+
+Here is a basic example to create [GitHub releases](https://help.github.com/articles/about-releases) and use a shell command to publish:
+
+```json
+{
+  "plugins": [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    "@semantic-release/github",
+    ["@semantic-release/exec", {
+      "prepareCmd" : "set-version ${nextRelease.version}",
+      "publishCmd" : "publish-package"
+      }]
+  ]
+}
+```
+
+**Note**: This is a theoretical example where the command `set-version` update the project version with the value passed as its first argument and `publish-package` publishes the package to a registry.
+
+See the [package managers and languages recipes](../recipes/README.md#package-managers-and-languages) for more details on specific project types.
+
+## Can I use semantic-release with any CI service?
+
+Yes, **semantic-release** can be used with any CI service, as long as it provides:
+- A way to set [authentication](../usage/ci-configuration.md#authentication) via environment variables
+- A way to guarantee that the `semantic-release` command is [executed only after all the tests of all the jobs in the CI build pass](../usage/ci-configuration.md#run-semantic-release-only-after-all-tests-succeeded)
+
+See the [CI configuration recipes](../recipes/README.md#ci-configurations) for more details on specific CI environments.
+
+## 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#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
+```
+
+However this is not the recommended approach, as running unit and integration tests on an independent machine before publishing software is a crucial part of the release workflow.
+
+## Can I use semantic-release with GitLab?
+
+Yes, with the [`@semantic-release/gitlab-config`](https://github.com/semantic-release/gitlab-config) shareable configuration.
+
+See the [GitLab CI recipes](../recipes/gitlab-ci.md#using-semantic-release-with-gitlab-ci) for the CI configuration.
+
+## Can I use semantic-release with any Git hosted environment?
+
+By default **semantic-release** uses the [`@semantic-release/github`](https://github.com/semantic-release/github) plugin to publish a [GitHub release](https://help.github.com/articles/about-releases). For other Git hosted environment the  [`@semantic-release/git`](https://github.com/semantic-release/git) and [`@semantic-release/changelog`](https://github.com/semantic-release/changelog) plugins can be used via [plugins configuration](../usage/plugins.md).
+
+See the [`@semantic-release/git`](https://github.com/semantic-release/git#semantic-releasegit) [`@semantic-release/changelog`](https://github.com/semantic-release/changelog#semantic-releasechangelog) plugins documentation for more details.
+
+## Can I skip the release to the npm registry?
+
+Yes, the publishing to the npm registry can be disabled with the [`npmPublish`](https://github.com/semantic-release/npm#options) option of the [`@semantic-release/npm`](https://github.com/semantic-release/npm) plugin. In addition the [`tarballDir`](https://github.com/semantic-release/npm#options) option allow to generate the package tarball in order to publish it to your repository with the [`@semantic-release/git`](https://github.com/semantic-release/git) or to a [GitHub release](https://help.github.com/articles/about-releases) with the [`@semantic-release/github`](https://github.com/semantic-release/github) plugin.
+
+See the [`@semantic-release/npm`](https://github.com/semantic-release/npm#semantic-releasenpm) plugin documentation for more details.
+
+## How can I revert a release?
+
+If you have introduced a breaking bug in a release you have 2 options:
+- If you have a fix immediately ready, commit and push it (or merge it via a pull request) to the release branch
+- Otherwise [revert the commit](https://git-scm.com/docs/git-revert) that introduced the bug and push the revert commit (or merge it via a pull request) to the release branch
+
+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 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.
+
+**Note**: If you are using the default [Angular Commit Message Conventions](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines) be aware that it uses a different revert commit format than the standard one created by [git revert](https://git-scm.com/docs/git-revert), contrary to what is [claimed in the  convention](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#revert). Therefore, if you revert a commit with [`git revert`](https://git-scm.com/docs/git-revert), use the [`--edit` option](https://git-scm.com/docs/git-revert#git-revert---edit) to format the message according to the [Angular revert commit message format](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#revert). See [conventional-changelog/conventional-changelog#348](https://github.com/conventional-changelog/conventional-changelog/issues/348) for more details.
+
+## Can I use `.npmrc` options?
+
+Yes, all the [npm configuration options](https://docs.npmjs.com/misc/config) are supported via the [`.npmrc`](https://docs.npmjs.com/files/npmrc) file at the root of your repository.
+
+See the [`@semantic-release/npm`](https://github.com/semantic-release/npm#npm-configuration) plugin documentation for more details.
+
+## How can I set the access level of the published npm package?
+
+The [npm `access` option](https://docs.npmjs.com/misc/config#access) can be set in the [`.npmrc`](https://docs.npmjs.com/files/npmrc) file at the root of your repository:
+
+```rc
+access=public
+```
+
+Or with the `publishConfig.access` key in your project's `package.json`:
+
+```json
+{
+  "publishConfig": {
+    "access": "public"
+  }
+}
+```
+
+## Can I use semantic-release to publish a package on Artifactory?
+
+Any npm compatible registry is supported with the [`@semantic-release/npm`](https://github.com/semantic-release/npm) plugin. For Artifactory versions prior to 5.4, the legacy authentication has to be used (with `NPM_USERNAME`, `NPM_PASSWORD` and `NPM_EMAIL` [environment variables](https://github.com/semantic-release/npm#environment-variables)).
+
+See [npm registry authentication](https://github.com/semantic-release/npm#npm-registry-authentication) for more details.
+
+See [Artifactory - npm Registry](https://www.jfrog.com/confluence/display/RTF/Npm+Registry#NpmRegistry-AuthenticatingthenpmClient) documentation for Artifactiry configuration.
+
+## Can I manually trigger the release of a specific version?
+
+You can trigger a release by pushing to your Git repository. You deliberately cannot trigger a *specific* version release, because this is the whole point of semantic-release.
+
+## Can I exclude commits from the analysis?
+
+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.
+
+From [Understanding the GitHub Flow](https://guides.github.com/introduction/flow/index.html):
+
+> Branching is a core concept in Git, and the entire GitHub Flow is based upon it. There's only one rule: anything in the master branch is always deployable.
+
+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.
+
+In early development phase when your package is not ready for production yet we recommend to publish releases on a distribution channel (for example npm’s [dist-tags](https://docs.npmjs.com/cli/dist-tag)) or to develop on a `dev` branch and merge it to `master` periodically. See [Triggering a release](../../README.md#triggering-a-release) for more details on those solutions.
+
+See [“Introduction to SemVer” - Irina Gebauer](https://blog.greenkeeper.io/introduction-to-semver-d272990c44f2) for more details on [Semantic Versioning](https://semver.org) and the recommendation to start at version `1.0.0`.
+
+## Can I trust semantic-release with my releases?
+
+**semantic-release** has a full unit and integration test suite that tests `npm` publishes against the [npm-registry-couchapp](https://github.com/npm/npm-registry-couchapp).
+
+In addition the [verify conditions step](../../README.md#release-steps) verifies that all necessary conditions for proceeding with a release are met, and a new release will be performed [only if all your tests pass](../usage/ci-configuration.md#run-semantic-release-only-after-all-tests-succeeded).
+
+## Why does semantic-release require Node version >= 8.3?
+
+**semantic-release** is written using the latest [ECMAScript 2017](https://www.ecma-international.org/publications/standards/Ecma-262.htm) features, without transpilation which **requires Node version 8.3 or higher**.
+
+See [Node version requirement](../support/node-version.md#node-version-requirement) for more details and solutions.
+
+## 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`.
+For more details and motivation read the [introductory blog post](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b) by [@zkat](https://github.com/zkat).

docs/support/README.md

@@ -0,0 +1,7 @@
+# Support
+
+- [Resources](resources.md) - Videos, articles and tutorials
+- [Frequently Asked Questions](FAQ.md)
+- [Troubleshooting](troubleshooting.md)
+- [Node version requirement](node-version.md)
+- [Node Support Policy](node-support-policy.md)

docs/support/node-support-policy.md

@@ -0,0 +1,13 @@
+# Node Support Policy
+
+We only support [Long-Term Support](https://github.com/nodejs/Release) versions of Node starting with [Node 8.9.0 (LTS)](https://nodejs.org/en/blog/release/v8.9.0).
+
+We specifically limit our support to LTS versions of Node, not because this package won't work on other versions, but because we have a limited amount of time, and supporting LTS offers the greatest return on that investment.
+
+It's possible this package will work correctly on newer versions of Node. It may even be possible to use this package on older versions of Node, though that's more unlikely as we'll make every effort to take advantage of features available in the oldest LTS version we support.
+
+As each Node LTS version reaches its end-of-life we will remove that version from the node engines property of our package's package.json file. Removing a Node version is considered a breaking change and will entail the publishing of a new major version of this package. We will not accept any requests to support an end-of-life version of Node. Any merge requests or issues supporting an end-of-life version of Node will be closed.
+
+We will accept code that allows this package to run on newer, non-LTS, versions of Node. Furthermore, we will attempt to ensure our own changes work on the latest version of Node. To help in that commitment, our continuous integration setup runs against all LTS versions of Node in addition the most recent Node release; called current.
+
+JavaScript package managers should allow you to install this package with any version of Node, with, at most, a warning if your version of Node does not fall within the range specified by our node engines property. If you encounter issues installing this package, please report the issue to your package manager.

docs/support/node-version.md

@@ -0,0 +1,35 @@
+# Node version requirement
+
+**semantic-release** is written using the latest [ECMAScript 2017](https://www.ecma-international.org/publications/standards/Ecma-262.htm) features, without transpilation which requires **requires Node version 8.3 or higher**.
+
+**semantic-release** is meant to be used in a CI environment as a development support tool, not as a production dependency. Therefore the only constraint is to run the `semantic-release` in a CI environment providing Node 8 or higher.
+
+See our [Node Support Policy](node-support-policy.md) for our long-term promise regarding Node version support.
+
+## Recommended solution
+
+### Run at least one CI job with Node >= 8.3
+
+The recommended approach is to run the `semantic-release` command from a CI job running on Node 8.3 or higher. This can either be a job used by your project to test on Node >= 8.3 or a dedicated job for the release steps.
+
+See [CI configuration](../usage/ci-configuration.md) and [CI configuration recipes](../recipes/README.md#ci-configurations) for more details.
+
+## Alternative solutions
+
+### Use `npx`
+
+`npx` is included with npm >= 5.2 and can be used to download the latest [Node 8 package published on npm](https://www.npmjs.com/package/node). Use it to execute the `semantic-release` command.
+
+```bash
+$ npx -p node@8 -c "npx semantic-release"
+```
+
+**Note:**: See [What is npx](./FAQ.md#what-is-npx) for more details.
+
+### Use `nvm`
+
+If your CI environment provides [nvm](https://github.com/creationix/nvm) you can use it to switch to Node 8 before running the `semantic-release` command.
+
+```bash
+$ nvm install 8 && npx semantic-release
+```

docs/support/resources.md

@@ -0,0 +1,20 @@
+# Resources
+
+## Videos
+
+- ["Introducing Reliable Dependency and Release Management for npm Packages" - Gregor Martynus](https://www.youtube.com/watch?v=R2RJWLcfzwc)
+- ["Kill all humans" - Jan Lehnardt](https://www.youtube.com/watch?v=ZXyx_1kN1L8&t=2s)
+- ["Publishing JavaScript Packages" - JavaScript Air](https://javascriptair.com/episodes/2016-07-20)
+- ["Managing Dependencies like a boss 😎" - JavaScript Air](https://javascriptair.com/episodes/2016-08-17)
+- ["Dependency Hell Just Froze Over" - Stephan Bönnemann](https://www.youtube.com/watch?v=PA139CERNbc)
+- ["semantic-release Q&A with Kent C. Dodds"](https://www.youtube.com/watch?v=g6y3DnhkjrI)
+- ["We fail to follow SemVer – and why it needn’t matter" - Stephan Bönnemann](https://www.youtube.com/watch?v=tc2UgG5L7WM)
+
+## Articles
+
+- ["Introduction to SemVer" - Irina Gebauer](https://blog.greenkeeper.io/introduction-to-semver-d272990c44f2)
+- ["Introduction to Semantic Release" - liv](https://blog.greenkeeper.io/introduction-to-semantic-release-33f73b117c8)
+
+## Tutorials
+
+- ["How to Write a JavaScript Library - Automating Releases with semantic-release" – egghead.io](https://egghead.io/lessons/javascript-automating-releases-with-semantic-release)

docs/support/troubleshooting.md

@@ -0,0 +1,56 @@
+# Troubleshooting
+
+## You do not have permission to publish 'package-name'
+
+When running semantic-release you might encounter the following error:
+
+```bash
+npm ERR! publish Failed PUT 403
+npm ERR! code E403
+npm ERR! You do not have permission to publish "<package-name>". Are you logged in as the correct user? : <package-name>
+```
+
+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 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
+$ npm install --global npm-name-cli
+$ npm-name <package-name>
+```
+
+If the package name is not available, change it in your `package.json` or consider using an [npm scope](https://docs.npmjs.com/misc/scope).
+
+## 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).
+
+## `reference already exists` error when pushing tag
+
+**semantic-release** read [Git tags](https://git-scm.com/book/en/v2/Git-Basics-Tagging) that are present in the history of your release branch in order to determine the last release published. Then it determines the next version to release based on the commits pushed since then and create the corresponding tag.
+If a tag with the name already in your repository, Git will throw and error as tags must be unique across the repository.
+This situation happens when you have a version tag identical to the new one **semantic-release** is trying to create that is not in the history of the current branch.
+
+If an actual release with that version number was published you need to merge all the commits up to that release into your release branch.
+
+If there is no published release with that version number, the tag must be deleted.
+
+```bash
+# Verify if the commit exists in the repository
+$ git rev-list -1 <tag name>
+# If a commit sha is returned, then the tag exists
+
+# Verify the branches having the tagged commit in their history
+$ git branch --contains <tag name>
+
+# Delete the tag
+$ git tag -d <tag name>
+$ git push origin :refs/tags/<tag name>
+```

docs/usage/README.md

@@ -0,0 +1,8 @@
+# Usage
+
+- [Getting started](getting-started.md#getting-started)
+- [Installation](installation.md#installation)
+- [CI Configuration](ci-configuration.md#ci-configuration)
+- [Configuration](configuration.md#configuration)
+- [Plugins](plugins.md)
+- [Shareable configurations](shareable-configurations.md)

docs/usage/ci-configuration.md

@@ -0,0 +1,33 @@
+# CI configuration
+
+## Run `semantic-release` only after all tests succeeded
+
+The `semantic-release` command must be executed only after all the tests in the CI build pass. If the build runs multiple jobs (for example to test on multiple Operating Systems or Node versions) the CI has to be configured to guarantee that the `semantic-release` command is executed only after all jobs are successful. This can be achieved with [Travis Build Stages](https://docs.travis-ci.com/user/build-stages), [CircleCI Workflows](https://circleci.com/docs/2.0/workflows), [Codeship Deployment Pipelines](https://documentation.codeship.com/basic/builds-and-configuration/deployment-pipelines), [GitLab Pipelines](https://docs.gitlab.com/ee/ci/pipelines.html#introduction-to-pipelines-and-jobs), [Codefresh Pipelines](https://codefresh.io/docs/docs/configure-ci-cd-pipeline/introduction-to-codefresh-pipelines), [Wercker Workflows](http://devcenter.wercker.com/docs/workflows) or [GoCD Pipelines](https://docs.gocd.org/current/introduction/concepts_in_go.html#pipeline).
+
+See [CI configuration recipes](../recipes/README.md#ci-configurations) for more details.
+
+## Authentication
+
+**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](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).
+
+Most **semantic-release** [plugins](plugins.md) require setting up authentication in order to publish to a package manager registry. The default [@semantic-release/npm](https://github.com/semantic-release/npm#environment-variables) and [@semantic-release/github](https://github.com/semantic-release/github#environment-variables) plugins require the following environment variables:
+
+| Variable    | Description                                                                                                                                                                                                                                                                                                               |
+|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `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's documentation for the environment variables required.
+
+The authentication token/credentials have to be made available in the CI service via environment variables.
+
+See [CI configuration recipes](../recipes/README.md#ci-configurations) for more details on how to configure environment variables in your CI service.

docs/usage/configuration.md

@@ -0,0 +1,170 @@
+# Configuration
+
+**semantic-release** configuration consists of:
+- Git repository options ([URL](#repositoryurl), [release branch](#branch) and [tag format](#tagformat))
+- [plugins](#plugins) definition
+- run mode ([debug](#debug), [dry run](#dryrun) and [local (no CI)](#ci))
+
+All of these options can be configured directly or by extending a [shareable configuration](shareable-configurations.md).
+
+Additionally, metadata of Git tags generated by **semantic-release** can be customized via standard [Git environment variables](#git-environment-variables).
+
+## Configuration file
+
+**semantic-release**’s [options](#options), mode and [plugins](plugins.md) can be set via:
+- A `.releaserc` file, written in YAML or JSON, with optional extensions: .`yaml`/`.yml`/`.json`/`.js`
+- A `release.config.js` file that exports an object
+- A `release` key in the project's `package.json` file
+
+Alternatively, some options can be set via CLI arguments.
+
+The following three examples are the same.
+
+Via `release` key in the project's `package.json` file:
+
+```json
+{
+  "release": {
+    "branch": "next"
+  }
+}
+```
+```bash
+$ semantic-release
+```
+
+Via `.releaserc` file:
+
+```json
+{
+  "branch": "next"
+}
+```
+```bash
+$ semantic-release
+```
+
+Via CLI argument:
+
+```bash
+$ semantic-release --branch next
+```
+
+**Note**: CLI arguments take precedence over options configured in the configuration file.
+
+**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.
+
+## Options
+
+### extends
+
+Type: `Array`, `String`<br>
+CLI arguments: `-e`, `--extends`
+
+List of modules or file paths containing a [shareable configuration](shareable-configurations.md). If multiple shareable configurations are set, they will be imported in the order defined with each configuration option taking precedence over the options defined in a previous shareable configuration.
+
+**Note**: Options defined via CLI arguments or in the configuration file will take precedence over the ones defined in any shareable configuration.
+
+### branch
+
+Type: `String`<br>
+Default: `master`<br>
+CLI arguments: `-b`, `--branch`
+
+The branch on which releases should happen.
+
+### repositoryUrl
+
+Type: `String`<br>
+Default: `repository` property in `package.json` or [git origin url](https://git-scm.com/book/en/v2/Git-Basics-Working-with-Remotes)<br>
+CLI arguments: `-r`, `--repository-url`
+
+The git repository URL.
+
+Any valid git url format is supported (See [Git protocols](https://git-scm.com/book/en/v2/Git-on-the-Server-The-Protocols)).
+
+### tagFormat
+
+Type: `String`<br>
+Default: `v${version}`<br>
+CLI arguments: `-t`, `--tag-format`
+
+The [Git tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging) format used by **semantic-release** to identify releases. The tag name is generated with [Lodash template](https://lodash.com/docs#template) and will be compiled with the `version` variable.
+
+**Note**: The `tagFormat` must contain the `version` variable exactly once and compile to a [valid Git reference](https://git-scm.com/docs/git-check-ref-format#_description).
+
+### plugins
+
+Type: `Array`<br>
+Default: `['@semantic-release/commit-analyzer', '@semantic-release/release-notes-generator', '@semantic-release/npm', '@semantic-release/github']`<br>
+CLI arguments: `-p`, `--plugins`
+
+Define the list of plugins to use. Plugins will run in series, in the order defined, for each [steps](../../README.md#release-steps) if they implement it.
+
+Plugins configuration can defined by wrapping the name and an options object in an array.
+
+See [Plugins configuration](plugins.md#plugins) for more details.
+
+### dryRun
+
+Type: `Boolean`<br>
+Default: `false` if running in a CI environment, `true` otherwise<br>
+CLI arguments: `-d`, `--dry-run`
+
+Dry-run mode, skip publishing, print next version and release notes.
+
+### ci
+
+Type: `Boolean`<br>
+Default: `true`<br>
+CLI arguments: `--ci` / `--no-ci`
+
+Set to `false` 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
+
+Type: `Boolean`<br>
+Default: `false`<br>
+CLI argument: `--debug`
+
+Output debugging information. This can also be enabled by setting the `DEBUG` environment variable to `semantic-release:*`.
+
+**Note**: The `debug` is used only supported via CLI argument. To enable debug mode from the [JS API](../developer-guide/js-api.md#javascript-api) use `require('debug').enable('semantic-release:*')`.
+
+## Git environment variables
+
+| Variable              | Description                                                                                                                                                                                                                    | Default                              |
+|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------|
+| `GIT_AUTHOR_NAME`     | The author name associated with the [Git release tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging). See [Git environment variables](https://git-scm.com/book/en/v2/Git-Internals-Environment-Variables#_committing).     | @semantic-release-bot.               |
+| `GIT_AUTHOR_EMAIL`    | The author email associated with the [Git release tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging). See [Git environment variables](https://git-scm.com/book/en/v2/Git-Internals-Environment-Variables#_committing).    | @semantic-release-bot email address. |
+| `GIT_COMMITTER_NAME`  | The committer name associated with the [Git release tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging). See [Git environment variables](https://git-scm.com/book/en/v2/Git-Internals-Environment-Variables#_committing).  | @semantic-release-bot.               |
+| `GIT_COMMITTER_EMAIL` | The committer email associated with the [Git release tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging). See [Git environment variables](https://git-scm.com/book/en/v2/Git-Internals-Environment-Variables#_committing). | @semantic-release-bot email address. |
+
+## Existing version tags
+
+**semantic-release** uses [Git tags](https://git-scm.com/book/en/v2/Git-Basics-Tagging) to determine the commits added since the last release. If a release has been published before setting up **semantic-release** you must make sure the most recent commit included in the last published release is in the [release branch](#branch) history and is tagged with the version released, formatted according to the [tag format](#tagformat) configured (defaults to `vx.y.z`).
+
+If the previous releases were published with [`npm publish`](https://docs.npmjs.com/cli/publish) this should already be the case.
+
+For example, if your release branch is `master`, the last release published on your project is `1.1.0` and the last commit included has the sha `1234567`, you must make sure this commit is in `master` history and is tagged with `v1.1.0`.
+
+```bash
+# Make sure the commit 1234567 is in the release branch history
+$ git branch --contains 1234567
+
+# If the commit is not in the branch history it means that either:
+# - you use a different branch than the one your release from before
+# - or the commit sha has been rewritten (with git rebase)
+# In both cases you need to configure your repository to have the last release commit in the history of the release branch
+
+# List the tags for the commit 1234567
+$ git tag --contains 1234567
+
+# If v1.1.0 is not in the list you add it with
+$ git tag v1.1.0 1234567
+$ git push origin v1.1.0
+```

docs/usage/getting-started.md

@@ -0,0 +1,22 @@
+# Getting started
+
+In order to use **semantic-release** you must follow these steps:
+- [Install](./installation.md#installation) **semantic-release** in your project
+- Configure your Continuous Integration service to [run **semantic-release**](./ci-configuration.md#run-semantic-release-only-after-all-tests-succeeded)
+- Configure your Git repository and package manager repository [authentication](ci-configuration.md#authentication) in your Continuous Integration service
+- Configure **semantic-release** [options and plugins](./configuration.md#configuration)
+
+Alternatively those steps can be easily done with the [**semantic-release** interactive CLI](https://github.com/semantic-release/cli):
+
+```bash
+npm install -g semantic-release-cli
+
+cd your-module
+semantic-release-cli setup
+```
+
+![dialogue](../../media/semantic-release-cli.png)
+
+See the [semantic-release-cli](https://github.com/semantic-release/cli#what-it-does) documentation for more details.
+
+**Note**: only a limited number of options, CI services and plugins are currently supported by `semantic-release-cli`.

docs/usage/installation.md

@@ -0,0 +1,29 @@
+# Installation
+
+## Local installation
+
+For [Node modules projects](https://docs.npmjs.com/getting-started/creating-node-modules) we recommend installing **semantic-release** locally and running the `semantic-release` command with [npx](https://www.npmjs.com/package/npx):
+
+```bash
+$ npm install --save-dev semantic-release
+```
+
+Then in the CI environment:
+
+```bash
+$ npx semantic-release
+```
+
+**Note:** `npx` is a tool bundled with `npm@>=5.2.0`. It is used to conveniently find the semantic-release binary and to execute it. See [What is npx](../support/FAQ.md#what-is-npx) for more details.
+
+## Global installation
+
+For other type of projects we recommend installing **semantic-release** directly in the CI environment, also with [npx](https://www.npmjs.com/package/npx):
+
+```bash
+$ npx semantic-release
+```
+
+**Note:** For a global installation, it's recommended to specify the major **semantic-release** version to install (for example with with `npx semantic-release@15`, or `npm install -g semantic-release@15`). This way your build will not automatically use the next major **semantic-release** release that could possibly break your build. You will have to upgrade manually when a new major version is released.
+
+**Note:** `npx` is a tool bundled with `npm@>=5.2.0`. It is used to conveniently install the semantic-release binary and to execute it. See [What is npx](../support/FAQ.md#what-is-npx) for more details.

docs/usage/plugins.md

@@ -0,0 +1,91 @@
+# Plugins
+
+Each [release step](../../README.md#release-steps) is implemented by configurable plugins. This allows for support of different [commit message formats](../../README.md#commit-message-format), release note generators and publishing platforms.
+
+A plugin is a npm module that can implement one or more of the following steps:
+
+| Step               | Required | Description                                                                                                                                                                                                          |
+|--------------------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `verifyConditions` | No       | Responsible for verifying conditions necessary to proceed with the release: configuration is correct, authentication token are valid, etc...                                                                         |
+| `analyzeCommits`   | Yes      | Responsible for determining the type of the next release (`major`, `minor` or `patch`). If multiple plugins with a `analyzeCommits` step are defined, the release type will be the highest one among plugins output. |
+| `verifyRelease`    | No       | Responsible for verifying the parameters (version, type, dist-tag etc...) of the release that is about to be published.                                                                                              |
+| `generateNotes`    | No       | Responsible for generating the content of the release note. If multiple plugins with a `generateNotes` step are defined, the release notes will be the result of the concatenation of each plugin output.            |
+| `prepare`          | No       | Responsible for preparing the release, for example creating or updating files such as `package.json`, `CHANGELOG.md`, documentation or compiled assets and pushing a commit.                                         |
+| `publish`          | No       | Responsible for publishing the release.                                                                                                                                                                              |
+| `success`          | No       | Responsible for notifying of a new release.                                                                                                                                                                          |
+| `fail`             | No       | Responsible for notifying of a failed release.                                                                                                                                                                       |
+
+**Note:** If no plugin with a `analyzeCommits` step is defined `@semantic-release/commit-analyzer` will be used.
+
+## Plugins installation
+
+These five plugins are already part of **semantic-release** and don't have to be installed separately:
+```
+"@semantic-release/commit-analyzer"	
+"@semantic-release/error"	
+"@semantic-release/github"	
+"@semantic-release/npm"	
+"@semantic-release/release-notes-generator"
+```
+
+[Additional plugins](../extending/plugins-list.md) have to be installed via npm:
+
+```bash
+$ npm install @semantic-release/git @semantic-release/changelog -D
+```
+
+## Plugins configuration
+
+Each plugin must be configured with the [`plugins` options](./configuration.md#plugins) by specifying the list of plugins by npm module name.
+
+```json
+{
+  "plugins": ["@semantic-release/commit-analyzer", "@semantic-release/release-notes-generator", "@semantic-release/npm"]
+}
+```
+
+## Plugin ordering
+
+For each [release step](../../README.md#release-steps) the plugins that implement that step will be executed in the order in which the are defined.
+
+```json
+{
+  "plugins": [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    "@semantic-release/npm",
+    "@semantic-release/git"
+  ]
+}
+```
+
+With this configuration **semantic-release** will:
+- execute the `verifyConditions` implementation of `@semantic-release/npm` then `@semantic-release/git`
+- execute the `analyzeCommits` implementation of `@semantic-release/commit-analyzer`
+- execute the `prepare` implementation of `@semantic-release/npm` then `@semantic-release/git`
+- execute the `generateNotes` implementation of `@semantic-release/release-notes-generator`
+- execute the `publish` implementation of `@semantic-release/npm`
+
+## Plugin options
+
+A plugin options can specified by wrapping the name and an options object in an array. Options configured this way will be passed only to that specific plugin.
+
+Global plugin options can defined at the root of the **semantic-release** configuration object. Options configured this way will be passed to all plugins.
+
+```json
+{
+  "plugins": [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    ["@semantic-release/github", {
+      "assets": ["dist/**"]
+      }],
+    "@semantic-release/git"
+  ],
+  "preset": "angular"
+}
+```
+
+With this configuration:
+- All plugins will receive the `preset` option, which will be used by both `@semantic-release/commit-analyzer` and `@semantic-release/release-notes-generator` (and ignored by `@semantic-release/github` and `@semantic-release/git`)
+- The `@semantic-release/github` plugin will receive the `assets` options (`@semantic-release/git` will not receive it and therefore will use it's default value for that option)

docs/usage/shareable-configurations.md

@@ -0,0 +1,7 @@
+# Shareable configurations
+
+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.
+
+See [shareable configurations list](../extending/shareable-configurations-list.md).

index.js

@@ -0,0 +1,182 @@
+const {template, pick} = require('lodash');
+const marked = require('marked');
+const TerminalRenderer = require('marked-terminal');
+const envCi = require('env-ci');
+const hookStd = require('hook-std');
+const pkg = require('./package.json');
+const hideSensitive = require('./lib/hide-sensitive');
+const getConfig = require('./lib/get-config');
+const verify = require('./lib/verify');
+const getNextVersion = require('./lib/get-next-version');
+const getCommits = require('./lib/get-commits');
+const getLastRelease = require('./lib/get-last-release');
+const {extractErrors} = require('./lib/utils');
+const getGitAuthUrl = require('./lib/get-git-auth-url');
+const getLogger = require('./lib/get-logger');
+const {fetch, verifyAuth, isBranchUpToDate, getGitHead, tag, push} = require('./lib/git');
+const getError = require('./lib/get-error');
+const {COMMIT_NAME, COMMIT_EMAIL} = require('./lib/definitions/constants');
+
+marked.setOptions({renderer: new TerminalRenderer()});
+
+async function run(context, plugins) {
+  const {cwd, env, options, logger} = context;
+  const {isCi, branch: ciBranch, isPr} = envCi({env, cwd});
+
+  if (!isCi && !options.dryRun && !options.noCi) {
+    logger.warn('This run was not triggered in a known CI environment, running in dry-run mode.');
+    options.dryRun = true;
+  } else {
+    // When running on CI, set the commits author and commiter info and prevent the `git` CLI to prompt for username/password. See #703.
+    Object.assign(env, {
+      GIT_AUTHOR_NAME: COMMIT_NAME,
+      GIT_AUTHOR_EMAIL: COMMIT_EMAIL,
+      GIT_COMMITTER_NAME: COMMIT_NAME,
+      GIT_COMMITTER_EMAIL: COMMIT_EMAIL,
+      ...env,
+      GIT_ASKPASS: 'echo',
+      GIT_TERMINAL_PROMPT: 0,
+    });
+  }
+
+  if (isCi && isPr && !options.noCi) {
+    logger.log("This run was triggered by a pull request and therefore a new version won't be published.");
+    return false;
+  }
+
+  if (ciBranch !== options.branch) {
+    logger.log(
+      `This test run was triggered on the branch ${ciBranch}, while semantic-release is configured to only publish from ${
+        options.branch
+      }, therefore a new version won’t be published.`
+    );
+    return false;
+  }
+
+  logger[options.dryRun ? 'warn' : 'success'](
+    `Run automated release from branch ${ciBranch}${options.dryRun ? ' in dry-run mode' : ''}`
+  );
+
+  await verify(context);
+
+  options.repositoryUrl = await getGitAuthUrl(context);
+
+  try {
+    try {
+      await verifyAuth(options.repositoryUrl, options.branch, {cwd, env});
+    } 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;
+      }
+
+      throw error;
+    }
+  } catch (error) {
+    logger.error(`The command "${error.cmd}" failed with the error message ${error.stderr}.`);
+    throw getError('EGITNOPERMISSION', {options});
+  }
+
+  logger.success(`Allowed to push to the Git repository`);
+
+  await plugins.verifyConditions(context);
+
+  await fetch(options.repositoryUrl, {cwd, env});
+
+  context.lastRelease = await getLastRelease(context);
+  context.commits = await getCommits(context);
+
+  const nextRelease = {type: await plugins.analyzeCommits(context), gitHead: await getGitHead({cwd, env})};
+
+  if (!nextRelease.type) {
+    logger.log('There are no relevant changes, so no new version is released.');
+    return false;
+  }
+
+  context.nextRelease = nextRelease;
+  nextRelease.version = getNextVersion(context);
+  nextRelease.gitTag = template(options.tagFormat)({version: nextRelease.version});
+
+  await plugins.verifyRelease(context);
+
+  nextRelease.notes = await plugins.generateNotes(context);
+
+  await plugins.prepare(context);
+
+  if (options.dryRun) {
+    logger.warn(`Skip ${nextRelease.gitTag} tag creation in dry-run mode`);
+  } else {
+    // Create the tag before calling the publish plugins as some require the tag to exists
+    await tag(nextRelease.gitTag, {cwd, env});
+    await push(options.repositoryUrl, {cwd, env});
+    logger.success(`Created tag ${nextRelease.gitTag}`);
+  }
+
+  context.releases = await plugins.publish(context);
+
+  await plugins.success(context);
+
+  logger.success(`Published release ${nextRelease.version}`);
+
+  if (options.dryRun) {
+    logger.log(`Release note for version ${nextRelease.version}:`);
+    if (nextRelease.notes) {
+      context.stdout.write(marked(nextRelease.notes));
+    }
+  }
+
+  return pick(context, ['lastRelease', 'commits', 'nextRelease', 'releases']);
+}
+
+function logErrors({logger, stderr}, err) {
+  const errors = extractErrors(err).sort(error => (error.semanticRelease ? -1 : 0));
+  for (const error of errors) {
+    if (error.semanticRelease) {
+      logger.error(`${error.code} ${error.message}`);
+      if (error.details) {
+        stderr.write(marked(error.details));
+      }
+    } else {
+      logger.error('An error occurred while running semantic-release: %O', error);
+    }
+  }
+}
+
+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 (error) {
+      logErrors(context, error);
+    }
+  }
+}
+
+module.exports = async (opts = {}, {cwd = process.cwd(), env = process.env, stdout, stderr} = {}) => {
+  const {unhook} = hookStd(
+    {silent: false, streams: [process.stdout, process.stderr, stdout, stderr].filter(Boolean)},
+    hideSensitive(env)
+  );
+  const context = {cwd, env, stdout: stdout || process.stdout, stderr: stderr || process.stderr};
+  context.logger = getLogger(context);
+  context.logger.log(`Running ${pkg.name} version ${pkg.version}`);
+  try {
+    const {plugins, options} = await getConfig(context, opts);
+    context.options = options;
+    try {
+      const result = await run(context, plugins);
+      unhook();
+      return result;
+    } catch (error) {
+      await callFail(context, plugins, error);
+      throw error;
+    }
+  } catch (error) {
+    logErrors(context, error);
+    unhook();
+    throw error;
+  }
+};

lib/definitions/constants.js

@@ -0,0 +1,23 @@
+const RELEASE_TYPE = ['prerelease', 'prepatch', 'patch', 'preminor', 'minor', 'premajor', 'major'];
+
+const FIRST_RELEASE = '1.0.0';
+
+const COMMIT_NAME = 'semantic-release-bot';
+
+const COMMIT_EMAIL = 'semantic-release-bot@martynus.net';
+
+const RELEASE_NOTES_SEPARATOR = '\n\n';
+
+const SECRET_REPLACEMENT = '[secure]';
+
+const SECRET_MIN_SIZE = 5;
+
+module.exports = {
+  RELEASE_TYPE,
+  FIRST_RELEASE,
+  COMMIT_NAME,
+  COMMIT_EMAIL,
+  RELEASE_NOTES_SEPARATOR,
+  SECRET_REPLACEMENT,
+  SECRET_MIN_SIZE,
+};

lib/definitions/errors.js

@@ -0,0 +1,127 @@
+const {inspect} = require('util');
+const {toLower, isString} = require('lodash');
+const pkg = require('../../package.json');
+const {RELEASE_TYPE} = require('./constants');
+
+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}`;
+
+module.exports = {
+  ENOGITREPO: ({cwd}) => ({
+    message: 'Not running from a git repository.',
+    details: `The \`semantic-release\` command must be executed from a Git repository.
+
+The current working directory is \`${cwd}\`.
+
+Please verify your CI configuration to make sure the \`semantic-release\` command is executed from the root of the cloned repository.`,
+  }),
+  ENOREPOURL: () => ({
+    message: 'The `repositoryUrl` option is required.',
+    details: `The [repositoryUrl option](${linkify(
+      'docs/usage/configuration.md#repositoryurl'
+    )}) cannot be determined from the semantic-release configuration, the \`package.json\` nor the [git origin url](https://git-scm.com/book/en/v2/Git-Basics-Working-with-Remotes).
+
+Please make sure to add the \`repositoryUrl\` to the [semantic-release configuration] (${linkify(
+      'docs/usage/configuration.md'
+    )}).`,
+  }),
+  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 \`${options.repositoryUrl}\`.
+
+Please refer to the [authentication configuration documentation](${linkify(
+      'docs/usage/ci-configuration.md#authentication'
+    )}) 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.',
+    details: `The [tagFormat](${linkify(
+      'docs/usage/configuration.md#tagformat'
+    )}) must compile to a [valid Git reference](https://git-scm.com/docs/git-check-ref-format#_description).
+
+Your configuration for the \`tagFormat\` option is \`${stringify(tagFormat)}\`.`,
+  }),
+  ETAGNOVERSION: ({tagFormat}) => ({
+    message: 'Invalid `tagFormat` option.',
+    details: `The [tagFormat](${linkify(
+      'docs/usage/configuration.md#tagformat'
+    )}) option must contain the variable \`version\` exactly once.
+
+Your configuration for the \`tagFormat\` option is \`${stringify(tagFormat)}\`.`,
+  }),
+  EPLUGINCONF: ({type, required, pluginConf}) => ({
+    message: `The \`${type}\` plugin configuration is invalid.`,
+    details: `The [${type} plugin configuration](${linkify(`docs/usage/plugins.md#${toLower(type)}-plugin`)}) ${
+      required ? 'is required and ' : ''
+    } must be a single or an array of plugins definition. A plugin definition is an npm module name, optionnaly wrapped in an array with an object.
+
+Your configuration for the \`${type}\` plugin is \`${stringify(pluginConf)}\`.`,
+  }),
+  EPLUGINSCONF: ({plugin}) => ({
+    message: 'The `plugins` configuration is invalid.',
+    details: `The [plugins](${linkify(
+      'docs/usage/configuration.md#plugins'
+    )}) option must be an array of plugin definions. A plugin definition is an npm module name, optionnaly wrapped in an array with an object.
+
+The invalid configuration is \`${stringify(plugin)}\`.`,
+  }),
+  EPLUGIN: ({pluginName, type}) => ({
+    message: `A plugin configured in the step ${type} is not a valid semantic-release plugin.`,
+    details: `A valid \`${type}\` **semantic-release** plugin must be a function or an object with a function in the property \`${type}\`.
+
+The plugin \`${pluginName}\` doesn't have the property \`${type}\` and cannot be used for the \`${type}\` step.
+
+Please refer to the \`${pluginName}\` and [semantic-release plugins configuration](${linkify(
+      'docs/usage/plugins.md'
+    )}) documentation for more details.`,
+  }),
+  EANALYZECOMMITSOUTPUT: ({result, pluginName}) => ({
+    message: 'The `analyzeCommits` plugin returned an invalid value. It must return a valid semver release type.',
+    details: `The \`analyzeCommits\` plugin must return a valid [semver](https://semver.org) release type. The valid values are: ${RELEASE_TYPE.map(
+      type => `\`${type}\``
+    ).join(', ')}.
+
+The \`analyzeCommits\` function of the \`${pluginName}\` returned \`${stringify(result)}\` instead.
+
+We recommend to report the issue to the \`${pluginName}\` authors, providing the following informations:
+- The **semantic-release** version: \`${pkg.version}\`
+- The **semantic-release** logs from your CI job
+- The value returned by the plugin: \`${stringify(result)}\`
+- A link to the **semantic-release** plugin developer guide: [${linkify('docs/developer-guide/plugin.md')}](${linkify(
+      'docs/developer-guide/plugin.md'
+    )})`,
+  }),
+  EGENERATENOTESOUTPUT: ({result, pluginName}) => ({
+    message: 'The `generateNotes` plugin returned an invalid value. It must return a `String`.',
+    details: `The \`generateNotes\` plugin must return a \`String\`.
+
+The \`generateNotes\` function of the \`${pluginName}\` returned \`${stringify(result)}\` instead.
+
+We recommend to report the issue to the \`${pluginName}\` authors, providing the following informations:
+- The **semantic-release** version: \`${pkg.version}\`
+- The **semantic-release** logs from your CI job
+- The value returned by the plugin: \`${stringify(result)}\`
+- A link to the **semantic-release** plugin developer guide: [${linkify('docs/developer-guide/plugin.md')}](${linkify(
+      'docs/developer-guide/plugin.md'
+    )})`,
+  }),
+  EPUBLISHOUTPUT: ({result, pluginName}) => ({
+    message: 'A `publish` plugin returned an invalid value. It must return an `Object`.',
+    details: `The \`publish\` plugins must return an \`Object\`.
+
+The \`publish\` function of the \`${pluginName}\` returned \`${stringify(result)}\` instead.
+
+We recommend to report the issue to the \`${pluginName}\` authors, providing the following informations:
+- The **semantic-release** version: \`${pkg.version}\`
+- The **semantic-release** logs from your CI job
+- The value returned by the plugin: \`${stringify(result)}\`
+- A link to the **semantic-release** plugin developer guide: [${linkify('docs/developer-guide/plugin.md')}](${linkify(
+      'docs/developer-guide/plugin.md'
+    )})`,
+  }),
+};

lib/definitions/plugins.js

@@ -0,0 +1,93 @@
+const {isString, isPlainObject} = require('lodash');
+const {getGitHead} = require('../git');
+const hideSensitive = require('../hide-sensitive');
+const {hideSensitiveValues} = require('../utils');
+const {RELEASE_TYPE, RELEASE_NOTES_SEPARATOR} = require('./constants');
+
+module.exports = {
+  verifyConditions: {
+    required: false,
+    dryRun: true,
+    pipelineConfig: () => ({settleAll: true}),
+  },
+  analyzeCommits: {
+    default: ['@semantic-release/commit-analyzer'],
+    required: true,
+    dryRun: true,
+    outputValidator: output => !output || RELEASE_TYPE.includes(output),
+    preprocess: ({commits, ...inputs}) => ({
+      ...inputs,
+      commits: commits.filter(commit => !/\[skip\s+release\]|\[release\s+skip\]/i.test(commit.message)),
+    }),
+    postprocess: results =>
+      RELEASE_TYPE[
+        results.reduce((highest, result) => {
+          const typeIndex = RELEASE_TYPE.indexOf(result);
+          return typeIndex > highest ? typeIndex : highest;
+        }, -1)
+      ],
+  },
+  verifyRelease: {
+    required: false,
+    dryRun: true,
+    pipelineConfig: () => ({settleAll: true}),
+  },
+  generateNotes: {
+    required: false,
+    dryRun: true,
+    outputValidator: output => !output || isString(output),
+    pipelineConfig: () => ({
+      getNextInput: ({nextRelease, ...context}, notes) => ({
+        ...context,
+        nextRelease: {
+          ...nextRelease,
+          notes: `${nextRelease.notes ? `${nextRelease.notes}${RELEASE_NOTES_SEPARATOR}` : ''}${notes}`,
+        },
+      }),
+    }),
+    postprocess: (results, {env}) => hideSensitive(env)(results.filter(Boolean).join(RELEASE_NOTES_SEPARATOR)),
+  },
+  prepare: {
+    required: false,
+    dryRun: false,
+    pipelineConfig: ({generateNotes}) => ({
+      getNextInput: async context => {
+        const newGitHead = await getGitHead({cwd: context.cwd});
+        // If previous prepare plugin has created a commit (gitHead changed)
+        if (context.nextRelease.gitHead !== newGitHead) {
+          context.nextRelease.gitHead = newGitHead;
+          // Regenerate the release notes
+          context.nextRelease.notes = await generateNotes(context);
+        }
+
+        // Call the next prepare plugin with the updated `nextRelease`
+        return context;
+      },
+    }),
+  },
+  publish: {
+    required: false,
+    dryRun: false,
+    outputValidator: output => !output || isPlainObject(output),
+    pipelineConfig: () => ({
+      // Add `nextRelease` and plugin properties to published release
+      transform: (release, step, {nextRelease}) => ({
+        ...(release === false ? {} : nextRelease),
+        ...release,
+        ...step,
+      }),
+    }),
+  },
+  success: {
+    required: false,
+    dryRun: false,
+    pipelineConfig: () => ({settleAll: true}),
+    preprocess: ({releases, env, ...inputs}) => ({...inputs, env, releases: hideSensitiveValues(env, releases)}),
+  },
+  fail: {
+    required: false,
+    dryRun: false,
+    pipelineConfig: () => ({settleAll: true}),
+    preprocess: ({errors, env, ...inputs}) => ({...inputs, env, errors: hideSensitiveValues(env, errors)}),
+  },
+};

lib/get-commits.js

@@ -0,0 +1,30 @@
+const gitLogParser = require('git-log-parser');
+const getStream = require('get-stream');
+const debug = require('debug')('semantic-release:get-commits');
+
+/**
+ * Retrieve the list of commits on the current branch since the commit sha associated with the last release, or all the commits of the current branch if there is no last released version.
+ *
+ * @param {Object} context semantic-release context.
+ *
+ * @return {Promise<Array<Object>>} The list of commits on the branch `branch` since the last release.
+ */
+module.exports = async ({cwd, env, lastRelease: {gitHead}, logger}) => {
+  if (gitHead) {
+    debug('Use gitHead: %s', gitHead);
+  } else {
+    logger.log('No previous release found, retrieving all commits');
+  }
+
+  Object.assign(gitLogParser.fields, {hash: 'H', message: 'B', gitTags: 'd', committerDate: {key: 'ci', type: Date}});
+  const commits = (await getStream.array(
+    gitLogParser.parse({_: `${gitHead ? gitHead + '..' : ''}HEAD`}, {cwd, env: {...process.env, ...env}})
+  )).map(commit => {
+    commit.message = commit.message.trim();
+    commit.gitTags = commit.gitTags.trim();
+    return commit;
+  });
+  logger.log(`Found ${commits.length} commits since last release`);
+  debug('Parsed commits: %o', commits);
+  return commits;
+};

lib/get-config.js

@@ -0,0 +1,90 @@
+const {castArray, pickBy, isNil, isString, isPlainObject} = require('lodash');
+const readPkgUp = require('read-pkg-up');
+const cosmiconfig = require('cosmiconfig');
+const resolveFrom = require('resolve-from');
+const debug = require('debug')('semantic-release:config');
+const {repoUrl} = require('./git');
+const PLUGINS_DEFINITIONS = require('./definitions/plugins');
+const plugins = require('./plugins');
+const {validatePlugin, parseConfig} = require('./plugins/utils');
+
+const CONFIG_NAME = 'release';
+const CONFIG_FILES = [
+  'package.json',
+  `.${CONFIG_NAME}rc`,
+  `.${CONFIG_NAME}rc.json`,
+  `.${CONFIG_NAME}rc.yaml`,
+  `.${CONFIG_NAME}rc.yml`,
+  `.${CONFIG_NAME}rc.js`,
+  `${CONFIG_NAME}.config.js`,
+];
+
+module.exports = async (context, opts) => {
+  const {cwd, env} = context;
+  const {config, filepath} = (await cosmiconfig(CONFIG_NAME, {searchPlaces: CONFIG_FILES}).search(cwd)) || {};
+
+  debug('load config from: %s', filepath);
+
+  // Merge config file options and CLI/API options
+  let options = {...config, ...opts};
+  if (options.ci === false) {
+    options.noCi = true;
+  }
+
+  const pluginsPath = {};
+  let extendPaths;
+  ({extends: extendPaths, ...options} = options);
+  if (extendPaths) {
+    // If `extends` is defined, load and merge each shareable config with `options`
+    options = {
+      ...castArray(extendPaths).reduce((result, extendPath) => {
+        const extendsOpts = require(resolveFrom.silent(__dirname, extendPath) || resolveFrom(cwd, extendPath));
+
+        // For each plugin defined in a shareable config, save in `pluginsPath` the extendable config path,
+        // so those plugin will be loaded relatively to the config file
+        Object.entries(extendsOpts)
+          .filter(([, value]) => Boolean(value))
+          .reduce((pluginsPath, [option, value]) => {
+            castArray(value).forEach(plugin => {
+              if (option === 'plugins' && validatePlugin(plugin)) {
+                pluginsPath[parseConfig(plugin)[0]] = extendPath;
+              } else if (
+                PLUGINS_DEFINITIONS[option] &&
+                (isString(plugin) || (isPlainObject(plugin) && isString(plugin.path)))
+              ) {
+                pluginsPath[isString(plugin) ? plugin : plugin.path] = extendPath;
+              }
+            });
+            return pluginsPath;
+          }, pluginsPath);
+
+        return {...result, ...extendsOpts};
+      }, {}),
+      ...options,
+    };
+  }
+
+  // Set default options values if not defined yet
+  options = {
+    branch: 'master',
+    repositoryUrl: (await pkgRepoUrl({normalize: false, cwd})) || (await repoUrl({cwd, env})),
+    tagFormat: `v\${version}`,
+    plugins: [
+      '@semantic-release/commit-analyzer',
+      '@semantic-release/release-notes-generator',
+      '@semantic-release/npm',
+      '@semantic-release/github',
+    ],
+    // Remove `null` and `undefined` options so they can be replaced with default ones
+    ...pickBy(options, option => !isNil(option)),
+  };
+
+  debug('options values: %O', options);
+
+  return {options, plugins: await plugins({...context, options}, pluginsPath)};
+};
+
+async function pkgRepoUrl(opts) {
+  const {package: pkg} = (await readPkgUp(opts)) || {};
+  return pkg && (isPlainObject(pkg.repository) ? pkg.repository.url : pkg.repository);
+}

lib/get-error.js

@@ -0,0 +1,7 @@
+const SemanticReleaseError = require('@semantic-release/error');
+const ERROR_DEFINITIONS = require('./definitions/errors');
+
+module.exports = (code, ctx = {}) => {
+  const {message, details} = ERROR_DEFINITIONS[code](ctx);
+  return new SemanticReleaseError(message, code, details);
+};

lib/get-git-auth-url.js

@@ -0,0 +1,67 @@
+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');
+
+/**
+ * Determine the the git repository URL to use to push, either:
+ * - The `repositoryUrl` as is if allowed to push
+ * - The `repositoryUrl` converted to `https` or `http` with Basic Authentication
+ *
+ * In addition, expand shortcut URLs (`owner/repo` => `https://github.com/owner/repo.git`) and transform `git+https` / `git+http` URLs to `https` / `http`.
+ *
+ * @param {Object} context semantic-release context.
+ *
+ * @return {String} The formatted Git repository URL.
+ */
+module.exports = async ({cwd, env, options: {repositoryUrl, branch}}) => {
+  const GIT_TOKENS = {
+    GIT_CREDENTIALS: undefined,
+    GH_TOKEN: undefined,
+    // GitHub Actions require the "x-access-token:" prefix for git access
+    // https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#http-based-git-access-by-an-installation
+    GITHUB_TOKEN: isNil(env.GITHUB_ACTION) ? undefined : 'x-access-token:',
+    GL_TOKEN: 'gitlab-ci-token:',
+    GITLAB_TOKEN: 'gitlab-ci-token:',
+    BB_TOKEN: 'x-token-auth:',
+    BITBUCKET_TOKEN: 'x-token-auth:',
+  };
+
+  const info = hostedGitInfo.fromUrl(repositoryUrl, {noGitPlus: true});
+  const {protocol, ...parsed} = parse(repositoryUrl);
+
+  if (info && info.getDefaultRepresentation() === 'shortcut') {
+    // Expand shorthand URLs (such as `owner/repo` or `gitlab:owner/repo`)
+    repositoryUrl = info.https();
+  } else if (protocol && protocol.includes('http')) {
+    // Replace `git+https` and `git+http` with `https` or `http`
+    repositoryUrl = format({...parsed, protocol: protocol.includes('https') ? 'https' : 'http', href: null});
+  }
+
+  // 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 (error) {
+    const envVar = Object.keys(GIT_TOKENS).find(envVar => !isNil(env[envVar]));
+    const gitCredentials = `${GIT_TOKENS[envVar] || ''}${env[envVar] || ''}`;
+
+    console.log(`-------- envVar -------- `);
+    console.log(envVar);
+    console.log(`-------- GIT_TOKENS[envVar] -------- `);
+    console.log(GIT_TOKENS[envVar]);
+    console.log(`-------- env[envVar].substr(5) -------- `);
+    console.log((env[envVar] || '').substr(5));
+
+    if (gitCredentials) {
+      // 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),
+        auth: gitCredentials,
+        protocol: protocol && /http[^s]/.test(protocol) ? 'http' : 'https',
+      });
+    }
+  }
+
+  return repositoryUrl;
+};

lib/get-last-release.js

@@ -0,0 +1,51 @@
+const {escapeRegExp, template} = require('lodash');
+const semver = require('semver');
+const pLocate = require('p-locate');
+const debug = require('debug')('semantic-release:get-last-release');
+const {getTags, isRefInHistory, getTagHead} = require('./git');
+
+/**
+ * Last release.
+ *
+ * @typedef {Object} LastRelease
+ * @property {string} version The version number of the last release.
+ * @property {string} [gitHead] The Git reference used to make the last release.
+ */
+
+/**
+ * Determine the Git tag and version of the last tagged release.
+ *
+ * - Obtain all the tags referencing commits in the current branch history
+ * - Filter out the ones that are not valid semantic version or doesn't match the `tagFormat`
+ * - Sort the versions
+ * - Retrive the highest version
+ *
+ * @param {Object} context semantic-release context.
+ *
+ * @return {Promise<LastRelease>} The last tagged release or `undefined` if none is found.
+ */
+module.exports = async ({cwd, env, options: {tagFormat}, logger}) => {
+  // Generate a regex to parse tags formatted with `tagFormat`
+  // by replacing the `version` variable in the template by `(.+)`.
+  // The `tagFormat` is compiled with space as the `version` as it's an invalid tag character,
+  // so it's guaranteed to not be present in the `tagFormat`.
+  const tagRegexp = `^${escapeRegExp(template(tagFormat)({version: ' '})).replace(' ', '(.+)')}`;
+  const tags = (await getTags({cwd, env}))
+    .map(tag => ({gitTag: tag, version: (tag.match(tagRegexp) || new Array(2))[1]}))
+    .filter(
+      tag => tag.version && semver.valid(semver.clean(tag.version)) && !semver.prerelease(semver.clean(tag.version))
+    )
+    .sort((a, b) => semver.rcompare(a.version, b.version));
+
+  debug('found tags: %o', tags);
+
+  const tag = await pLocate(tags, tag => isRefInHistory(tag.gitTag, {cwd, env}), {preserveOrder: true});
+
+  if (tag) {
+    logger.log(`Found git tag ${tag.gitTag} associated with version ${tag.version}`);
+    return {gitHead: await getTagHead(tag.gitTag, {cwd, env}), ...tag};
+  }
+
+  logger.log('No git tag version found');
+  return {};
+};

lib/get-logger.js

@@ -0,0 +1,16 @@
+const {Signale} = require('signale');
+const figures = require('figures');
+
+module.exports = ({stdout, stderr}) =>
+  new Signale({
+    config: {displayTimestamp: true, underlineMessage: false, displayLabel: false},
+    disabled: false,
+    interactive: false,
+    scope: 'semantic-release',
+    stream: [stdout],
+    types: {
+      error: {badge: figures.cross, color: 'red', label: '', stream: [stderr]},
+      log: {badge: figures.info, color: 'magenta', label: '', stream: [stdout]},
+      success: {badge: figures.tick, color: 'green', label: '', stream: [stdout]},
+    },
+  });

lib/get-next-version.js

@@ -0,0 +1,15 @@
+const semver = require('semver');
+const {FIRST_RELEASE} = require('./definitions/constants');
+
+module.exports = ({nextRelease: {type}, lastRelease, logger}) => {
+  let version;
+  if (lastRelease.version) {
+    version = semver.inc(lastRelease.version, type);
+    logger.log(`The next release version is ${version}`);
+  } else {
+    version = FIRST_RELEASE;
+    logger.log(`There is no previous release, the next release version is ${version}`);
+  }
+
+  return version;
+};

lib/git.js

@@ -0,0 +1,200 @@
+const execa = require('execa');
+const debug = require('debug')('semantic-release:git');
+
+/**
+ * Get the commit sha for a given tag.
+ *
+ * @param {String} tagName Tag name for which to retrieve the commit sha.
+ * @param {Object} [execaOpts] Options to pass to `execa`.
+ *
+ * @return {string} The commit sha of the tag in parameter or `null`.
+ */
+async function getTagHead(tagName, execaOpts) {
+  try {
+    return await execa.stdout('git', ['rev-list', '-1', tagName], execaOpts);
+  } catch (error) {
+    debug(error);
+  }
+}
+
+/**
+ * Get all the repository tags.
+ *
+ * @param {Object} [execaOpts] Options to pass to `execa`.
+ *
+ * @return {Array<String>} List of git tags.
+ * @throws {Error} If the `git` command fails.
+ */
+async function getTags(execaOpts) {
+  return (await execa.stdout('git', ['tag'], execaOpts))
+    .split('\n')
+    .map(tag => tag.trim())
+    .filter(Boolean);
+}
+
+/**
+ * Verify if the `ref` is in the direct history of the current branch.
+ *
+ * @param {String} ref The reference to look for.
+ * @param {Object} [execaOpts] Options to pass to `execa`.
+ *
+ * @return {Boolean} `true` if the reference is in the history of the current branch, falsy otherwise.
+ */
+async function isRefInHistory(ref, execaOpts) {
+  try {
+    await execa('git', ['merge-base', '--is-ancestor', ref, 'HEAD'], execaOpts);
+    return true;
+  } catch (error) {
+    if (error.code === 1) {
+      return false;
+    }
+
+    debug(error);
+    throw error;
+  }
+}
+
+/**
+ * Unshallow the git repository if necessary and fetch all the tags.
+ *
+ * @param {String} repositoryUrl The remote repository URL.
+ * @param {Object} [execaOpts] Options to pass to `execa`.
+ */
+async function fetch(repositoryUrl, execaOpts) {
+  try {
+    await execa('git', ['fetch', '--unshallow', '--tags', repositoryUrl], execaOpts);
+  } catch (error) {
+    await execa('git', ['fetch', '--tags', repositoryUrl], execaOpts);
+  }
+}
+
+/**
+ * Get the HEAD sha.
+ *
+ * @param {Object} [execaOpts] Options to pass to `execa`.
+ *
+ * @return {String} the sha of the HEAD commit.
+ */
+function getGitHead(execaOpts) {
+  return execa.stdout('git', ['rev-parse', 'HEAD'], execaOpts);
+}
+
+/**
+ * Get the repository remote URL.
+ *
+ * @param {Object} [execaOpts] Options to pass to `execa`.
+ *
+ * @return {string} The value of the remote git URL.
+ */
+async function repoUrl(execaOpts) {
+  try {
+    return await execa.stdout('git', ['config', '--get', 'remote.origin.url'], execaOpts);
+  } catch (error) {
+    debug(error);
+  }
+}
+
+/**
+ * Test if the current working directory is a Git repository.
+ *
+ * @param {Object} [execaOpts] Options to pass to `execa`.
+ *
+ * @return {Boolean} `true` if the current working directory is in a git repository, falsy otherwise.
+ */
+async function isGitRepo(execaOpts) {
+  try {
+    return (await execa('git', ['rev-parse', '--git-dir'], execaOpts)).code === 0;
+  } catch (error) {
+    debug(error);
+  }
+}
+
+/**
+ * Verify the write access authorization to remote repository with push dry-run.
+ *
+ * @param {String} repositoryUrl The remote repository URL.
+ * @param {String} branch The repositoru branch for which to verify write access.
+ * @param {Object} [execaOpts] Options to pass to `execa`.
+ *
+ * @throws {Error} if not authorized to push.
+ */
+async function verifyAuth(repositoryUrl, branch, execaOpts) {
+  try {
+    await execa('git', ['push', '--dry-run', repositoryUrl, `HEAD:${branch}`], execaOpts);
+  } catch (error) {
+    debug(error);
+    throw error;
+  }
+}
+
+/**
+ * Tag the commit head on the local repository.
+ *
+ * @param {String} tagName The name of the tag.
+ * @param {Object} [execaOpts] Options to pass to `execa`.
+ *
+ * @throws {Error} if the tag creation failed.
+ */
+async function tag(tagName, execaOpts) {
+  await execa('git', ['tag', tagName], execaOpts);
+}
+
+/**
+ * Push to the remote repository.
+ *
+ * @param {String} repositoryUrl The remote repository URL.
+ * @param {Object} [execaOpts] Options to pass to `execa`.
+ *
+ * @throws {Error} if the push failed.
+ */
+async function push(repositoryUrl, execaOpts) {
+  await execa('git', ['push', '--tags', repositoryUrl], execaOpts);
+}
+
+/**
+ * Verify a tag name is a valid Git reference.
+ *
+ * @param {String} tagName the tag name to verify.
+ * @param {Object} [execaOpts] Options to pass to `execa`.
+ *
+ * @return {Boolean} `true` if valid, falsy otherwise.
+ */
+async function verifyTagName(tagName, execaOpts) {
+  try {
+    return (await execa('git', ['check-ref-format', `refs/tags/${tagName}`], execaOpts)).code === 0;
+  } catch (error) {
+    debug(error);
+  }
+}
+
+/**
+ * Verify the local branch is up to date with the remote one.
+ *
+ * @param {String} branch The repository branch for which to verify status.
+ * @param {Object} [execaOpts] Options to pass to `execa`.
+ *
+ * @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, execaOpts) {
+  const remoteHead = await execa.stdout('git', ['ls-remote', '--heads', 'origin', branch], execaOpts);
+  try {
+    return await isRefInHistory(remoteHead.match(/^(\w+)?/)[1], execaOpts);
+  } catch (error) {
+    debug(error);
+  }
+}
+
+module.exports = {
+  getTagHead,
+  getTags,
+  isRefInHistory,
+  fetch,
+  getGitHead,
+  repoUrl,
+  isGitRepo,
+  verifyAuth,
+  tag,
+  push,
+  verifyTagName,
+  isBranchUpToDate,
+};

lib/hide-sensitive.js

@@ -0,0 +1,12 @@
+const {escapeRegExp, size, isString} = require('lodash');
+const {SECRET_REPLACEMENT, SECRET_MIN_SIZE} = require('./definitions/constants');
+
+module.exports = env => {
+  const toReplace = Object.keys(env).filter(
+    envVar => /token|password|credential|secret|private/i.test(envVar) && size(env[envVar].trim()) >= SECRET_MIN_SIZE
+  );
+
+  const regexp = new RegExp(toReplace.map(envVar => escapeRegExp(env[envVar])).join('|'), 'g');
+  return output =>
+    output && isString(output) && toReplace.length > 0 ? output.toString().replace(regexp, SECRET_REPLACEMENT) : output;
+};

lib/plugins/index.js

@@ -0,0 +1,93 @@
+const {identity, isPlainObject, omit, castArray, isNil, isString} = require('lodash');
+const AggregateError = require('aggregate-error');
+const getError = require('../get-error');
+const PLUGINS_DEFINITIONS = require('../definitions/plugins');
+const {validatePlugin, validateStep, loadPlugin, parseConfig} = require('./utils');
+const pipeline = require('./pipeline');
+const normalize = require('./normalize');
+
+module.exports = (context, pluginsPath) => {
+  let {options, logger} = context;
+  const errors = [];
+
+  const plugins = options.plugins
+    ? castArray(options.plugins).reduce((plugins, plugin) => {
+        if (validatePlugin(plugin)) {
+          const [name, config] = parseConfig(plugin);
+          plugin = isString(name) ? loadPlugin(context, name, pluginsPath) : name;
+
+          if (isPlainObject(plugin)) {
+            Object.entries(plugin).forEach(([type, func]) => {
+              if (PLUGINS_DEFINITIONS[type]) {
+                Reflect.defineProperty(func, 'pluginName', {
+                  value: isPlainObject(name) ? 'Inline plugin' : name,
+                  writable: false,
+                  enumerable: true,
+                });
+                plugins[type] = [...(plugins[type] || []), [func, config]];
+              }
+            });
+          } else {
+            errors.push(getError('EPLUGINSCONF', {plugin}));
+          }
+        } else {
+          errors.push(getError('EPLUGINSCONF', {plugin}));
+        }
+
+        return plugins;
+      }, {})
+    : [];
+
+  if (errors.length > 0) {
+    throw new AggregateError(errors);
+  }
+
+  options = {...plugins, ...options};
+
+  const pluginsConf = Object.entries(PLUGINS_DEFINITIONS).reduce(
+    (pluginsConf, [type, {required, default: def, pipelineConfig, postprocess = identity, preprocess = identity}]) => {
+      let pluginOpts;
+
+      if (isNil(options[type]) && def) {
+        pluginOpts = def;
+      } else {
+        // If an object is passed and the path is missing, merge it with step options
+        if (isPlainObject(options[type]) && !options[type].path) {
+          options[type] = castArray(plugins[type]).map(plugin =>
+            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];
+      }
+
+      const steps = castArray(pluginOpts).map(pluginOpt =>
+        normalize(
+          {...context, options: omit(options, Object.keys(PLUGINS_DEFINITIONS), 'plugins')},
+          type,
+          pluginOpt,
+          pluginsPath
+        )
+      );
+
+      pluginsConf[type] = async input =>
+        postprocess(
+          await pipeline(steps, pipelineConfig && pipelineConfig(pluginsConf, logger))(await preprocess(input)),
+          input
+        );
+
+      return pluginsConf;
+    },
+    plugins
+  );
+  if (errors.length > 0) {
+    throw new AggregateError(errors);
+  }
+
+  return pluginsConf;
+};

lib/plugins/normalize.js

@@ -0,0 +1,67 @@
+const {isPlainObject, isFunction, noop, cloneDeep, omit} = require('lodash');
+const debug = require('debug')('semantic-release:plugins');
+const getError = require('../get-error');
+const {extractErrors} = require('../utils');
+const PLUGINS_DEFINITIONS = require('../definitions/plugins');
+const {loadPlugin, parseConfig} = require('./utils');
+
+module.exports = (context, type, pluginOpt, pluginsPath) => {
+  const {stdout, stderr, options, logger} = context;
+  if (!pluginOpt) {
+    return noop;
+  }
+
+  const [name, config] = parseConfig(pluginOpt);
+  const pluginName = name.pluginName ? name.pluginName : isFunction(name) ? `[Function: ${name.name}]` : name;
+  const plugin = loadPlugin(context, name, pluginsPath);
+
+  debug(`options for ${pluginName}/${type}: %O`, config);
+
+  let func;
+  if (isFunction(plugin)) {
+    func = plugin.bind(null, cloneDeep({...options, ...config}));
+  } else if (isPlainObject(plugin) && plugin[type] && isFunction(plugin[type])) {
+    func = plugin[type].bind(null, cloneDeep({...options, ...config}));
+  } else {
+    throw getError('EPLUGIN', {type, pluginName});
+  }
+
+  const validator = async input => {
+    const {dryRun, outputValidator} = PLUGINS_DEFINITIONS[type] || {};
+    try {
+      if (!input.options.dryRun || dryRun) {
+        logger.log(`Start step "${type}" of plugin "${pluginName}"`);
+        const result = await func({
+          ...cloneDeep(omit(input, ['stdout', 'stderr', 'logger'])),
+          stdout,
+          stderr,
+          logger: logger.scope(logger.scopeName, pluginName),
+        });
+        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}"`);
+      extractErrors(error).forEach(err => Object.assign(err, {pluginName}));
+      throw error;
+    }
+  };
+
+  Reflect.defineProperty(validator, 'pluginName', {value: pluginName, writable: false, enumerable: true});
+
+  if (!isFunction(pluginOpt)) {
+    if (pluginsPath[name]) {
+      logger.success(`Loaded plugin "${type}" from "${pluginName}" in shareable config "${pluginsPath[name]}"`);
+    } else {
+      logger.success(`Loaded plugin "${type}" from "${pluginName}"`);
+    }
+  }
+
+  return validator;
+};

lib/plugins/pipeline.js

@@ -0,0 +1,58 @@
+const {identity} = require('lodash');
+const pReduce = require('p-reduce');
+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 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.
+ *
+ * @return {Array<*>|*} An Array with the result of each step in the pipeline; if there is only 1 step in the pipeline, the result of this step is returned directly.
+ *
+ * @throws {AggregateError|Error} An AggregateError with the errors of each step in the pipeline that rejected; if there is only 1 step in the pipeline, the error of this step is thrown directly.
+ */
+
+/**
+ * Create a Pipeline with a list of Functions.
+ *
+ * @param {Array<Function>} steps The list of Function to execute.
+ * @param {Object} options Pipeline options.
+ * @param {Boolean} [options.settleAll=false] If `true` all the steps in the pipeline are executed, even if one rejects, if `false` the execution stops after a steps rejects.
+ * @param {Function} [options.getNextInput=identity] Function called after each step is executed, with the last step input and the current current step result; the returned value will be used as the input of the next step.
+ * @param {Function} [options.transform=identity] Function called after each step is executed, with the current step result, the step function and the last step input; the returned value will be saved in the pipeline results.
+ *
+ * @return {Pipeline} A Function that execute the `steps` sequencially
+ */
+module.exports = (steps, {settleAll = false, getNextInput = identity, transform = identity} = {}) => async input => {
+  const results = [];
+  const errors = [];
+  await pReduce(
+    steps,
+    async (lastInput, step) => {
+      let result;
+      try {
+        // 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 (error) {
+        if (settleAll) {
+          errors.push(...extractErrors(error));
+          result = error;
+        } else {
+          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);
+    },
+    input
+  );
+  if (errors.length > 0) {
+    throw new AggregateError(errors);
+  }
+
+  return results;
+};

lib/plugins/utils.js

@@ -0,0 +1,68 @@
+const {dirname} = require('path');
+const {isString, isFunction, castArray, isArray, isPlainObject, isNil} = require('lodash');
+const resolveFrom = require('resolve-from');
+
+const validateSteps = conf => {
+  return conf.every(conf => {
+    if (
+      isArray(conf) &&
+      (conf.length === 1 || conf.length === 2) &&
+      (isString(conf[0]) || isFunction(conf[0])) &&
+      (isNil(conf[1]) || isPlainObject(conf[1]))
+    ) {
+      return true;
+    }
+
+    conf = castArray(conf);
+
+    if (conf.length !== 1) {
+      return false;
+    }
+
+    const [name, config] = parseConfig(conf[0]);
+    return (isString(name) || isFunction(name)) && isPlainObject(config);
+  });
+};
+
+function validatePlugin(conf) {
+  return (
+    isString(conf) ||
+    (isArray(conf) &&
+      (conf.length === 1 || conf.length === 2) &&
+      (isString(conf[0]) || isPlainObject(conf[0])) &&
+      (isNil(conf[1]) || isPlainObject(conf[1]))) ||
+    (isPlainObject(conf) && (isNil(conf.path) || isString(conf.path) || isPlainObject(conf.path)))
+  );
+}
+
+function validateStep({required}, conf) {
+  conf = castArray(conf).filter(Boolean);
+  if (required) {
+    return conf.length >= 1 && validateSteps(conf);
+  }
+
+  return conf.length === 0 || validateSteps(conf);
+}
+
+function loadPlugin({cwd}, name, pluginsPath) {
+  const basePath = pluginsPath[name]
+    ? dirname(resolveFrom.silent(__dirname, pluginsPath[name]) || resolveFrom(cwd, pluginsPath[name]))
+    : __dirname;
+  return isFunction(name) ? name : require(resolveFrom.silent(basePath, name) || resolveFrom(cwd, name));
+}
+
+function parseConfig(plugin) {
+  let path;
+  let config;
+  if (isArray(plugin)) {
+    [path, config] = plugin;
+  } else if (isPlainObject(plugin) && !isNil(plugin.path)) {
+    ({path, ...config} = plugin);
+  } else {
+    path = plugin;
+  }
+
+  return [path, config || {}];
+}
+
+module.exports = {validatePlugin, validateStep, loadPlugin, parseConfig};

lib/utils.js

@@ -0,0 +1,20 @@
+const {isFunction} = require('lodash');
+const hideSensitive = require('./hide-sensitive');
+
+function extractErrors(err) {
+  return err && isFunction(err[Symbol.iterator]) ? [...err] : [err];
+}
+
+function hideSensitiveValues(env, objs) {
+  const hideFunction = hideSensitive(env);
+  return objs.map(obj => {
+    Object.getOwnPropertyNames(obj).forEach(prop => {
+      if (obj[prop]) {
+        obj[prop] = hideFunction(obj[prop]);
+      }
+    });
+    return obj;
+  });
+}
+
+module.exports = {extractErrors, hideSensitiveValues};

lib/verify.js

@@ -0,0 +1,30 @@
+const {template} = require('lodash');
+const AggregateError = require('aggregate-error');
+const {isGitRepo, verifyTagName} = require('./git');
+const getError = require('./get-error');
+
+module.exports = async ({cwd, env, options: {repositoryUrl, tagFormat}}) => {
+  const errors = [];
+
+  if (!(await isGitRepo({cwd, env}))) {
+    errors.push(getError('ENOGITREPO', {cwd}));
+  } else if (!repositoryUrl) {
+    errors.push(getError('ENOREPOURL'));
+  }
+
+  // Verify that compiling the `tagFormat` produce a valid Git tag
+  if (!(await verifyTagName(template(tagFormat)({version: '0.0.0'})))) {
+    errors.push(getError('EINVALIDTAGFORMAT', {tagFormat}));
+  }
+
+  // Verify the `tagFormat` contains the variable `version` by compiling the `tagFormat` template
+  // with a space as the `version` value and verify the result contains the space.
+  // The space is used as it's an invalid tag character, so it's guaranteed to no be present in the `tagFormat`.
+  if ((template(tagFormat)({version: ' '}).match(/ /g) || []).length !== 1) {
+    errors.push(getError('ETAGNOVERSION', {tagFormat}));
+  }
+
+  if (errors.length > 0) {
+    throw new AggregateError(errors);
+  }
+};

package.json

@@ -14,75 +14,69 @@
       "path": "cz-conventional-changelog"
     }
   },
+  "contributors": [
+    "Gregor Martynus (https://twitter.com/gr2m)",
+    "Pierre Vanduynslager (https://twitter.com/@pvdlg_)"
+  ],
   "dependencies": {
-    "@semantic-release/commit-analyzer": "^3.0.1",
-    "@semantic-release/condition-travis": "^6.0.0",
-    "@semantic-release/error": "^2.0.0",
-    "@semantic-release/last-release-npm": "^2.0.0",
-    "@semantic-release/release-notes-generator": "^4.0.0",
-    "chalk": "^2.3.0",
-    "commander": "^2.11.0",
-    "debug": "^3.1.0",
-    "execa": "^0.8.0",
-    "fs-extra": "^4.0.2",
-    "git-head": "^1.2.1",
-    "github": "^12.0.0",
-    "lodash": "^4.0.0",
-    "marked": "^0.3.6",
-    "marked-terminal": "^2.0.0",
-    "nerf-dart": "^1.0.0",
-    "normalize-package-data": "^2.3.4",
-    "npm-conf": "^1.1.2",
-    "p-series": "^1.0.0",
-    "parse-github-repo-url": "^1.3.0",
-    "require-relative": "^0.8.7",
-    "semver": "^5.4.1"
+    "@semantic-release/commit-analyzer": "^6.1.0",
+    "@semantic-release/error": "^2.2.0",
+    "@semantic-release/github": "^5.1.0",
+    "@semantic-release/npm": "^5.0.5",
+    "@semantic-release/release-notes-generator": "^7.1.2",
+    "aggregate-error": "^3.0.0",
+    "cosmiconfig": "^5.0.1",
+    "debug": "^4.0.0",
+    "env-ci": "^3.0.0",
+    "execa": "^1.0.0",
+    "figures": "^3.0.0",
+    "find-versions": "^3.0.0",
+    "get-stream": "^5.0.0",
+    "git-log-parser": "^1.2.0",
+    "hook-std": "^2.0.0",
+    "hosted-git-info": "^2.7.1",
+    "lodash": "^4.17.4",
+    "marked": "^0.6.0",
+    "marked-terminal": "^3.2.0",
+    "p-locate": "^4.0.0",
+    "p-reduce": "^2.0.0",
+    "read-pkg-up": "^6.0.0",
+    "resolve-from": "^5.0.0",
+    "semver": "^6.0.0",
+    "signale": "^1.2.1",
+    "yargs": "^13.1.0"
   },
   "devDependencies": {
-    "ava": "^0.23.0",
+    "ava": "^1.3.1",
+    "clear-module": "^3.0.0",
     "codecov": "^3.0.0",
-    "commitizen": "^2.9.6",
+    "commitizen": "^3.0.0",
     "cz-conventional-changelog": "^2.0.0",
+    "delay": "^4.0.0",
     "dockerode": "^2.5.2",
-    "eslint": "^4.7.0",
-    "eslint-config-prettier": "^2.5.0",
-    "eslint-config-standard": "^10.2.1",
-    "eslint-plugin-import": "^2.7.0",
-    "eslint-plugin-node": "^5.2.0",
-    "eslint-plugin-prettier": "^2.3.0",
-    "eslint-plugin-promise": "^3.5.0",
-    "eslint-plugin-standard": "^3.0.1",
-    "get-stream": "^3.0.0",
-    "mockserver-client": "^1.0.16",
-    "nock": "^9.0.2",
-    "npm-registry-couchapp": "^2.6.12",
-    "nyc": "^11.2.1",
-    "p-map-series": "^1.0.0",
-    "prettier": "^1.7.0",
-    "proxyquire": "^1.8.0",
-    "rimraf": "^2.5.0",
-    "sinon": "^4.0.0",
-    "tempy": "^0.2.1"
+    "file-url": "^3.0.0",
+    "fs-extra": "^8.0.0",
+    "got": "^9.0.0",
+    "js-yaml": "^3.10.0",
+    "mockserver-client": "^5.1.1",
+    "nock": "^10.0.0",
+    "nyc": "^14.0.0",
+    "p-retry": "^4.0.0",
+    "proxyquire": "^2.0.0",
+    "sinon": "^7.2.7",
+    "stream-buffers": "^3.0.2",
+    "tempy": "^0.3.0",
+    "xo": "^0.24.0"
   },
   "engines": {
-    "node": ">=4",
-    "npm": ">=2"
-  },
-  "eslintConfig": {
-    "extends": [
-      "standard",
-      "prettier"
-    ],
-    "plugins": [
-      "prettier"
-    ],
-    "rules": {
-      "prettier/prettier": 2
-    }
+    "node": ">=8.3"
   },
   "files": [
     "bin",
-    "src"
+    "docs",
+    "lib",
+    "index.js",
+    "cli.js"
   ],
   "homepage": "https://github.com/semantic-release/semantic-release#readme",
   "keywords": [
@@ -100,7 +94,9 @@
   "main": "index.js",
   "nyc": {
     "include": [
-      "src/**/*.js"
+      "lib/**/*.js",
+      "index.js",
+      "cli.js"
     ],
     "reporter": [
       "json",
@@ -111,27 +107,25 @@
   },
   "prettier": {
     "printWidth": 120,
-    "singleQuote": true,
-    "bracketSpacing": false,
     "trailingComma": "es5"
   },
   "publishConfig": {
     "tag": "next"
   },
-  "release": {
-    "branch": "caribou"
-  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/semantic-release/semantic-release.git"
   },
   "scripts": {
-    "clean": "rimraf coverage && rimraf .nyc_output",
     "cm": "git-cz",
     "codecov": "codecov -f coverage/coverage-final.json",
-    "lint": "eslint .",
-    "pretest": "npm run clean && npm run lint",
+    "lint": "xo",
+    "pretest": "npm run lint",
     "semantic-release": "./bin/semantic-release.js",
     "test": "nyc ava -v"
+  },
+  "xo": {
+    "prettier": true,
+    "space": true
   }
 }

src/cli.js

@@ -1,59 +0,0 @@
-const program = require('commander');
-const SemanticReleaseError = require('@semantic-release/error');
-const logger = require('./lib/logger');
-
-function list(values) {
-  return values.split(',').map(value => value.trim());
-}
-
-module.exports = async () => {
-  program
-    .name('semantic-release')
-    .description('Run automated package publishing')
-    .option('-b, --branch <branch>', 'Branch to release from')
-    .option('--github-token <token>', 'Token to authenticate with Github API')
-    .option('--github-url <url>', 'GitHub Enterprise endpoint')
-    .option('--github-api-path-prefix <prefix>', 'Prefix of the GitHub Enterprise endpoint')
-    .option(
-      '--verify-conditions <paths>',
-      'Comma separated list of paths or packages name for the verifyConditions plugin',
-      list
-    )
-    .option('--get-last-release <path>', 'Path or package name for the getLastRelease plugin')
-    .option('--analyze-commits <path>', 'Path or package name for the analyzeCommits plugin')
-    .option(
-      '--verify-release <paths>',
-      'Comma separated list of paths or packages name for the verifyRelease plugin',
-      list
-    )
-    .option('--generate-notes <path>', 'Path or package name for the generateNotes plugin')
-    .option('--debug', 'Output debugging information')
-    .option(
-      '-d, --dry-run',
-      'Dry-run mode, skipping verifyConditions, publishing and release, printing next version and release notes'
-    )
-    .parse(process.argv);
-
-  if (program.debug) {
-    // Debug must be enabled before other requires in order to work
-    require('debug').enable('semantic-release:*');
-  }
-
-  try {
-    if (program.args.length > 0) {
-      program.outputHelp();
-      process.exitCode = 1;
-    } else {
-      await require('./index')(program);
-    }
-  } catch (err) {
-    // If error is a SemanticReleaseError then it's an expected exception case (no release to be done, running on a PR etc..) and the cli will return with 0
-    // Otherwise it's an unexpected error (configuration issue, code issue, plugin issue etc...) and the cli will return 1
-    if (err instanceof SemanticReleaseError) {
-      logger.log(`%s ${err.message}`, err.code);
-    } else {
-      process.exitCode = 1;
-      logger.error(err);
-    }
-  }
-};

src/index.js

@@ -1,60 +0,0 @@
-const marked = require('marked');
-const TerminalRenderer = require('marked-terminal');
-const SemanticReleaseError = require('@semantic-release/error');
-const getConfig = require('./lib/get-config');
-const getNextVersion = require('./lib/get-next-version');
-const verifyPkg = require('./lib/verify-pkg');
-const verifyAuth = require('./lib/verify-auth');
-const getCommits = require('./lib/get-commits');
-const publishNpm = require('./lib/publish-npm');
-const githubRelease = require('./lib/github-release');
-const logger = require('./lib/logger');
-
-module.exports = async opts => {
-  const config = await getConfig(opts);
-  const {plugins, env, options, pkg, npm} = config;
-
-  logger.log('Run automated release for %s on branch %s', pkg.name, options.branch);
-
-  verifyPkg(pkg);
-  if (!options.dryRun) {
-    verifyAuth(options, env);
-  }
-
-  if (!options.dryRun) {
-    logger.log('Call plugin %s', 'verify-conditions');
-    await plugins.verifyConditions({env, options, pkg, npm, logger});
-  }
-
-  logger.log('Call plugin %s', 'get-last-release');
-  const {commits, lastRelease} = await getCommits(
-    await plugins.getLastRelease({env, options, pkg, npm, logger}),
-    options.branch
-  );
-
-  logger.log('Call plugin %s', 'analyze-commits');
-  const type = await plugins.analyzeCommits({env, options, pkg, npm, logger, lastRelease, commits});
-  if (!type) {
-    throw new SemanticReleaseError('There are no relevant changes, so no new version is released.', 'ENOCHANGE');
-  }
-  const nextRelease = {type, version: getNextVersion(type, lastRelease)};
-
-  logger.log('Call plugin %s', 'verify-release');
-  await plugins.verifyRelease({env, options, pkg, npm, logger, lastRelease, commits, nextRelease});
-
-  if (!options.dryRun) {
-    await publishNpm(pkg, npm, nextRelease);
-  }
-
-  logger.log('Call plugin %s', 'generate-notes');
-  const notes = await plugins.generateNotes({env, options, pkg, npm, logger, lastRelease, commits, nextRelease});
-
-  if (options.dryRun) {
-    marked.setOptions({renderer: new TerminalRenderer()});
-    logger.log('Release note for version %s:\n', nextRelease.version);
-    console.log(marked(notes));
-  } else {
-    const releaseUrl = await githubRelease(pkg, notes, nextRelease.version, options);
-    logger.log('Published Github release: %s', releaseUrl);
-  }
-};

src/lib/debug.js

@@ -1,9 +0,0 @@
-function debugShell(message, shell, debug) {
-  debug(message);
-  debug('cmd: %O', shell.cmd);
-  debug('stdout: %O', shell.stdout);
-  debug('stderr: %O', shell.stderr);
-  debug('code: %O', shell.code);
-}
-
-module.exports = {debugShell};

src/lib/get-commits.js

@@ -1,112 +0,0 @@
-const execa = require('execa');
-const debug = require('debug')('semantic-release:get-commits');
-const getVersionHead = require('./get-version-head');
-const {debugShell} = require('./debug');
-const logger = require('./logger');
-
-/**
- * Commit message.
- * 
- * @typedef {Object} Commit
- * @property {string} hash The commit hash.
- * @property {string} message The commit message.
- */
-
-/**
- * Last release.
- * 
- * @typedef {Object} LastRelease
- * @property {string} version The version number of the last release.
- * @property {string} [gitHead] The commit sha used to make the last release.
- */
-
-/**
- * Result object.
- * 
- * @typedef {Object} Result
- * @property {Array<Commit>} commits The list of commits since the last release.
- * @property {LastRelease} lastRelease The updated lastRelease.
- */
-
-/**
- * Retrieve the list of commits on the current branch since the last released version, or all the commits of the current branch if there is no last released version.
- * 
- * The commit correspoding to the last released version is determined as follow:
- * - Use `lastRelease.gitHead` if defined and present in `branch` history.
- * - If `lastRelease.gitHead` is not in the `branch` history, unshallow the repository and try again.
- * - If `lastRelease.gitHead` is still not in the `branch` history, search for a tag named `v<version>` or `<version>` and verify if it's associated commit sha is present in `branch` history.
- *
- * @param {LastRelease} lastRelease The lastRelease object obtained from the getLastRelease plugin.
- * @param {string} branch The branch to release from.
- * @param {Object} logger Global logger.
- * 
- * @return {Promise<Result>} The list of commits on the branch `branch` since the last release and the updated lastRelease with the gitHead used to retrieve the commits.
- * 
- * @throws {SemanticReleaseError} with code `ENOTINHISTORY` if `lastRelease.gitHead` or the commit sha derived from `config.lastRelease.version` is not in the direct history of `branch`.
- * @throws {SemanticReleaseError} with code `ENOGITHEAD` if `lastRelease.gitHead` is undefined and no commit sha can be found for the `config.lastRelease.version`.
- */
-module.exports = async ({version, gitHead}, branch) => {
-  if (gitHead || version) {
-    try {
-      gitHead = await getVersionHead(gitHead, version, branch);
-    } catch (err) {
-      if (err.code === 'ENOTINHISTORY') {
-        logger.error(notInHistoryMessage(err.gitHead, branch, version));
-      } else {
-        logger.error(noGitHeadMessage(branch, version));
-      }
-      throw err;
-    }
-    logger.log('Retrieving commits since %s, corresponding to version %s', gitHead, version);
-  } else {
-    logger.log('No previous release found, retrieving all commits');
-    // If there is no gitHead nor a version, there is no previous release. Unshallow the repo in order to retrieve all commits
-    const shell = await execa('git', ['fetch', '--unshallow', '--tags'], {reject: false});
-    debugShell('Unshallow repo', shell, debug);
-  }
-
-  try {
-    const shell = await execa('git', [
-      'log',
-      '--format=format:%H==SPLIT==%B==END==',
-      `${gitHead ? gitHead + '..' : ''}HEAD`,
-    ]);
-    debugShell('Get commits', shell, debug);
-    const commits = shell.stdout
-      .split('==END==')
-      .filter(raw => !!raw.trim())
-      .map(raw => {
-        const [hash, message] = raw.trim().split('==SPLIT==');
-        return {hash, message};
-      });
-    logger.log('Found %s commits since last release', commits.length);
-    debug('Parsed commits: %o', commits);
-    return {commits, lastRelease: {version, gitHead}};
-  } catch (err) {
-    debug(err);
-    logger.log('Found no commit since last release');
-    return {commits: [], lastRelease: {version, gitHead}};
-  }
-};
-
-function noGitHeadMessage(branch, version) {
-  return `The commit the last release of this package was derived from cannot be determined from the release metadata nor from the repository tags.
-This means semantic-release can not extract the commits between now and then.
-This is usually caused by releasing from outside the repository directory or with innaccessible git metadata.
-
-You can recover from this error by creating a tag for the version "${version}" on the commit corresponding to this release:
-$ git tag -f v${version} <commit sha1 corresponding to last release>
-$ git push -f --tags origin ${branch}
-`;
-}
-
-function notInHistoryMessage(gitHead, branch, version) {
-  return `The commit the last release of this package was derived from is not in the direct history of the "${branch}" branch.
-This means semantic-release can not extract the commits between now and then.
-This is usually caused by force pushing, releasing from an unrelated branch, or using an already existing package name.
-
-You can recover from this error by restoring the commit "${gitHead}" or by creating a tag for the version "${version}" on the commit corresponding to this release:
-$ git tag -f v${version || '<version>'} <commit sha1 corresponding to last release>
-$ git push -f --tags origin ${branch}
-`;
-}

src/lib/get-config.js

@@ -1,43 +0,0 @@
-const url = require('url');
-const {readJson} = require('fs-extra');
-const {defaults} = require('lodash');
-const npmConf = require('npm-conf');
-const normalizeData = require('normalize-package-data');
-const debug = require('debug')('semantic-release:config');
-const logger = require('./logger');
-const getPlugins = require('./plugins');
-const getRegistry = require('./get-registry');
-
-module.exports = async opts => {
-  const pkg = await readJson('./package.json');
-  const {GH_TOKEN, GITHUB_TOKEN, GH_URL} = process.env;
-  normalizeData(pkg);
-  const options = defaults(opts, pkg.release, {
-    branch: 'master',
-    fallbackTags: {next: 'latest'},
-    githubToken: GH_TOKEN || GITHUB_TOKEN,
-    githubUrl: GH_URL,
-  });
-  debug('branch: %O', options.branch);
-  debug('fallbackTags: %O', options.fallbackTags);
-  debug('analyzeCommits: %O', options.analyzeCommits);
-  debug('generateNotes: %O', options.generateNotes);
-  debug('verifyConditions: %O', options.verifyConditions);
-  debug('verifyRelease: %O', options.verifyRelease);
-
-  const plugins = await getPlugins(options);
-  const conf = npmConf();
-  const npm = {
-    auth: {token: process.env.NPM_TOKEN},
-    registry: getRegistry(pkg, conf),
-    tag: (pkg.publishConfig || {}).tag || conf.get('tag'),
-    conf,
-  };
-
-  // normalize trailing slash
-  npm.registry = url.format(url.parse(npm.registry));
-
-  debug('npm registry: %O', npm.registry);
-  debug('npm tag: %O', npm.tag);
-  return {env: process.env, pkg, options, plugins, npm, logger};
-};

src/lib/get-next-version.js

@@ -1,19 +0,0 @@
-const semver = require('semver');
-const SemanticReleaseError = require('@semantic-release/error');
-const logger = require('./logger');
-
-module.exports = (type, lastRelease) => {
-  let version;
-  if (!lastRelease.version) {
-    version = '1.0.0';
-    logger.log('There is no previous release, the next release version is %s', version);
-  } else {
-    version = semver.inc(lastRelease.version, type);
-    if (!version) {
-      throw new SemanticReleaseError(`Invalid release type ${type}`, 'EINVALIDTYPE');
-    }
-    logger.log('The next release version is %s', version);
-  }
-
-  return version;
-};

src/lib/get-registry.js

@@ -1,11 +0,0 @@
-module.exports = ({publishConfig, name}, conf) => {
-  if (publishConfig && publishConfig.registry) {
-    return publishConfig.registry;
-  }
-
-  if (name[0] !== '@') {
-    return conf.get('registry') || 'https://registry.npmjs.org/';
-  }
-
-  return conf.get(`${name.split('/')[0]}/registry`) || conf.get('registry') || 'https://registry.npmjs.org/';
-};

src/lib/get-version-head.js

@@ -1,86 +0,0 @@
-const execa = require('execa');
-const debug = require('debug')('semantic-release:get-version-head');
-const SemanticReleaseError = require('@semantic-release/error');
-const {debugShell} = require('./debug');
-
-/**
- * Get the commit sha for a given tag.
- *
- * @param {string} tagName Tag name for which to retrieve the commit sha.
- * 
- * @return {string} The commit sha of the tag in parameter or `null`.
- */
-async function gitTagHead(tagName) {
-  try {
-    const shell = await execa('git', ['rev-list', '-1', '--tags', tagName]);
-    debugShell('Get git tag head', shell, debug);
-    return shell.stdout;
-  } catch (err) {
-    debug(err);
-    return null;
-  }
-}
-
-/**
- * Verify if the commist `sha` is in the direct history of the current branch.
- * 
- * @param {string} sha The sha of the commit to look for.
- * 
- * @return {boolean} `true` if the commit `sha` is in the history of the current branch, `false` otherwise.
- */
-async function isCommitInHistory(sha) {
-  const shell = await execa('git', ['merge-base', '--is-ancestor', sha, 'HEAD'], {reject: false});
-  debugShell('Check if commit is in history', shell, debug);
-  return shell.code === 0;
-}
-
-/**
- * Get the commit sha for a given version, if it's contained in the given branch.
- *
- * @param {string} gitHead The commit sha to look for.
- * @param {string} version The version corresponding to the commit sha to look for. Used to search in git tags.
- * 
- * @return {Promise<string>} A Promise that resolves to the commit sha of the version, either `gitHead` of the commit associated with the `version` tag.
- * 
- * @throws {SemanticReleaseError} with code `ENOTINHISTORY` if `gitHead` or the commit sha dereived from `version` is not in the direct history of `branch`.
- * @throws {SemanticReleaseError} with code `ENOGITHEAD` if `gitHead` is undefined and no commit sha can be found for the `version`.
- */
-module.exports = async (gitHead, version) => {
-  // Check if gitHead is defined and exists in release branch
-  if (gitHead && (await isCommitInHistory(gitHead))) {
-    debug('Use gitHead: %s', gitHead);
-    return gitHead;
-  }
-
-  // Ushallow the repository
-  const shell = await execa('git', ['fetch', '--unshallow', '--tags'], {reject: false});
-  debugShell('Unshallow repo', shell, debug);
-
-  // Check if gitHead is defined and exists in release branch again
-  if (gitHead && (await isCommitInHistory(gitHead))) {
-    debug('Use gitHead: %s', gitHead);
-    return gitHead;
-  }
-
-  let tagHead;
-  if (version) {
-    // If a version is defined search a corresponding tag
-    tagHead = (await gitTagHead(`v${version}`)) || (await gitTagHead(version));
-
-    // Check if tagHead is found and exists in release branch again
-    if (tagHead && (await isCommitInHistory(tagHead))) {
-      debug('Use tagHead: %s', tagHead);
-      return tagHead;
-    }
-  }
-
-  // Either gitHead is defined or a tagHead has been found but none is in the branch history
-  if (gitHead || tagHead) {
-    const error = new SemanticReleaseError('Commit not in history', 'ENOTINHISTORY');
-    error.gitHead = gitHead || tagHead;
-    throw error;
-  }
-
-  // There is no gitHead in the last release and there is no tags correponsing to the last release version
-  throw new SemanticReleaseError('There is no commit associated with last release', 'ENOGITHEAD');
-};

src/lib/github-release.js

@@ -1,36 +0,0 @@
-const {promisify} = require('util');
-const url = require('url');
-const gitHead = require('git-head');
-const GitHubApi = require('github');
-const parseSlug = require('parse-github-repo-url');
-const debug = require('debug')('semantic-release:github-release');
-
-module.exports = async (pkg, notes, version, {branch, githubUrl, githubToken, githubApiPathPrefix}) => {
-  const [owner, repo] = parseSlug(pkg.repository.url);
-  let {port, protocol, hostname: host} = githubUrl ? url.parse(githubUrl) : {};
-  protocol = (protocol || '').split(':')[0] || null;
-  const pathPrefix = githubApiPathPrefix || null;
-  const github = new GitHubApi({port, protocol, host, pathPrefix});
-  debug('Github host: %o', host);
-  debug('Github port: %o', port);
-  debug('Github protocol: %o', protocol);
-  debug('Github pathPrefix: %o', pathPrefix);
-
-  github.authenticate({type: 'token', token: githubToken});
-
-  const name = `v${version}`;
-  const release = {owner, repo, tag_name: name, name, target_commitish: branch, body: notes};
-  debug('release owner: %o', owner);
-  debug('release repo: %o', repo);
-  debug('release name: %o', name);
-  debug('release branch: %o', branch);
-
-  const sha = await promisify(gitHead)();
-  const ref = `refs/tags/${name}`;
-
-  debug('Create git tag %o with commit %o', ref, sha);
-  await github.gitdata.createReference({owner, repo, ref, sha});
-  const {data: {html_url: releaseUrl}} = await github.repos.createRelease(release);
-
-  return releaseUrl;
-};

src/lib/logger.js

@@ -1,18 +0,0 @@
-const chalk = require('chalk');
-
-/**
- * Logger with `log` and `error` function.
- */
-module.exports = {
-  log(...args) {
-    const [format, ...rest] = args;
-    console.log(`${chalk.grey('[Semantic release]:')} ${format}`, ...rest.map(arg => chalk.magenta(arg)));
-  },
-  error(...args) {
-    const [format, ...rest] = args;
-    console.error(
-      `${chalk.grey('[Semantic release]:')} ${chalk.red(format instanceof Error ? format.stack : format)}`,
-      ...rest.map(arg => chalk.red(arg instanceof Error ? arg.stack : arg))
-    );
-  },
-};

src/lib/plugin-noop.js

@@ -1,3 +0,0 @@
-module.exports = (config, options, cb) => {
-  cb(null);
-};

src/lib/plugins.js

@@ -1,45 +0,0 @@
-const {promisify} = require('util');
-const relative = require('require-relative');
-const pSeries = require('p-series');
-const logger = require('./logger');
-
-module.exports = options => {
-  const plugins = {
-    analyzeCommits: normalize(options.analyzeCommits, '@semantic-release/commit-analyzer'),
-    generateNotes: normalize(options.generateNotes, '@semantic-release/release-notes-generator'),
-    getLastRelease: normalize(options.getLastRelease, '@semantic-release/last-release-npm'),
-  };
-  ['verifyConditions', 'verifyRelease'].forEach(plugin => {
-    if (!Array.isArray(options[plugin])) {
-      plugins[plugin] = normalize(
-        options[plugin],
-        plugin === 'verifyConditions' ? '@semantic-release/condition-travis' : './plugin-noop'
-      );
-    } else {
-      plugins[plugin] = async pluginOptions => {
-        return pSeries(
-          options[plugin].map(step => {
-            return () => normalize(step, './plugin-noop')(pluginOptions);
-          })
-        );
-      };
-    }
-  });
-
-  return plugins;
-};
-
-const normalize = (pluginConfig, fallback) => {
-  if (typeof pluginConfig === 'string') {
-    logger.log('Load plugin %s', pluginConfig);
-    return promisify(relative(pluginConfig).bind(null, {}));
-  }
-
-  if (pluginConfig && typeof pluginConfig.path === 'string') {
-    logger.log('Load plugin %s', pluginConfig.path);
-    return promisify(relative(pluginConfig.path).bind(null, pluginConfig));
-  }
-  return promisify(require(fallback).bind(null, pluginConfig || {}));
-};
-
-module.exports.normalize = normalize;

src/lib/publish-npm.js

@@ -1,35 +0,0 @@
-const {appendFile, readJson, writeJson, pathExists} = require('fs-extra');
-const execa = require('execa');
-const nerfDart = require('nerf-dart');
-const debug = require('debug')('semantic-release:publish-npm');
-const {debugShell} = require('./debug');
-const logger = require('./logger');
-
-module.exports = async (pkg, {conf, registry, auth}, {version}) => {
-  const pkgFile = await readJson('./package.json');
-
-  if (await pathExists('./npm-shrinkwrap.json')) {
-    const shrinkwrap = await readJson('./npm-shrinkwrap.json');
-    shrinkwrap.version = version;
-    await writeJson('./npm-shrinkwrap.json', shrinkwrap);
-    logger.log('Wrote version %s to npm-shrinkwrap.json', version);
-  }
-
-  await writeJson('./package.json', Object.assign(pkgFile, {version}));
-  logger.log('Wrote version %s to package.json', version);
-
-  if (process.env.NPM_OLD_TOKEN && process.env.NPM_EMAIL) {
-    // Using the old auth token format is not considered part of the public API
-    // This might go away anytime (i.e. once we have a better testing strategy)
-    await appendFile('./.npmrc', `_auth = \${NPM_OLD_TOKEN}\nemail = \${NPM_EMAIL}`);
-    logger.log('Wrote NPM_OLD_TOKEN and NPM_EMAIL to .npmrc.');
-  } else {
-    await appendFile('./.npmrc', `${nerfDart(registry)}:_authToken = \${NPM_TOKEN}`);
-    logger.log('Wrote NPM_TOKEN to .npmrc.');
-  }
-
-  logger.log('Publishing version %s to npm registry %s', version, registry);
-  const shell = await execa('npm', ['publish']);
-  console.log(shell.stdout);
-  debugShell('Publishing on npm', shell, debug);
-};

src/lib/verify-auth.js

@@ -1,11 +0,0 @@
-const SemanticReleaseError = require('@semantic-release/error');
-
-module.exports = (options, env) => {
-  if (!options.githubToken) {
-    throw new SemanticReleaseError('No github token specified.', 'ENOGHTOKEN');
-  }
-
-  if (!(env.NPM_TOKEN || (env.NPM_OLD_TOKEN && env.NPM_EMAIL))) {
-    throw new SemanticReleaseError('No npm token specified.', 'ENONPMTOKEN');
-  }
-};

src/lib/verify-pkg.js

@@ -1,11 +0,0 @@
-const SemanticReleaseError = require('@semantic-release/error');
-
-module.exports = pkg => {
-  if (!pkg.name) {
-    throw new SemanticReleaseError('No "name" found in package.json.', 'ENOPKGNAME');
-  }
-
-  if (!pkg.repository || !pkg.repository.url) {
-    throw new SemanticReleaseError('No "repository" found in package.json.', 'ENOPKGREPO');
-  }
-};

test/cli.test.js

@@ -0,0 +1,222 @@
+import test from 'ava';
+import {escapeRegExp} from 'lodash';
+import proxyquire from 'proxyquire';
+import {stub} from 'sinon';
+import {SECRET_REPLACEMENT} from '../lib/definitions/constants';
+
+const requireNoCache = proxyquire.noPreserveCache();
+
+test.beforeEach(t => {
+  t.context.logs = '';
+  t.context.errors = '';
+  t.context.stdout = stub(process.stdout, 'write').callsFake(val => {
+    t.context.logs += val.toString();
+  });
+  t.context.stderr = stub(process.stderr, 'write').callsFake(val => {
+    t.context.errors += val.toString();
+  });
+});
+
+test.afterEach.always(t => {
+  t.context.stdout.restore();
+  t.context.stderr.restore();
+});
+
+test.serial('Pass options to semantic-release API', async t => {
+  const run = stub().resolves(true);
+  const argv = [
+    '',
+    '',
+    '-b',
+    'master',
+    '-r',
+    'https://github/com/owner/repo.git',
+    '-t',
+    `v\${version}`,
+    '-p',
+    'plugin1',
+    'plugin2',
+    '-e',
+    'config1',
+    'config2',
+    '--verify-conditions',
+    'condition1',
+    'condition2',
+    '--analyze-commits',
+    'analyze',
+    '--verify-release',
+    'verify1',
+    'verify2',
+    '--generate-notes',
+    'notes',
+    '--prepare',
+    'prepare1',
+    'prepare2',
+    '--publish',
+    'publish1',
+    'publish2',
+    '--success',
+    'success1',
+    'success2',
+    '--fail',
+    'fail1',
+    'fail2',
+    '--debug',
+    '-d',
+  ];
+  const cli = requireNoCache('../cli', {'.': run, process: {...process, argv}});
+
+  const exitCode = await cli();
+
+  t.is(run.args[0][0].branch, 'master');
+  t.is(run.args[0][0].repositoryUrl, 'https://github/com/owner/repo.git');
+  t.is(run.args[0][0].tagFormat, `v\${version}`);
+  t.deepEqual(run.args[0][0].plugins, ['plugin1', 'plugin2']);
+  t.deepEqual(run.args[0][0].extends, ['config1', 'config2']);
+  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.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']);
+  t.deepEqual(run.args[0][0].fail, ['fail1', 'fail2']);
+  t.is(run.args[0][0].debug, true);
+  t.is(run.args[0][0].dryRun, true);
+
+  t.is(exitCode, 0);
+});
+
+test.serial('Pass options to semantic-release API with alias arguments', async t => {
+  const run = stub().resolves(true);
+  const argv = [
+    '',
+    '',
+    '--branch',
+    'master',
+    '--repository-url',
+    'https://github/com/owner/repo.git',
+    '--tag-format',
+    `v\${version}`,
+    '--plugins',
+    'plugin1',
+    'plugin2',
+    '--extends',
+    'config1',
+    'config2',
+    '--dry-run',
+  ];
+  const cli = requireNoCache('../cli', {'.': run, process: {...process, argv}});
+
+  const exitCode = await cli();
+
+  t.is(run.args[0][0].branch, 'master');
+  t.is(run.args[0][0].repositoryUrl, 'https://github/com/owner/repo.git');
+  t.is(run.args[0][0].tagFormat, `v\${version}`);
+  t.deepEqual(run.args[0][0].plugins, ['plugin1', 'plugin2']);
+  t.deepEqual(run.args[0][0].extends, ['config1', 'config2']);
+  t.is(run.args[0][0].dryRun, true);
+
+  t.is(exitCode, 0);
+});
+
+test.serial('Pass unknown options to semantic-release API', async t => {
+  const run = stub().resolves(true);
+  const argv = ['', '', '--bool', '--first-option', 'value1', '--second-option', 'value2', '--second-option', 'value3'];
+  const cli = requireNoCache('../cli', {'.': run, process: {...process, argv}});
+
+  const exitCode = await cli();
+
+  t.is(run.args[0][0].bool, true);
+  t.is(run.args[0][0].firstOption, 'value1');
+  t.deepEqual(run.args[0][0].secondOption, ['value2', 'value3']);
+
+  t.is(exitCode, 0);
+});
+
+test.serial('Pass empty Array to semantic-release API for list option set to "false"', async t => {
+  const run = stub().resolves(true);
+  const argv = ['', '', '--publish', 'false'];
+  const cli = requireNoCache('../cli', {'.': run, process: {...process, argv}});
+
+  const exitCode = await cli();
+
+  t.deepEqual(run.args[0][0].publish, []);
+
+  t.is(exitCode, 0);
+});
+
+test.serial('Do not set properties in option for which arg is not in command line', async t => {
+  const run = stub().resolves(true);
+  const argv = ['', '', '-b', 'master'];
+  const cli = requireNoCache('../cli', {'.': run, process: {...process, argv}});
+
+  await cli();
+
+  t.false('ci' in run.args[0][0]);
+  t.false('d' in run.args[0][0]);
+  t.false('dry-run' in run.args[0][0]);
+  t.false('debug' in run.args[0][0]);
+  t.false('r' in run.args[0][0]);
+  t.false('t' in run.args[0][0]);
+  t.false('p' in run.args[0][0]);
+  t.false('e' in run.args[0][0]);
+});
+
+test.serial('Display help', async t => {
+  const run = stub().resolves(true);
+  const argv = ['', '', '--help'];
+  const cli = requireNoCache('../cli', {'.': run, process: {...process, argv}});
+
+  const exitCode = await cli();
+
+  t.regex(t.context.logs, /Run automated package publishing/);
+  t.is(exitCode, 0);
+});
+
+test.serial('Return error code and prints help if called with a command', async t => {
+  const run = stub().resolves(true);
+  const argv = ['', '', 'pre'];
+  const cli = requireNoCache('../cli', {'.': run, process: {...process, argv}});
+
+  const exitCode = await cli();
+
+  t.regex(t.context.errors, /Run automated package publishing/);
+  t.regex(t.context.errors, /Too many non-option arguments/);
+  t.is(exitCode, 1);
+});
+
+test.serial('Return error code if multiple plugin are set for single plugin', async t => {
+  const run = stub().resolves(true);
+  const argv = ['', '', '--analyze-commits', 'analyze1', 'analyze2'];
+  const cli = requireNoCache('../cli', {'.': run, process: {...process, argv}});
+
+  const exitCode = await cli();
+
+  t.regex(t.context.errors, /Run automated package publishing/);
+  t.regex(t.context.errors, /Too many non-option arguments/);
+  t.is(exitCode, 1);
+});
+
+test.serial('Return error code if semantic-release throw error', async t => {
+  const run = stub().rejects(new Error('semantic-release error'));
+  const argv = ['', ''];
+  const cli = requireNoCache('../cli', {'.': run, process: {...process, argv}});
+
+  const exitCode = await cli();
+
+  t.regex(t.context.errors, /semantic-release error/);
+  t.is(exitCode, 1);
+});
+
+test.serial('Hide sensitive environment variable values from the logs', async t => {
+  const env = {MY_TOKEN: 'secret token'};
+  const run = stub().rejects(new Error(`Throw error: Exposing token ${env.MY_TOKEN}`));
+  const argv = ['', ''];
+  const cli = requireNoCache('../cli', {'.': run, process: {...process, argv, env: {...process.env, ...env}}});
+
+  const exitCode = await cli();
+
+  t.regex(t.context.errors, new RegExp(`Throw error: Exposing token ${escapeRegExp(SECRET_REPLACEMENT)}`));
+  t.is(exitCode, 1);
+});

test/definitions/plugins.test.js

@@ -0,0 +1,64 @@
+import test from 'ava';
+import plugins from '../../lib/definitions/plugins';
+import {RELEASE_NOTES_SEPARATOR, SECRET_REPLACEMENT} from '../../lib/definitions/constants';
+
+test('The "analyzeCommits" plugin output must be either undefined or a valid semver release type', t => {
+  t.false(plugins.analyzeCommits.outputValidator('invalid'));
+  t.false(plugins.analyzeCommits.outputValidator(1));
+  t.false(plugins.analyzeCommits.outputValidator({}));
+
+  t.true(plugins.analyzeCommits.outputValidator());
+  t.true(plugins.analyzeCommits.outputValidator(null));
+  t.true(plugins.analyzeCommits.outputValidator('major'));
+});
+
+test('The "generateNotes" plugin output, if defined, must be a string', t => {
+  t.false(plugins.generateNotes.outputValidator(1));
+  t.false(plugins.generateNotes.outputValidator({}));
+
+  t.true(plugins.generateNotes.outputValidator());
+  t.true(plugins.generateNotes.outputValidator(null));
+  t.true(plugins.generateNotes.outputValidator(''));
+  t.true(plugins.generateNotes.outputValidator('string'));
+});
+
+test('The "publish" plugin output, if defined, must be an object or "false"', t => {
+  t.false(plugins.publish.outputValidator(1));
+  t.false(plugins.publish.outputValidator('string'));
+
+  t.true(plugins.publish.outputValidator({}));
+  t.true(plugins.publish.outputValidator());
+  t.true(plugins.publish.outputValidator(null));
+  t.true(plugins.publish.outputValidator(''));
+  t.true(plugins.publish.outputValidator(false));
+});
+
+test('The "generateNotes" plugins output are concatenated with separator and sensitive data is hidden', t => {
+  const env = {MY_TOKEN: 'secret token'};
+  t.is(plugins.generateNotes.postprocess(['note 1', 'note 2'], {env}), `note 1${RELEASE_NOTES_SEPARATOR}note 2`);
+  t.is(plugins.generateNotes.postprocess(['', 'note'], {env}), 'note');
+  t.is(plugins.generateNotes.postprocess([undefined, 'note'], {env}), 'note');
+  t.is(plugins.generateNotes.postprocess(['note 1', '', 'note 2'], {env}), `note 1${RELEASE_NOTES_SEPARATOR}note 2`);
+  t.is(
+    plugins.generateNotes.postprocess(['note 1', undefined, 'note 2'], {env}),
+    `note 1${RELEASE_NOTES_SEPARATOR}note 2`
+  );
+
+  t.is(
+    plugins.generateNotes.postprocess(
+      [`Note 1: Exposing token ${env.MY_TOKEN}`, `Note 2: Exposing token ${SECRET_REPLACEMENT}`],
+      {env}
+    ),
+    `Note 1: Exposing token ${SECRET_REPLACEMENT}${RELEASE_NOTES_SEPARATOR}Note 2: Exposing token ${SECRET_REPLACEMENT}`
+  );
+});
+
+test('The "analyzeCommits" plugins output are reduced to the highest release type', t => {
+  t.is(plugins.analyzeCommits.postprocess(['major', 'minor']), 'major');
+  t.is(plugins.analyzeCommits.postprocess(['', 'minor']), 'minor');
+  t.is(plugins.analyzeCommits.postprocess([undefined, 'patch']), 'patch');
+  t.is(plugins.analyzeCommits.postprocess([null, 'patch']), 'patch');
+  t.is(plugins.analyzeCommits.postprocess(['wrong_type', 'minor']), 'minor');
+  t.is(plugins.analyzeCommits.postprocess([]), undefined);
+  t.is(plugins.analyzeCommits.postprocess(['wrong_type']), undefined);
+});

test/fixtures/index.js

@@ -0,0 +1 @@
+module.exports = () => {};

test/fixtures/multi-plugin.js

@@ -0,0 +1,8 @@
+module.exports = {
+  verifyConditions: () => {},
+  getLastRelease: () => {},
+  analyzeCommits: () => {},
+  verifyRelease: () => {},
+  generateNotes: () => {},
+  publish: () => {},
+};

test/fixtures/plugin-error-a.js

@@ -1,3 +0,0 @@
-module.exports = function(config, options, cb) {
-  cb(new Error('a'));
-};

test/fixtures/plugin-error-b.js

@@ -1,3 +0,0 @@
-module.exports = function(config, options, cb) {
-  cb(new Error('b'));
-};

test/fixtures/plugin-error-inherited.js

@@ -0,0 +1,14 @@
+const SemanticReleaseError = require('@semantic-release/error');
+
+class InheritedError extends SemanticReleaseError {
+  constructor(message, code) {
+    super(message);
+    Error.captureStackTrace(this, this.constructor);
+    this.name = this.constructor.name;
+    this.code = code;
+  }
+}
+
+module.exports = () => {
+  throw new InheritedError('Inherited error', 'EINHERITED');
+};

test/fixtures/plugin-error.js

@@ -0,0 +1,5 @@
+module.exports = () => {
+  const error = new Error('a');
+  error.errorProperty = 'errorProperty';
+  throw error;
+};

test/fixtures/plugin-errors.js

@@ -0,0 +1,5 @@
+const AggregateError = require('aggregate-error');
+
+module.exports = () => {
+  throw new AggregateError([new Error('a'), new Error('b')]);
+};

test/fixtures/plugin-identity.js

@@ -0,0 +1 @@
+module.exports = (pluginConfig, context) => context;

test/fixtures/plugin-log-env.js

@@ -0,0 +1,6 @@
+module.exports = (pluginConfig, {env, logger}) => {
+  console.log(`Console: Exposing token ${env.MY_TOKEN}`);
+  logger.log(`Log: Exposing token ${env.MY_TOKEN}`);
+  logger.error(`Error: Console token ${env.MY_TOKEN}`);
+  throw new Error(`Throw error: Exposing ${env.MY_TOKEN}`);
+};

test/fixtures/plugin-noop.js

@@ -0,0 +1 @@
+module.exports = () => {};

test/fixtures/plugin-result-a.js

@@ -1,3 +0,0 @@
-module.exports = function(config, options, cb) {
-  cb(null, 'a');
-};

test/fixtures/plugin-result-b.js

@@ -1,3 +0,0 @@
-module.exports = function(config, options, cb) {
-  cb(null, 'b');
-};

test/fixtures/plugin-result-config.js

@@ -1,3 +1 @@
-module.exports = function(pluginConfig, options, cb) {
-  cb(null, {pluginConfig, options});
-};
+module.exports = (pluginConfig, context) => ({pluginConfig, context});

test/get-commits.test.js

@@ -1,417 +1,95 @@
 import test from 'ava';
-import proxyquire from 'proxyquire';
 import {stub} from 'sinon';
-import SemanticReleaseError from '@semantic-release/error';
-import {
-  gitRepo,
-  gitCommits,
-  gitCheckout,
-  gitTagVersion,
-  gitShallowClone,
-  gitTags,
-  gitLog,
-  gitDetachedHead,
-} from './helpers/git-utils';
+import getCommits from '../lib/get-commits';
+import {gitRepo, gitCommits, gitDetachedHead} from './helpers/git-utils';
 
 test.beforeEach(t => {
-  // Save the current working diretory
-  t.context.cwd = process.cwd();
   // Stub the logger functions
   t.context.log = stub();
   t.context.error = stub();
-  t.context.getCommits = proxyquire('../src/lib/get-commits', {
-    './logger': {log: t.context.log, error: t.context.error},
+  t.context.logger = {log: t.context.log, error: t.context.error};
+});
+
+test('Get all commits when there is no last release', async t => {
+  // Create a git repository, set the current working directory at the root of the repo
+  const {cwd} = await gitRepo();
+  // Add commits to the master branch
+  const commits = await gitCommits(['First', 'Second'], {cwd});
+
+  // Retrieve the commits with the commits module
+  const result = await getCommits({cwd, lastRelease: {}, logger: t.context.logger});
+
+  // Verify the commits created and retrieved by the module are identical
+  t.is(result.length, 2);
+  t.deepEqual(result, commits);
+});
+
+test('Get all commits since gitHead (from lastRelease)', async t => {
+  // Create a git repository, set the current working directory at the root of the repo
+  const {cwd} = await gitRepo();
+  // Add commits to the master branch
+  const commits = await gitCommits(['First', 'Second', 'Third'], {cwd});
+
+  // Retrieve the commits with the commits module, since commit 'First'
+  const result = await getCommits({
+    cwd,
+    lastRelease: {gitHead: commits[commits.length - 1].hash},
+    logger: t.context.logger,
   });
-});
-
-test.afterEach.always(t => {
-  // Restore the current working directory
-  process.chdir(t.context.cwd);
-});
-
-test.serial('Get all commits when there is no last release', async t => {
-  // Create a git repository, set the current working directory at the root of the repo
-  await gitRepo();
-  // Add commits to the master branch
-  const commits = await gitCommits(['First', 'Second']);
-
-  // Retrieve the commits with the commits module
-  const result = await t.context.getCommits({}, 'master');
 
   // Verify the commits created and retrieved by the module are identical
-  t.is(result.commits.length, 2);
-  t.is(result.commits[0].hash.substring(0, 7), commits[0].hash);
-  t.is(result.commits[0].message, commits[0].message);
-  t.is(result.commits[1].hash.substring(0, 7), commits[1].hash);
-  t.is(result.commits[1].message, commits[1].message);
-  // Verify the last release is returned and updated
-  t.truthy(result.lastRelease);
-  t.falsy(result.lastRelease.gitHead);
-  t.falsy(result.lastRelease.version);
+  t.is(result.length, 2);
+  t.deepEqual(result, commits.slice(0, 2));
 });
 
-test.serial('Get all commits when there is no last release, including the ones not in the shallow clone', async t => {
+test('Get all commits since gitHead (from lastRelease) on a detached head repo', async t => {
   // Create a git repository, set the current working directory at the root of the repo
-  const repo = await gitRepo();
+  let {cwd, repositoryUrl} = await gitRepo();
   // Add commits to the master branch
-  const commits = await gitCommits(['First', 'Second']);
-  // Create a shallow clone with only 1 commit
-  await gitShallowClone(repo);
-
-  // Verify the shallow clone contains only one commit
-  t.is((await gitLog()).length, 1);
-
-  // Retrieve the commits with the commits module
-  const result = await t.context.getCommits({}, 'master');
-
-  // Verify the commits created and retrieved by the module are identical
-  t.is(result.commits.length, 2);
-  t.is(result.commits[0].hash.substring(0, 7), commits[0].hash);
-  t.is(result.commits[0].message, commits[0].message);
-  t.is(result.commits[1].hash.substring(0, 7), commits[1].hash);
-  t.is(result.commits[1].message, commits[1].message);
-  // Verify the last release is returned and updated
-  t.truthy(result.lastRelease);
-  t.falsy(result.lastRelease.gitHead);
-  t.falsy(result.lastRelease.version);
-});
-
-test.serial('Get all commits since gitHead (from lastRelease)', async t => {
-  // Create a git repository, set the current working directory at the root of the repo
-  await gitRepo();
-  // Add commits to the master branch
-  const commits = await gitCommits(['First', 'Second', 'Third']);
-
-  // Retrieve the commits with the commits module, since commit 'First'
-  const result = await t.context.getCommits({gitHead: commits[commits.length - 1].hash}, 'master');
-
-  // Verify the commits created and retrieved by the module are identical
-  t.is(result.commits.length, 2);
-  t.is(result.commits[0].hash.substring(0, 7), commits[0].hash);
-  t.is(result.commits[0].message, commits[0].message);
-  t.is(result.commits[1].hash.substring(0, 7), commits[1].hash);
-  t.is(result.commits[1].message, commits[1].message);
-  // Verify the last release is returned and updated
-  t.truthy(result.lastRelease);
-  t.is(result.lastRelease.gitHead, commits[commits.length - 1].hash);
-  t.falsy(result.lastRelease.version);
-});
-
-test.serial('Get all commits since gitHead (from lastRelease) on a detached head repo', async t => {
-  // Create a git repository, set the current working directory at the root of the repo
-  const repo = await gitRepo();
-  // Add commits to the master branch
-  const commits = await gitCommits(['First', 'Second', 'Third']);
+  const commits = await gitCommits(['First', 'Second', 'Third'], {cwd});
   // Create a detached head repo at commit 'feat: Second'
-  await gitDetachedHead(repo, commits[1].hash);
+  cwd = await gitDetachedHead(repositoryUrl, commits[1].hash);
 
   // Retrieve the commits with the commits module, since commit 'First'
-  const result = await t.context.getCommits({gitHead: commits[commits.length - 1].hash}, 'master');
+  const result = await getCommits({
+    cwd,
+    lastRelease: {gitHead: commits[commits.length - 1].hash},
+    logger: t.context.logger,
+  });
 
   // Verify the module retrieved only the commit 'feat: Second' (included in the detached and after 'fix: First')
-  t.is(result.commits.length, 1);
-  t.is(result.commits[0].hash.substring(0, 7), commits[1].hash);
-  t.is(result.commits[0].message, commits[1].message);
-  // Verify the last release is returned and updated
-  t.truthy(result.lastRelease);
-  t.is(result.lastRelease.gitHead, commits[commits.length - 1].hash);
-  t.falsy(result.lastRelease.version);
+  t.is(result.length, 1);
+  t.is(result[0].hash, commits[1].hash);
+  t.is(result[0].message, commits[1].message);
+  t.truthy(result[0].committerDate);
+  t.truthy(result[0].author.name);
+  t.truthy(result[0].committer.name);
 });
 
-test.serial('Get all commits since gitHead (from tag) ', async t => {
+test('Return empty array if lastRelease.gitHead is the last commit', async t => {
   // Create a git repository, set the current working directory at the root of the repo
-  await gitRepo();
+  const {cwd} = await gitRepo();
   // Add commits to the master branch
-  let commits = await gitCommits(['First']);
-  // Create the tag corresponding to version 1.0.0
-  await gitTagVersion('1.0.0');
-  // Add new commits to the master branch
-  commits = (await gitCommits(['Second', 'Third'])).concat(commits);
-
-  // Retrieve the commits with the commits module, since commit 'First' (associated with tag v1.0.0)
-  const result = await t.context.getCommits({version: '1.0.0'}, 'master');
-
-  // Verify the commits created and retrieved by the module are identical
-  t.is(result.commits.length, 2);
-  t.is(result.commits[0].hash.substring(0, 7), commits[0].hash);
-  t.is(result.commits[0].message, commits[0].message);
-  t.is(result.commits[1].hash.substring(0, 7), commits[1].hash);
-  t.is(result.commits[1].message, commits[1].message);
-  // Verify the last release is returned and updated
-  t.truthy(result.lastRelease);
-  t.is(result.lastRelease.gitHead.substring(0, 7), commits[commits.length - 1].hash);
-  t.is(result.lastRelease.version, '1.0.0');
-});
-
-test.serial('Get all commits since gitHead (from tag) on a detached head repo', async t => {
-  // Create a git repository, set the current working directory at the root of the repo
-  const repo = await gitRepo();
-  // Add commits to the master branch
-  let commits = await gitCommits(['First']);
-  // Create the tag corresponding to version 1.0.0
-  await gitTagVersion('1.0.0');
-  // Add new commits to the master branch
-  commits = (await gitCommits(['Second', 'Third'])).concat(commits);
-  // Create a detached head repo at commit 'feat: Second'
-  await gitDetachedHead(repo, commits[1].hash);
-
-  // Retrieve the commits with the commits module, since commit 'First' (associated with tag 1.0.0)
-  const result = await t.context.getCommits({version: '1.0.0'}, 'master');
-
-  // Verify the module retrieved only the commit 'feat: Second' (included in the detached and after 'fix: First')
-  t.is(result.commits.length, 1);
-  t.is(result.commits[0].hash.substring(0, 7), commits[1].hash);
-  t.is(result.commits[0].message, commits[1].message);
-  // Verify the last release is returned and updated
-  t.truthy(result.lastRelease);
-  t.is(result.lastRelease.gitHead.substring(0, 7), commits[commits.length - 1].hash);
-  t.is(result.lastRelease.version, '1.0.0');
-});
-
-test.serial('Get all commits since gitHead (from tag formatted like v<version>) ', async t => {
-  // Create a git repository, set the current working directory at the root of the repo
-  await gitRepo();
-  // Add commits to the master branch
-  let commits = await gitCommits(['First']);
-  // Create the tag corresponding to version 1.0.0
-  await gitTagVersion('v1.0.0');
-  // Add new commits to the master branch
-  commits = (await gitCommits(['Second', 'Third'])).concat(commits);
-
-  // Retrieve the commits with the commits module, since commit 'First' (associated with tag v1.0.0)
-  const result = await t.context.getCommits({version: '1.0.0'}, 'master');
-
-  // Verify the commits created and retrieved by the module are identical
-  t.is(result.commits.length, 2);
-  t.is(result.commits[0].hash.substring(0, 7), commits[0].hash);
-  t.is(result.commits[0].message, commits[0].message);
-  t.is(result.commits[1].hash.substring(0, 7), commits[1].hash);
-  t.is(result.commits[1].message, commits[1].message);
-  // Verify the last release is returned and updated
-  t.truthy(result.lastRelease);
-  t.is(result.lastRelease.gitHead.substring(0, 7), commits[commits.length - 1].hash);
-  t.is(result.lastRelease.version, '1.0.0');
-});
-
-test.serial('Get commits when last release gitHead is missing but a tag match the version', async t => {
-  // Create a git repository, set the current working directory at the root of the repo
-  await gitRepo();
-  // Add commits to the master branch
-  let commits = await gitCommits(['First']);
-  // Create the tag corresponding to version 1.0.0
-  await gitTagVersion('v1.0.0');
-  // Add new commits to the master branch
-  commits = (await gitCommits(['Second', 'Third'])).concat(commits);
-
-  // Retrieve the commits with the commits module, since commit 'First' (associated with tag v1.0.0)
-  const result = await t.context.getCommits({version: '1.0.0', gitHead: 'missing'}, 'master');
-
-  // Verify the commits created and retrieved by the module are identical
-  t.is(result.commits.length, 2);
-  t.is(result.commits[0].hash.substring(0, 7), commits[0].hash);
-  t.is(result.commits[0].message, commits[0].message);
-  t.is(result.commits[1].hash.substring(0, 7), commits[1].hash);
-  t.is(result.commits[1].message, commits[1].message);
-  // Verify the last release is returned and updated
-  t.truthy(result.lastRelease);
-  t.is(result.lastRelease.gitHead.substring(0, 7), commits[commits.length - 1].hash);
-  t.is(result.lastRelease.version, '1.0.0');
-});
-
-test.serial('Get all commits since gitHead, when gitHead are mising from the shallow clone', async t => {
-  // Create a git repository, set the current working directory at the root of the repo
-  const repo = await gitRepo();
-  // Add commits to the master branch
-  const commits = await gitCommits(['First', 'Second', 'Third']);
-  // Create a shallow clone with only 1 commit and no tags
-  await gitShallowClone(repo);
-
-  // Retrieve the commits with the commits module, since commit 'First'
-  const result = await t.context.getCommits({version: '1.0.0', gitHead: commits[commits.length - 1].hash}, 'master');
-
-  // Verify the commits created and retrieved by the module are identical
-  t.is(result.commits.length, 2);
-  t.is(result.commits[0].hash.substring(0, 7), commits[0].hash);
-  t.is(result.commits[0].message, commits[0].message);
-  t.is(result.commits[1].hash.substring(0, 7), commits[1].hash);
-  t.is(result.commits[1].message, commits[1].message);
-  // Verify the last release is returned and updated
-  t.truthy(result.lastRelease);
-  t.is(result.lastRelease.gitHead.substring(0, 7), commits[commits.length - 1].hash);
-  t.is(result.lastRelease.version, '1.0.0');
-});
-
-test.serial('Get all commits since gitHead from tag, when tags are mising from the shallow clone', async t => {
-  // Create a git repository, set the current working directory at the root of the repo
-  const repo = await gitRepo();
-  // Add commits to the master branch
-  let commits = await gitCommits(['First']);
-  // Create the tag corresponding to version 1.0.0
-  await gitTagVersion('v1.0.0');
-  // Add new commits to the master branch
-  commits = (await gitCommits(['Second', 'Third'])).concat(commits);
-  // Create a shallow clone with only 1 commit and no tags
-  await gitShallowClone(repo);
-
-  // Verify the shallow clone does not contains any tags
-  t.is((await gitTags()).length, 0);
-
-  // Retrieve the commits with the commits module, since commit 'First' (associated with tag v1.0.0)
-  const result = await t.context.getCommits({version: '1.0.0'}, 'master');
-
-  // Verify the commits created and retrieved by the module are identical
-  t.is(result.commits.length, 2);
-  t.is(result.commits[0].hash.substring(0, 7), commits[0].hash);
-  t.is(result.commits[0].message, commits[0].message);
-  t.is(result.commits[1].hash.substring(0, 7), commits[1].hash);
-  t.is(result.commits[1].message, commits[1].message);
-  // Verify the last release is returned and updated
-  t.truthy(result.lastRelease);
-  t.is(result.lastRelease.gitHead.substring(0, 7), commits[commits.length - 1].hash);
-  t.is(result.lastRelease.version, '1.0.0');
-});
-
-test.serial('Return empty array if lastRelease.gitHead is the last commit', async t => {
-  // Create a git repository, set the current working directory at the root of the repo
-  await gitRepo();
-  // Add commits to the master branch
-  const commits = await gitCommits(['First', 'Second']);
+  const commits = await gitCommits(['First', 'Second'], {cwd});
 
   // Retrieve the commits with the commits module, since commit 'Second' (therefore none)
-  const result = await t.context.getCommits({gitHead: commits[0].hash, version: '1.0.0'}, 'master');
+  const result = await getCommits({
+    cwd,
+    lastRelease: {gitHead: commits[0].hash},
+    logger: t.context.logger,
+  });
 
   // Verify no commit is retrieved
-  t.deepEqual(result.commits, []);
-  // Verify the last release is returned and updated
-  t.truthy(result.lastRelease);
-  t.is(result.lastRelease.gitHead.substring(0, 7), commits[0].hash);
-  t.is(result.lastRelease.version, '1.0.0');
+  t.deepEqual(result, []);
 });
 
-test.serial('Return empty array if there is no commits', async t => {
+test('Return empty array if there is no commits', async t => {
   // Create a git repository, set the current working directory at the root of the repo
-  await gitRepo();
+  const {cwd} = await gitRepo();
 
   // Retrieve the commits with the commits module
-  const result = await t.context.getCommits({}, 'master');
+  const result = await getCommits({cwd, lastRelease: {}, logger: t.context.logger});
 
   // Verify no commit is retrieved
-  t.deepEqual(result.commits, []);
-  // Verify the last release is returned and updated
-  t.truthy(result.lastRelease);
-  t.falsy(result.lastRelease.gitHead);
-  t.falsy(result.lastRelease.version);
-});
-
-test.serial('Throws ENOGITHEAD error if the gitHead of the last release cannot be found', async t => {
-  // Create a git repository, set the current working directory at the root of the repo
-  await gitRepo();
-  // Add commits to the master branch
-  await gitCommits(['First', 'Second']);
-
-  // Retrieve the commits with the commits module
-  const error = await t.throws(t.context.getCommits({version: '1.0.0'}, 'master'));
-
-  // Verify error code and type
-  t.is(error.code, 'ENOGITHEAD');
-  t.true(error instanceof SemanticReleaseError);
-  // Verify the log function has been called with a message explaining the error
-  t.regex(
-    t.context.error.firstCall.args[0],
-    /The commit the last release of this package was derived from cannot be determined from the release metadata nor from the repository tags/
-  );
-});
-
-test.serial('Throws ENOTINHISTORY error if gitHead is not in history', async t => {
-  // Create a git repository, set the current working directory at the root of the repo
-  await gitRepo();
-  // Add commits to the master branch
-  await gitCommits(['First', 'Second']);
-
-  // Retrieve the commits with the commits module
-  const error = await t.throws(t.context.getCommits({gitHead: 'notinhistory'}, 'master'));
-
-  // Verify error code and type
-  t.is(error.code, 'ENOTINHISTORY');
-  t.true(error instanceof SemanticReleaseError);
-  // Verify the log function has been called with a message mentionning the branch
-  t.regex(t.context.error.firstCall.args[0], /history of the "master" branch/);
-  // Verify the log function has been called with a message mentionning the missing gitHead
-  t.regex(t.context.error.firstCall.args[0], /restoring the commit "notinhistory"/);
-});
-
-test.serial('Throws ENOTINHISTORY error if gitHead is not in branch history but present in others', async t => {
-  // Create a git repository, set the current working directory at the root of the repo
-  await gitRepo();
-  // Add commits to the master branch
-  await gitCommits(['First', 'Second']);
-  // Create the new branch 'other-branch' from master
-  await gitCheckout('other-branch');
-  // Add commits to the 'other-branch' branch
-  const commitsBranch = await gitCommits(['Third', 'Fourth']);
-  await gitCheckout('master', false);
-
-  // Retrieve the commits with the commits module
-  const error = await t.throws(t.context.getCommits({version: '1.0.1', gitHead: commitsBranch[0].hash}, 'master'));
-
-  // Verify error code and type
-  t.is(error.code, 'ENOTINHISTORY');
-  t.true(error instanceof SemanticReleaseError);
-  // Verify the log function has been called with a message mentionning the branch
-  t.regex(t.context.error.firstCall.args[0], /history of the "master" branch/);
-  // Verify the log function has been called with a message mentionning the missing gitHead
-  t.regex(t.context.error.firstCall.args[0], new RegExp(`restoring the commit "${commitsBranch[0].hash}"`));
-});
-
-test.serial('Throws ENOTINHISTORY error if gitHead is not in detached head but present in other branch', async t => {
-  // Create a git repository, set the current working directory at the root of the repo
-  const repo = await gitRepo();
-  // Add commit to the master branch
-  await gitCommits(['First']);
-  // Create the new branch 'other-branch' from master
-  await gitCheckout('other-branch');
-  // Add commits to the 'other-branch' branch
-  const commitsBranch = await gitCommits(['Second', 'Third']);
-  await gitCheckout('master', false);
-  // Add new commit to master branch
-  const commitsMaster = await gitCommits(['Fourth']);
-  // Create a detached head repo at commit 'Fourth'
-  await gitDetachedHead(repo, commitsMaster[0].hash);
-
-  // Retrieve the commits with the commits module, since commit 'Second'
-  const error = await t.throws(t.context.getCommits({version: '1.0.1', gitHead: commitsBranch[0].hash}, 'master'));
-
-  // Verify error code and type
-  t.is(error.code, 'ENOTINHISTORY');
-  t.true(error instanceof SemanticReleaseError);
-  // Verify the log function has been called with a message mentionning the branch
-  t.regex(t.context.error.firstCall.args[0], /history of the "master" branch/);
-  // Verify the log function has been called with a message mentionning the missing gitHead
-  t.regex(t.context.error.firstCall.args[0], new RegExp(`restoring the commit "${commitsBranch[0].hash}"`));
-});
-
-test.serial('Throws ENOTINHISTORY error when a tag is not in branch history but present in others', async t => {
-  // Create a git repository, set the current working directory at the root of the repo
-  await gitRepo();
-  // Add commits to the master branch
-  await gitCommits(['First', 'Second']);
-  // Create the new branch 'other-branch' from master
-  await gitCheckout('other-branch');
-  // Add commits to the 'other-branch' branch
-  await gitCommits(['Third']);
-  // Create the tag corresponding to version 1.0.0
-  const shaTag = await gitTagVersion('v1.0.0');
-  await gitCheckout('master', false);
-  // Add new commit to the master branch
-  await gitCommits(['Forth']);
-
-  // Retrieve the commits with the commits module
-  const error = await t.throws(t.context.getCommits({version: '1.0.0'}, 'master'));
-  // Verify error code and type
-  t.is(error.code, 'ENOTINHISTORY');
-  t.true(error instanceof SemanticReleaseError);
-  // Verify the log function has been called with a message mentionning the branch
-  t.regex(t.context.error.firstCall.args[0], /history of the "master" branch/);
-  // Verify the log function has been called with a message mentionning the missing gitHead
-  t.regex(t.context.error.firstCall.args[0], new RegExp(`restoring the commit "${shaTag}"`));
+  t.deepEqual(result, []);
 });

test/get-config.test.js

@@ -1,154 +1,487 @@
-import url from 'url';
+import path from 'path';
+import {format} from 'util';
 import test from 'ava';
-import {writeJson, writeFile} from 'fs-extra';
+import {writeFile, outputJson} from 'fs-extra';
+import {omit} from 'lodash';
 import proxyquire from 'proxyquire';
 import {stub} from 'sinon';
-import normalizeData from 'normalize-package-data';
-import {gitRepo} from './helpers/git-utils';
+import yaml from 'js-yaml';
+import {gitRepo, gitCommits, gitShallowClone, gitAddConfig} from './helpers/git-utils';
+
+const DEFAULT_PLUGINS = [
+  '@semantic-release/commit-analyzer',
+  '@semantic-release/release-notes-generator',
+  '@semantic-release/npm',
+  '@semantic-release/github',
+];
 
 test.beforeEach(t => {
-  // Save the current process.env
-  t.context.env = Object.assign({}, process.env);
-  // Save the current working diretory
-  t.context.cwd = process.cwd();
   t.context.plugins = stub().returns({});
-  t.context.getConfig = proxyquire('../src/lib/get-config', {'./plugins': t.context.plugins});
+  t.context.getConfig = proxyquire('../lib/get-config', {'./plugins': t.context.plugins});
 });
 
-test.afterEach.always(t => {
-  // Restore the current working directory
-  process.chdir(t.context.cwd);
-  // Restore process.env
-  process.env = Object.assign({}, t.context.env);
-});
-
-test.serial('Default values', async t => {
-  const pkg = {name: 'package_name', release: {}};
+test('Default values, reading repositoryUrl from package.json', async t => {
+  const pkg = {repository: 'https://host.null/owner/package.git'};
   // Create a git repository, set the current working directory at the root of the repo
-  await gitRepo();
+  const {cwd} = await gitRepo();
+  await gitCommits(['First'], {cwd});
+  // Add remote.origin.url config
+  await gitAddConfig('remote.origin.url', 'git@host.null:owner/repo.git', {cwd});
   // Create package.json in repository root
-  await writeJson('./package.json', pkg);
-  process.env.GH_TOKEN = 'GH_TOKEN';
+  await outputJson(path.resolve(cwd, 'package.json'), pkg);
 
-  const result = await t.context.getConfig();
+  const {options: result} = await t.context.getConfig({cwd});
 
-  // Verify the normalized package is returned
-  normalizeData(pkg);
-  t.deepEqual(result.pkg, pkg);
   // Verify the default options are set
-  t.is(result.options.branch, 'master');
-  t.is(result.options.githubToken, process.env.GH_TOKEN);
-  // Verify the default npm options are set
-  t.is(result.npm.tag, 'latest');
-
-  // Use the environment variable npm_config_registry as the default so the test works on both npm and yarn
-  t.is(result.npm.registry, url.format(url.parse(process.env.npm_config_registry || 'https://registry.npmjs.org/')));
+  t.is(result.branch, 'master');
+  t.is(result.repositoryUrl, 'https://host.null/owner/package.git');
+  t.is(result.tagFormat, `v\${version}`);
 });
 
-test.serial('Read package.json configuration', async t => {
-  const release = {
-    analyzeCommits: 'analyzeCommits',
-    generateNotes: 'generateNotes',
-    getLastRelease: {
-      path: 'getLastRelease',
-      param: 'getLastRelease_param',
-    },
-    branch: 'test_branch',
-  };
-  const pkg = {name: 'package_name', release};
-
+test('Default values, reading repositoryUrl from repo if not set in package.json', async t => {
   // Create a git repository, set the current working directory at the root of the repo
-  await gitRepo();
-  // Create package.json in repository root
-  await writeJson('./package.json', pkg);
-  delete process.env.GH_TOKEN;
-  process.env.GITHUB_TOKEN = 'GITHUB_TOKEN';
+  const {cwd} = await gitRepo();
+  // Add remote.origin.url config
+  await gitAddConfig('remote.origin.url', 'https://host.null/owner/module.git', {cwd});
 
-  const result = await t.context.getConfig();
+  const {options: result} = await t.context.getConfig({cwd});
+
+  // Verify the default options are set
+  t.is(result.branch, 'master');
+  t.is(result.repositoryUrl, 'https://host.null/owner/module.git');
+  t.is(result.tagFormat, `v\${version}`);
+});
+
+test('Default values, reading repositoryUrl (http url) from package.json if not set in repo', async t => {
+  const pkg = {repository: 'https://host.null/owner/module.git'};
+  // Create a git repository, set the current working directory at the root of the repo
+  const {cwd} = await gitRepo();
+  // Create package.json in repository root
+  await outputJson(path.resolve(cwd, 'package.json'), pkg);
+
+  const {options: result} = await t.context.getConfig({cwd});
+
+  // Verify the default options are set
+  t.is(result.branch, 'master');
+  t.is(result.repositoryUrl, 'https://host.null/owner/module.git');
+  t.is(result.tagFormat, `v\${version}`);
+});
+
+test('Convert "ci" option to "noCi"', async t => {
+  const pkg = {repository: 'https://host.null/owner/module.git', release: {ci: false}};
+  // Create a git repository, set the current working directory at the root of the repo
+  const {cwd} = await gitRepo();
+  // Create package.json in repository root
+  await outputJson(path.resolve(cwd, 'package.json'), pkg);
+
+  const {options: result} = await t.context.getConfig({cwd});
+
+  t.is(result.noCi, true);
+});
+
+test('Read options from package.json', async t => {
+  // Create a git repository, set the current working directory at the root of the repo
+  const {cwd} = await gitRepo();
+  const options = {
+    analyzeCommits: {path: 'analyzeCommits', param: 'analyzeCommits_param'},
+    generateNotes: 'generateNotes',
+    branch: 'test_branch',
+    repositoryUrl: 'https://host.null/owner/module.git',
+    tagFormat: `v\${version}`,
+    plugins: false,
+  };
+  // Create package.json in repository root
+  await outputJson(path.resolve(cwd, 'package.json'), {release: options});
+
+  const {options: result} = await t.context.getConfig({cwd});
 
   // Verify the options contains the plugin config from package.json
-  t.is(result.options.analyzeCommits, release.analyzeCommits);
-  t.is(result.options.generateNotes, release.generateNotes);
-  t.deepEqual(result.options.getLastRelease, release.getLastRelease);
-  t.is(result.options.branch, release.branch);
-
+  t.deepEqual(result, options);
   // Verify the plugins module is called with the plugin options from package.json
-  t.is(t.context.plugins.firstCall.args[0].analyzeCommits, release.analyzeCommits);
-  t.is(t.context.plugins.firstCall.args[0].generateNotes, release.generateNotes);
-  t.deepEqual(t.context.plugins.firstCall.args[0].getLastRelease, release.getLastRelease);
-  t.is(t.context.plugins.firstCall.args[0].branch, release.branch);
-
-  t.is(result.options.githubToken, process.env.GITHUB_TOKEN);
+  t.deepEqual(t.context.plugins.args[0][0], {cwd, options});
 });
 
-test.serial('Priority cli parameters over package.json configuration', async t => {
-  const release = {
-    analyzeCommits: 'analyzeCommits',
-    generateNotes: 'generateNotes',
-    getLastRelease: {
-      path: 'getLastRelease',
-      param: 'getLastRelease_pkg',
-    },
+test('Read options from .releaserc.yml', async t => {
+  // Create a git repository, set the current working directory at the root of the repo
+  const {cwd} = await gitRepo();
+  const options = {
+    analyzeCommits: {path: 'analyzeCommits', param: 'analyzeCommits_param'},
+    branch: 'test_branch',
+    repositoryUrl: 'https://host.null/owner/module.git',
+    tagFormat: `v\${version}`,
+    plugins: false,
+  };
+  // Create package.json in repository root
+  await writeFile(path.resolve(cwd, '.releaserc.yml'), yaml.safeDump(options));
+
+  const {options: result} = await t.context.getConfig({cwd});
+
+  // Verify the options contains the plugin config from package.json
+  t.deepEqual(result, options);
+  // Verify the plugins module is called with the plugin options from package.json
+  t.deepEqual(t.context.plugins.args[0][0], {cwd, options});
+});
+
+test('Read options from .releaserc.json', async t => {
+  // Create a git repository, set the current working directory at the root of the repo
+  const {cwd} = await gitRepo();
+  const options = {
+    analyzeCommits: {path: 'analyzeCommits', param: 'analyzeCommits_param'},
+    branch: 'test_branch',
+    repositoryUrl: 'https://host.null/owner/module.git',
+    tagFormat: `v\${version}`,
+    plugins: false,
+  };
+  // Create package.json in repository root
+  await outputJson(path.resolve(cwd, '.releaserc.json'), options);
+
+  const {options: result} = await t.context.getConfig({cwd});
+
+  // Verify the options contains the plugin config from package.json
+  t.deepEqual(result, options);
+  // Verify the plugins module is called with the plugin options from package.json
+  t.deepEqual(t.context.plugins.args[0][0], {cwd, options});
+});
+
+test('Read options from .releaserc.js', async t => {
+  // Create a git repository, set the current working directory at the root of the repo
+  const {cwd} = await gitRepo();
+  const options = {
+    analyzeCommits: {path: 'analyzeCommits', param: 'analyzeCommits_param'},
+    branch: 'test_branch',
+    repositoryUrl: 'https://host.null/owner/module.git',
+    tagFormat: `v\${version}`,
+    plugins: false,
+  };
+  // Create package.json in repository root
+  await writeFile(path.resolve(cwd, '.releaserc.js'), `module.exports = ${JSON.stringify(options)}`);
+
+  const {options: result} = await t.context.getConfig({cwd});
+
+  // Verify the options contains the plugin config from package.json
+  t.deepEqual(result, options);
+  // Verify the plugins module is called with the plugin options from package.json
+  t.deepEqual(t.context.plugins.args[0][0], {cwd, options});
+});
+
+test('Read options from release.config.js', async t => {
+  // Create a git repository, set the current working directory at the root of the repo
+  const {cwd} = await gitRepo();
+  const options = {
+    analyzeCommits: {path: 'analyzeCommits', param: 'analyzeCommits_param'},
+    branch: 'test_branch',
+    repositoryUrl: 'https://host.null/owner/module.git',
+    tagFormat: `v\${version}`,
+    plugins: false,
+  };
+  // Create package.json in repository root
+  await writeFile(path.resolve(cwd, 'release.config.js'), `module.exports = ${JSON.stringify(options)}`);
+
+  const {options: result} = await t.context.getConfig({cwd});
+
+  // Verify the options contains the plugin config from package.json
+  t.deepEqual(result, options);
+  // Verify the plugins module is called with the plugin options from package.json
+  t.deepEqual(t.context.plugins.args[0][0], {cwd, options});
+});
+
+test('Prioritise CLI/API parameters over file configuration and git repo', async t => {
+  // Create a git repository, set the current working directory at the root of the repo
+  let {cwd, repositoryUrl} = await gitRepo();
+  await gitCommits(['First'], {cwd});
+  // Create a clone
+  cwd = await gitShallowClone(repositoryUrl);
+  const pkgOptions = {
+    analyzeCommits: {path: 'analyzeCommits', param: 'analyzeCommits_pkg'},
     branch: 'branch_pkg',
   };
   const options = {
-    getLastRelease: {
-      path: 'getLastRelease',
-      param: 'getLastRelease_cli',
-    },
+    analyzeCommits: {path: 'analyzeCommits', param: 'analyzeCommits_cli'},
     branch: 'branch_cli',
+    repositoryUrl: 'http://cli-url.com/owner/package',
+    tagFormat: `cli\${version}`,
+    plugins: false,
   };
-  const pkg = {name: 'package_name', release};
-
-  // Create a git repository, set the current working directory at the root of the repo
-  await gitRepo();
+  const pkg = {release: pkgOptions, repository: 'git@host.null:owner/module.git'};
   // Create package.json in repository root
-  await writeJson('./package.json', pkg);
-  delete process.env.GH_TOKEN;
-  process.env.GITHUB_TOKEN = 'GITHUB_TOKEN';
+  await outputJson(path.resolve(cwd, 'package.json'), pkg);
 
-  const result = await t.context.getConfig(options);
+  const result = await t.context.getConfig({cwd}, options);
 
-  // Verify the options contains the plugin config from cli
-  t.deepEqual(result.options.getLastRelease, options.getLastRelease);
-  t.is(result.options.branch, options.branch);
-
-  // Verify the plugins module is called with the plugin options from cli
-  t.deepEqual(t.context.plugins.firstCall.args[0].getLastRelease, options.getLastRelease);
-  t.is(t.context.plugins.firstCall.args[0].branch, options.branch);
+  // Verify the options contains the plugin config from CLI/API
+  t.deepEqual(result.options, options);
+  // Verify the plugins module is called with the plugin options from CLI/API
+  t.deepEqual(t.context.plugins.args[0][0], {cwd, options});
 });
 
-test.serial('Get tag from .npmrc', async t => {
-  const pkg = {name: 'package_name'};
-
+test('Read configuration from file path in "extends"', async t => {
   // Create a git repository, set the current working directory at the root of the repo
-  await gitRepo();
-  // Create package.json in repository root
-  await writeJson('./package.json', pkg);
-  // Create local .npmrc
-  await writeFile('.npmrc', 'tag=npmrc_tag');
+  const {cwd} = await gitRepo();
+  const pkgOptions = {extends: './shareable.json'};
+  const options = {
+    analyzeCommits: {path: 'analyzeCommits', param: 'analyzeCommits_param'},
+    generateNotes: 'generateNotes',
+    branch: 'test_branch',
+    repositoryUrl: 'https://host.null/owner/module.git',
+    tagFormat: `v\${version}`,
+    plugins: ['plugin-1', ['plugin-2', {plugin2Opt: 'value'}]],
+  };
+  // Create package.json and shareable.json in repository root
+  await outputJson(path.resolve(cwd, 'package.json'), {release: pkgOptions});
+  await outputJson(path.resolve(cwd, 'shareable.json'), options);
 
-  // Make sure to not use the environment variable set by npm when running tests with npm run test
-  delete process.env.npm_config_tag;
-  const result = await t.context.getConfig();
+  const {options: result} = await t.context.getConfig({cwd});
 
-  // Verify the tag used in the one in .npmrc
-  t.is(result.npm.tag, 'npmrc_tag');
+  // Verify the options contains the plugin config from shareable.json
+  t.deepEqual(result, options);
+  // Verify the plugins module is called with the plugin options from shareable.json
+  t.deepEqual(t.context.plugins.args[0][0], {cwd, options});
+  t.deepEqual(t.context.plugins.args[0][1], {
+    analyzeCommits: './shareable.json',
+    generateNotes: './shareable.json',
+    'plugin-1': './shareable.json',
+    'plugin-2': './shareable.json',
+  });
 });
 
-test.serial('Get tag from package.json, even if defined in .npmrc', async t => {
-  const publishConfig = {tag: 'pkg_tag'};
-  const pkg = {name: 'package_name', publishConfig};
-
+test('Read configuration from module path in "extends"', async t => {
   // Create a git repository, set the current working directory at the root of the repo
-  await gitRepo();
-  // Create package.json in repository root
-  await writeJson('./package.json', pkg);
-  // Create local .npmrc
-  await writeFile('.npmrc', 'tag=npmrc_tag');
+  const {cwd} = await gitRepo();
+  const pkgOptions = {extends: 'shareable'};
+  const options = {
+    analyzeCommits: {path: 'analyzeCommits', param: 'analyzeCommits_param'},
+    generateNotes: 'generateNotes',
+    branch: 'test_branch',
+    repositoryUrl: 'https://host.null/owner/module.git',
+    tagFormat: `v\${version}`,
+    plugins: false,
+  };
+  // Create package.json and shareable.json in repository root
+  await outputJson(path.resolve(cwd, 'package.json'), {release: pkgOptions});
+  await outputJson(path.resolve(cwd, 'node_modules/shareable/index.json'), options);
 
-  const result = await t.context.getConfig();
+  const {options: results} = await t.context.getConfig({cwd});
 
-  // Verify the tag used in the one in package.json
-  t.is(result.npm.tag, 'pkg_tag');
+  // Verify the options contains the plugin config from shareable.json
+  t.deepEqual(results, options);
+  // Verify the plugins module is called with the plugin options from shareable.json
+  t.deepEqual(t.context.plugins.args[0][0], {cwd, options});
+  t.deepEqual(t.context.plugins.args[0][1], {
+    analyzeCommits: 'shareable',
+    generateNotes: 'shareable',
+  });
+});
+
+test('Read configuration from an array of paths in "extends"', async t => {
+  // Create a git repository, set the current working directory at the root of the repo
+  const {cwd} = await gitRepo();
+  const pkgOptions = {extends: ['./shareable1.json', './shareable2.json']};
+  const options1 = {
+    verifyRelease: 'verifyRelease1',
+    analyzeCommits: {path: 'analyzeCommits1', param: 'analyzeCommits_param1'},
+    branch: 'test_branch',
+    repositoryUrl: 'https://host.null/owner/module.git',
+  };
+  const options2 = {
+    verifyRelease: 'verifyRelease2',
+    generateNotes: 'generateNotes2',
+    analyzeCommits: {path: 'analyzeCommits2', param: 'analyzeCommits_param2'},
+    branch: 'test_branch',
+    tagFormat: `v\${version}`,
+    plugins: false,
+  };
+  // Create package.json and shareable.json in repository root
+  await outputJson(path.resolve(cwd, 'package.json'), {release: pkgOptions});
+  await outputJson(path.resolve(cwd, 'shareable1.json'), options1);
+  await outputJson(path.resolve(cwd, 'shareable2.json'), options2);
+
+  const {options: results} = await t.context.getConfig({cwd});
+
+  // Verify the options contains the plugin config from shareable1.json and shareable2.json
+  t.deepEqual(results, {...options1, ...options2});
+  // Verify the plugins module is called with the plugin options from shareable1.json and shareable2.json
+  t.deepEqual(t.context.plugins.args[0][0], {cwd, options: {...options1, ...options2}});
+  t.deepEqual(t.context.plugins.args[0][1], {
+    verifyRelease1: './shareable1.json',
+    verifyRelease2: './shareable2.json',
+    generateNotes2: './shareable2.json',
+    analyzeCommits1: './shareable1.json',
+    analyzeCommits2: './shareable2.json',
+  });
+});
+
+test('Prioritize configuration from config file over "extends"', async t => {
+  // Create a git repository, set the current working directory at the root of the repo
+  const {cwd} = await gitRepo();
+  const pkgOptions = {
+    extends: './shareable.json',
+    branch: 'test_pkg',
+    generateNotes: 'generateNotes',
+    publish: [{path: 'publishPkg', param: 'publishPkg_param'}],
+  };
+  const options1 = {
+    analyzeCommits: 'analyzeCommits',
+    generateNotes: 'generateNotesShareable',
+    publish: [{path: 'publishShareable', param: 'publishShareable_param'}],
+    branch: 'test_branch',
+    repositoryUrl: 'https://host.null/owner/module.git',
+    tagFormat: `v\${version}`,
+    plugins: false,
+  };
+  // Create package.json and shareable.json in repository root
+  await outputJson(path.resolve(cwd, 'package.json'), {release: pkgOptions});
+  await outputJson(path.resolve(cwd, 'shareable.json'), options1);
+
+  const {options} = await t.context.getConfig({cwd});
+
+  // Verify the options contains the plugin config from package.json and shareable.json
+  t.deepEqual(options, omit({...options1, ...pkgOptions}, 'extends'));
+  // Verify the plugins module is called with the plugin options from package.json and shareable.json
+  t.deepEqual(t.context.plugins.args[0][0], {cwd, options: omit({...options, ...pkgOptions}, 'extends')});
+  t.deepEqual(t.context.plugins.args[0][1], {
+    analyzeCommits: './shareable.json',
+    generateNotesShareable: './shareable.json',
+    publishShareable: './shareable.json',
+  });
+});
+
+test('Prioritize configuration from cli/API options over "extends"', async t => {
+  // Create a git repository, set the current working directory at the root of the repo
+  const {cwd} = await gitRepo();
+  const cliOptions = {
+    extends: './shareable2.json',
+    branch: 'branch_opts',
+    publish: [{path: 'publishOpts', param: 'publishOpts_param'}],
+    repositoryUrl: 'https://host.null/owner/module.git',
+  };
+  const pkgOptions = {
+    extends: './shareable1.json',
+    branch: 'branch_pkg',
+    generateNotes: 'generateNotes',
+    publish: [{path: 'publishPkg', param: 'publishPkg_param'}],
+  };
+  const options1 = {
+    analyzeCommits: 'analyzeCommits1',
+    generateNotes: 'generateNotesShareable1',
+    publish: [{path: 'publishShareable', param: 'publishShareable_param1'}],
+    branch: 'test_branch1',
+    repositoryUrl: 'https://host.null/owner/module.git',
+  };
+  const options2 = {
+    analyzeCommits: 'analyzeCommits2',
+    publish: [{path: 'publishShareable', param: 'publishShareable_param2'}],
+    branch: 'test_branch2',
+    tagFormat: `v\${version}`,
+    plugins: false,
+  };
+  // Create package.json, shareable1.json and shareable2.json in repository root
+  await outputJson(path.resolve(cwd, 'package.json'), {release: pkgOptions});
+  await outputJson(path.resolve(cwd, 'shareable1.json'), options1);
+  await outputJson(path.resolve(cwd, 'shareable2.json'), options2);
+
+  const {options} = await t.context.getConfig({cwd}, cliOptions);
+
+  // Verify the options contains the plugin config from package.json and shareable2.json
+  t.deepEqual(options, omit({...options2, ...pkgOptions, ...cliOptions}, 'extends'));
+  // Verify the plugins module is called with the plugin options from package.json and shareable2.json
+  t.deepEqual(t.context.plugins.args[0][0], {
+    cwd,
+    options: omit({...options2, ...pkgOptions, ...cliOptions}, 'extends'),
+  });
+});
+
+test('Allow to unset properties defined in shareable config with "null"', async t => {
+  // Create a git repository, set the current working directory at the root of the repo
+  const {cwd} = await gitRepo();
+  const pkgOptions = {
+    extends: './shareable.json',
+    analyzeCommits: null,
+    branch: 'test_branch',
+    repositoryUrl: 'https://host.null/owner/module.git',
+    plugins: null,
+  };
+  const options1 = {
+    generateNotes: 'generateNotes',
+    analyzeCommits: {path: 'analyzeCommits', param: 'analyzeCommits_param'},
+    tagFormat: `v\${version}`,
+    plugins: ['test-plugin'],
+  };
+  // Create package.json and shareable.json in repository root
+  await outputJson(path.resolve(cwd, 'package.json'), {release: pkgOptions});
+  await outputJson(path.resolve(cwd, 'shareable.json'), options1);
+
+  const {options} = await t.context.getConfig({cwd});
+
+  // Verify the options contains the plugin config from shareable.json and the default `plugins`
+  t.deepEqual(options, {
+    ...omit(options1, ['analyzeCommits']),
+    ...omit(pkgOptions, ['extends', 'analyzeCommits']),
+    plugins: DEFAULT_PLUGINS,
+  });
+  // Verify the plugins module is called with the plugin options from shareable.json and the default `plugins`
+  t.deepEqual(t.context.plugins.args[0][0], {
+    options: {
+      ...omit(options1, 'analyzeCommits'),
+      ...omit(pkgOptions, ['extends', 'analyzeCommits']),
+      plugins: DEFAULT_PLUGINS,
+    },
+    cwd,
+  });
+  t.deepEqual(t.context.plugins.args[0][1], {
+    generateNotes: './shareable.json',
+    analyzeCommits: './shareable.json',
+    'test-plugin': './shareable.json',
+  });
+});
+
+test('Allow to unset properties defined in shareable config with "undefined"', async t => {
+  // Create a git repository, set the current working directory at the root of the repo
+  const {cwd} = await gitRepo();
+  const pkgOptions = {
+    extends: './shareable.json',
+    analyzeCommits: undefined,
+    branch: 'test_branch',
+    repositoryUrl: 'https://host.null/owner/module.git',
+  };
+  const options1 = {
+    generateNotes: 'generateNotes',
+    analyzeCommits: {path: 'analyzeCommits', param: 'analyzeCommits_param'},
+    tagFormat: `v\${version}`,
+    plugins: false,
+  };
+  // Create package.json and release.config.js in repository root
+  await writeFile(path.resolve(cwd, 'release.config.js'), `module.exports = ${format(pkgOptions)}`);
+  await outputJson(path.resolve(cwd, 'shareable.json'), options1);
+
+  const {options} = await t.context.getConfig({cwd});
+
+  // Verify the options contains the plugin config from shareable.json
+  t.deepEqual(options, {...omit(options1, 'analyzeCommits'), ...omit(pkgOptions, ['extends', 'analyzeCommits'])});
+  // Verify the plugins module is called with the plugin options from shareable.json
+  t.deepEqual(t.context.plugins.args[0][0], {
+    options: {
+      ...omit(options1, 'analyzeCommits'),
+      ...omit(pkgOptions, ['extends', 'analyzeCommits']),
+    },
+    cwd,
+  });
+  t.deepEqual(t.context.plugins.args[0][1], {
+    generateNotes: './shareable.json',
+    analyzeCommits: './shareable.json',
+  });
+});
+
+test('Throw an Error if one of the shareable config cannot be found', async t => {
+  // Create a git repository, set the current working directory at the root of the repo
+  const {cwd} = await gitRepo();
+  const pkhOptions = {extends: ['./shareable1.json', 'non-existing-path']};
+  const options1 = {analyzeCommits: 'analyzeCommits'};
+  // Create package.json and shareable.json in repository root
+  await outputJson(path.resolve(cwd, 'package.json'), {release: pkhOptions});
+  await outputJson(path.resolve(cwd, 'shareable1.json'), options1);
+
+  const error = await t.throwsAsync(t.context.getConfig({cwd}), Error);
+
+  t.is(error.message, "Cannot find module 'non-existing-path'");
+  t.is(error.code, 'MODULE_NOT_FOUND');
 });

test/get-git-auth-url.test.js

@@ -0,0 +1,293 @@
+import test from 'ava';
+import getAuthUrl from '../lib/get-git-auth-url';
+import {gitRepo} from './helpers/git-utils';
+
+const env = {GIT_ASKPASS: 'echo', GIT_TERMINAL_PROMPT: 0};
+
+test('Return the same "git" formatted URL if "gitCredentials" is not defined', async t => {
+  const {cwd} = await gitRepo();
+
+  t.is(
+    await getAuthUrl({cwd, env, options: {branch: 'master', repositoryUrl: 'git@host.null:owner/repo.git'}}),
+    'git@host.null:owner/repo.git'
+  );
+});
+
+test('Return the same "https" formatted URL if "gitCredentials" is not defined', async t => {
+  const {cwd} = await gitRepo();
+
+  t.is(
+    await getAuthUrl({cwd, env, options: {branch: 'master', repositoryUrl: 'https://host.null/owner/repo.git'}}),
+    'https://host.null/owner/repo.git'
+  );
+});
+
+test('Return the "https" formatted URL if "gitCredentials" is not defined and repositoryUrl is a "git+https" URL', async t => {
+  const {cwd} = await gitRepo();
+
+  t.is(
+    await getAuthUrl({cwd, env, options: {branch: 'master', repositoryUrl: 'git+https://host.null/owner/repo.git'}}),
+    'https://host.null/owner/repo.git'
+  );
+});
+
+test('Do not add trailing ".git" if not present in the origian URL', async t => {
+  const {cwd} = await gitRepo();
+
+  t.is(
+    await getAuthUrl({cwd, env, options: {branch: 'master', repositoryUrl: 'git@host.null:owner/repo'}}),
+    'git@host.null:owner/repo'
+  );
+});
+
+test('Handle "https" URL with group and subgroup', async t => {
+  const {cwd} = await gitRepo();
+
+  t.is(
+    await getAuthUrl({
+      cwd,
+      env,
+      options: {branch: 'master', repositoryUrl: 'https://host.null/group/subgroup/owner/repo.git'},
+    }),
+    'https://host.null/group/subgroup/owner/repo.git'
+  );
+});
+
+test('Handle "git" URL with group and subgroup', async t => {
+  const {cwd} = await gitRepo();
+
+  t.is(
+    await getAuthUrl({
+      cwd,
+      env,
+      options: {branch: 'master', repositoryUrl: 'git@host.null:group/subgroup/owner/repo.git'},
+    }),
+    'git@host.null:group/subgroup/owner/repo.git'
+  );
+});
+
+test('Convert shorthand URL', async t => {
+  const {cwd} = await gitRepo();
+
+  t.is(
+    await getAuthUrl({cwd, env, options: {repositoryUrl: 'semanitc-release/semanitc-release'}}),
+    'https://github.com/semanitc-release/semanitc-release.git'
+  );
+});
+
+test('Convert GitLab shorthand URL', async t => {
+  const {cwd} = await gitRepo();
+
+  t.is(
+    await getAuthUrl({
+      cwd,
+      env,
+      options: {branch: 'master', repositoryUrl: 'gitlab:semanitc-release/semanitc-release'},
+    }),
+    'https://gitlab.com/semanitc-release/semanitc-release.git'
+  );
+});
+
+test('Return the "https" formatted URL if "gitCredentials" is defined and repositoryUrl is a "git" URL', async t => {
+  const {cwd} = await gitRepo();
+
+  t.is(
+    await getAuthUrl({
+      cwd,
+      env: {...env, GIT_CREDENTIALS: 'user:pass'},
+      options: {branch: 'master', repositoryUrl: 'git@host.null:owner/repo.git'},
+    }),
+    'https://user:pass@host.null/owner/repo.git'
+  );
+});
+
+test('Return the "https" formatted URL if "gitCredentials" is defined and repositoryUrl is a "git" URL without user', async t => {
+  const {cwd} = await gitRepo();
+
+  t.is(
+    await getAuthUrl({
+      cwd,
+      env: {...env, GIT_CREDENTIALS: 'user:pass'},
+      options: {branch: 'master', repositoryUrl: 'host.null:owner/repo.git'},
+    }),
+    'https://user:pass@host.null/owner/repo.git'
+  );
+});
+
+test('Return the "https" formatted URL if "gitCredentials" is defined and repositoryUrl is a "https" URL', async t => {
+  const {cwd} = await gitRepo();
+
+  t.is(
+    await getAuthUrl({
+      cwd,
+      env: {...env, GIT_CREDENTIALS: 'user:pass'},
+      options: {branch: 'master', repositoryUrl: 'https://host.null/owner/repo.git'},
+    }),
+    'https://user:pass@host.null/owner/repo.git'
+  );
+});
+
+test('Return the "http" formatted URL if "gitCredentials" is defined and repositoryUrl is a "http" URL', async t => {
+  const {cwd} = await gitRepo();
+
+  t.is(
+    await getAuthUrl({
+      cwd,
+      env: {...env, GIT_CREDENTIALS: 'user:pass'},
+      options: {branch: 'master', repositoryUrl: 'http://host.null/owner/repo.git'},
+    }),
+    'http://user:pass@host.null/owner/repo.git'
+  );
+});
+
+test('Return the "https" formatted URL if "gitCredentials" is defined and repositoryUrl is a "git+https" URL', async t => {
+  const {cwd} = await gitRepo();
+
+  t.is(
+    await getAuthUrl({
+      cwd,
+      env: {...env, GIT_CREDENTIALS: 'user:pass'},
+      options: {branch: 'master', repositoryUrl: 'git+https://host.null/owner/repo.git'},
+    }),
+    'https://user:pass@host.null/owner/repo.git'
+  );
+});
+
+test('Return the "http" formatted URL if "gitCredentials" is defined and repositoryUrl is a "git+http" URL', async t => {
+  const {cwd} = await gitRepo();
+
+  t.is(
+    await getAuthUrl({
+      cwd,
+      env: {...env, GIT_CREDENTIALS: 'user:pass'},
+      options: {branch: 'master', repositoryUrl: 'git+http://host.null/owner/repo.git'},
+    }),
+    'http://user:pass@host.null/owner/repo.git'
+  );
+});
+
+test('Return the "https" formatted URL if "gitCredentials" is defined with "GH_TOKEN"', async t => {
+  const {cwd} = await gitRepo();
+
+  t.is(
+    await getAuthUrl({
+      cwd,
+      env: {...env, GH_TOKEN: 'token'},
+      options: {branch: 'master', repositoryUrl: 'git@host.null:owner/repo.git'},
+    }),
+    'https://token@host.null/owner/repo.git'
+  );
+});
+
+test('Return the "https" formatted URL if "gitCredentials" is defined with "GITHUB_TOKEN"', async t => {
+  const {cwd} = await gitRepo();
+
+  t.is(
+    await getAuthUrl({
+      cwd,
+      env: {...env, GITHUB_TOKEN: 'token'},
+      options: {branch: 'master', repositoryUrl: 'git@host.null:owner/repo.git'},
+    }),
+    'https://token@host.null/owner/repo.git'
+  );
+});
+
+test('Return the "https" formatted URL if "gitCredentials" is defined with "GL_TOKEN"', async t => {
+  const {cwd} = await gitRepo();
+
+  t.is(
+    await getAuthUrl({
+      cwd,
+      env: {...env, GL_TOKEN: 'token'},
+      options: {branch: 'master', repositoryUrl: 'git@host.null:owner/repo.git'},
+    }),
+    'https://gitlab-ci-token:token@host.null/owner/repo.git'
+  );
+});
+
+test('Return the "https" formatted URL if "gitCredentials" is defined with "GITLAB_TOKEN"', async t => {
+  const {cwd} = await gitRepo();
+
+  t.is(
+    await getAuthUrl({
+      cwd,
+      env: {...env, GITLAB_TOKEN: 'token'},
+      options: {branch: 'master', repositoryUrl: 'git@host.null:owner/repo.git'},
+    }),
+    'https://gitlab-ci-token:token@host.null/owner/repo.git'
+  );
+});
+
+test('Return the "https" formatted URL if "gitCredentials" is defined with "BB_TOKEN"', async t => {
+  const {cwd} = await gitRepo();
+
+  t.is(
+    await getAuthUrl({
+      cwd,
+      env: {...env, BB_TOKEN: 'token'},
+      options: {branch: 'master', repositoryUrl: 'git@host.null:owner/repo.git'},
+    }),
+    'https://x-token-auth:token@host.null/owner/repo.git'
+  );
+});
+
+test('Return the "https" formatted URL if "gitCredentials" is defined with "BITBUCKET_TOKEN"', async t => {
+  const {cwd} = await gitRepo();
+
+  t.is(
+    await getAuthUrl({
+      cwd,
+      env: {...env, BITBUCKET_TOKEN: 'token'},
+      options: {branch: 'master', repositoryUrl: 'git@host.null:owner/repo.git'},
+    }),
+    'https://x-token-auth:token@host.null/owner/repo.git'
+  );
+});
+
+test('Return the "https" formatted URL if "GITHUB_ACTION" is set', async t => {
+  const {cwd} = await gitRepo();
+
+  t.is(
+    await getAuthUrl({
+      cwd,
+      env: {...env, GITHUB_ACTION: 'foo', GITHUB_TOKEN: 'token'},
+      options: {branch: 'master', repositoryUrl: 'git@host.null:owner/repo.git'},
+    }),
+    'https://x-access-token:token@host.null/owner/repo.git'
+  );
+});
+
+test('Handle "https" URL with group and subgroup, with "GIT_CREDENTIALS"', async t => {
+  const {cwd} = await gitRepo();
+
+  t.is(
+    await getAuthUrl({
+      cwd,
+      env: {...env, GIT_CREDENTIALS: 'user:pass'},
+      options: {branch: 'master', repositoryUrl: 'https://host.null/group/subgroup/owner/repo.git'},
+    }),
+    'https://user:pass@host.null/group/subgroup/owner/repo.git'
+  );
+});
+
+test('Handle "git" URL with group and subgroup, with "GIT_CREDENTIALS', async t => {
+  const {cwd} = await gitRepo();
+
+  t.is(
+    await getAuthUrl({
+      cwd,
+      env: {...env, GIT_CREDENTIALS: 'user:pass'},
+      options: {branch: 'master', repositoryUrl: 'git@host.null:group/subgroup/owner/repo.git'},
+    }),
+    'https://user:pass@host.null/group/subgroup/owner/repo.git'
+  );
+});
+
+test('Do not add git credential to repositoryUrl if push is allowed', async t => {
+  const {cwd, repositoryUrl} = await gitRepo(true);
+
+  t.is(
+    await getAuthUrl({cwd, env: {...env, GIT_CREDENTIALS: 'user:pass'}, options: {branch: 'master', repositoryUrl}}),
+    repositoryUrl
+  );
+});

test/get-last-release.test.js

@@ -0,0 +1,151 @@
+import test from 'ava';
+import {stub} from 'sinon';
+import getLastRelease from '../lib/get-last-release';
+import {gitRepo, gitCommits, gitTagVersion, gitCheckout} from './helpers/git-utils';
+
+test.beforeEach(t => {
+  // Stub the logger functions
+  t.context.log = stub();
+  t.context.logger = {log: t.context.log};
+});
+
+test('Get the highest non-prerelease valid tag', async t => {
+  // Create a git repository, set the current working directory at the root of the repo
+  const {cwd} = await gitRepo();
+  // Create some commits and tags
+  await gitCommits(['First'], {cwd});
+  await gitTagVersion('foo', undefined, {cwd});
+  const commits = await gitCommits(['Second'], {cwd});
+  await gitTagVersion('v2.0.0', undefined, {cwd});
+  await gitCommits(['Third'], {cwd});
+  await gitTagVersion('v1.0.0', undefined, {cwd});
+  await gitCommits(['Fourth'], {cwd});
+  await gitTagVersion('v3.0', undefined, {cwd});
+  await gitCommits(['Fifth'], {cwd});
+  await gitTagVersion('v3.0.0-beta.1', undefined, {cwd});
+
+  const result = await getLastRelease({cwd, options: {tagFormat: `v\${version}`}, logger: t.context.logger});
+
+  t.deepEqual(result, {gitHead: commits[0].hash, gitTag: 'v2.0.0', version: '2.0.0'});
+  t.deepEqual(t.context.log.args[0], ['Found git tag v2.0.0 associated with version 2.0.0']);
+});
+
+test('Get the highest tag in the history of the current branch', async t => {
+  // Create a git repository, set the current working directory at the root of the repo
+  const {cwd} = await gitRepo();
+  // Add commit to the master branch
+  await gitCommits(['First'], {cwd});
+  // Create the tag corresponding to version 1.0.0
+  // Create the new branch 'other-branch' from master
+  await gitCheckout('other-branch', true, {cwd});
+  // Add commit to the 'other-branch' branch
+  await gitCommits(['Second'], {cwd});
+  // Create the tag corresponding to version 3.0.0
+  await gitTagVersion('v3.0.0', undefined, {cwd});
+  // Checkout master
+  await gitCheckout('master', false, {cwd});
+  // Add another commit to the master branch
+  const commits = await gitCommits(['Third'], {cwd});
+  // Create the tag corresponding to version 2.0.0
+  await gitTagVersion('v2.0.0', undefined, {cwd});
+
+  const result = await getLastRelease({cwd, options: {tagFormat: `v\${version}`}, logger: t.context.logger});
+
+  t.deepEqual(result, {gitHead: commits[0].hash, gitTag: 'v2.0.0', version: '2.0.0'});
+});
+
+test('Match the tag name from the begining of the string', async t => {
+  // Create a git repository, set the current working directory at the root of the repo
+  const {cwd} = await gitRepo();
+  const commits = await gitCommits(['First'], {cwd});
+  await gitTagVersion('prefix/v1.0.0', undefined, {cwd});
+  await gitTagVersion('prefix/v2.0.0', undefined, {cwd});
+  await gitTagVersion('other-prefix/v3.0.0', undefined, {cwd});
+
+  const result = await getLastRelease({cwd, options: {tagFormat: `prefix/v\${version}`}, logger: t.context.logger});
+
+  t.deepEqual(result, {gitHead: commits[0].hash, gitTag: 'prefix/v2.0.0', version: '2.0.0'});
+});
+
+test('Return empty object if no valid tag is found', async t => {
+  // Create a git repository, set the current working directory at the root of the repo
+  const {cwd} = await gitRepo();
+  // Create some commits and tags
+  await gitCommits(['First'], {cwd});
+  await gitTagVersion('foo', undefined, {cwd});
+  await gitCommits(['Second'], {cwd});
+  await gitTagVersion('v2.0.x', undefined, {cwd});
+  await gitCommits(['Third'], {cwd});
+  await gitTagVersion('v3.0', undefined, {cwd});
+
+  const result = await getLastRelease({cwd, options: {tagFormat: `v\${version}`}, logger: t.context.logger});
+
+  t.deepEqual(result, {});
+  t.is(t.context.log.args[0][0], 'No git tag version found');
+});
+
+test('Return empty object if no valid tag is found in history', async t => {
+  // Create a git repository, set the current working directory at the root of the repo
+  const {cwd} = await gitRepo();
+  await gitCommits(['First'], {cwd});
+  await gitCheckout('other-branch', true, {cwd});
+  await gitCommits(['Second'], {cwd});
+  await gitTagVersion('v1.0.0', undefined, {cwd});
+  await gitTagVersion('v2.0.0', undefined, {cwd});
+  await gitTagVersion('v3.0.0', undefined, {cwd});
+  await gitCheckout('master', false, {cwd});
+
+  const result = await getLastRelease({cwd, options: {tagFormat: `v\${version}`}, logger: t.context.logger});
+
+  t.deepEqual(result, {});
+  t.is(t.context.log.args[0][0], 'No git tag version found');
+});
+
+test('Get the highest valid tag corresponding to the "tagFormat"', async t => {
+  // Create a git repository, set the current working directory at the root of the repo
+  const {cwd} = await gitRepo();
+  // Create some commits and tags
+  const [{hash: gitHead}] = await gitCommits(['First'], {cwd});
+
+  await gitTagVersion('1.0.0', undefined, {cwd});
+  t.deepEqual(await getLastRelease({cwd, options: {tagFormat: `\${version}`}, logger: t.context.logger}), {
+    gitHead,
+    gitTag: '1.0.0',
+    version: '1.0.0',
+  });
+
+  await gitTagVersion('foo-1.0.0-bar', undefined, {cwd});
+  t.deepEqual(await getLastRelease({cwd, options: {tagFormat: `foo-\${version}-bar`}, logger: t.context.logger}), {
+    gitHead,
+    gitTag: 'foo-1.0.0-bar',
+    version: '1.0.0',
+  });
+
+  await gitTagVersion('foo-v1.0.0-bar', undefined, {cwd});
+  t.deepEqual(await getLastRelease({cwd, options: {tagFormat: `foo-v\${version}-bar`}, logger: t.context.logger}), {
+    gitHead,
+    gitTag: 'foo-v1.0.0-bar',
+    version: '1.0.0',
+  });
+
+  await gitTagVersion('(.+)/1.0.0/(a-z)', undefined, {cwd});
+  t.deepEqual(await getLastRelease({cwd, options: {tagFormat: `(.+)/\${version}/(a-z)`}, logger: t.context.logger}), {
+    gitHead,
+    gitTag: '(.+)/1.0.0/(a-z)',
+    version: '1.0.0',
+  });
+
+  await gitTagVersion('2.0.0-1.0.0-bar.1', undefined, {cwd});
+  t.deepEqual(await getLastRelease({cwd, options: {tagFormat: `2.0.0-\${version}-bar.1`}, logger: t.context.logger}), {
+    gitHead,
+    gitTag: '2.0.0-1.0.0-bar.1',
+    version: '1.0.0',
+  });
+
+  await gitTagVersion('3.0.0-bar.1', undefined, {cwd});
+  t.deepEqual(await getLastRelease({cwd, options: {tagFormat: `\${version}-bar.1`}, logger: t.context.logger}), {
+    gitHead,
+    gitTag: '3.0.0-bar.1',
+    version: '3.0.0',
+  });
+});

test/get-logger.test.js

@@ -0,0 +1,17 @@
+import test from 'ava';
+import {spy} from 'sinon';
+import getLogger from '../lib/get-logger';
+
+test('Expose "error", "success" and "log" functions', t => {
+  const stdout = spy();
+  const stderr = spy();
+  const logger = getLogger({stdout: {write: stdout}, stderr: {write: stderr}});
+
+  logger.log('test log');
+  logger.success('test success');
+  logger.error('test error');
+
+  t.regex(stdout.args[0][0], /.*test log/);
+  t.regex(stdout.args[1][0], /.*test success/);
+  t.regex(stderr.args[0][0], /.*test error/);
+});

test/get-next-version.test.js

@@ -1,36 +1,41 @@
 import test from 'ava';
 import {stub} from 'sinon';
-import proxyquire from 'proxyquire';
-import SemanticReleaseError from '@semantic-release/error';
+import getNextVersion from '../lib/get-next-version';
 
 test.beforeEach(t => {
   // Stub the logger functions
   t.context.log = stub();
-  t.context.getNextVersion = proxyquire('../src/lib/get-next-version', {'./logger': {log: t.context.log}});
+  t.context.logger = {log: t.context.log};
 });
 
 test('Increase version for patch release', t => {
-  const version = t.context.getNextVersion('patch', {version: '1.0.0'});
+  const version = getNextVersion({
+    nextRelease: {type: 'patch'},
+    lastRelease: {version: '1.0.0'},
+    logger: t.context.logger,
+  });
   t.is(version, '1.0.1');
 });
 
 test('Increase version for minor release', t => {
-  const version = t.context.getNextVersion('minor', {version: '1.0.0'});
+  const version = getNextVersion({
+    nextRelease: {type: 'minor'},
+    lastRelease: {version: '1.0.0'},
+    logger: t.context.logger,
+  });
   t.is(version, '1.1.0');
 });
 
 test('Increase version for major release', t => {
-  const version = t.context.getNextVersion('major', {version: '1.0.0'});
+  const version = getNextVersion({
+    nextRelease: {type: 'major'},
+    lastRelease: {version: '1.0.0'},
+    logger: t.context.logger,
+  });
   t.is(version, '2.0.0');
 });
 
 test('Return 1.0.0 if there is no previous release', t => {
-  const version = t.context.getNextVersion('minor', {});
+  const version = getNextVersion({nextRelease: {type: 'minor'}, lastRelease: {}, logger: t.context.logger});
   t.is(version, '1.0.0');
 });
-
-test('Return an error if the release type is invalid', t => {
-  const error = t.throws(() => t.context.getNextVersion('invalid', {version: '1.0.0'}));
-  t.is(error.code, 'EINVALIDTYPE');
-  t.true(error instanceof SemanticReleaseError);
-});

test/get-registry.test.js

@@ -1,82 +0,0 @@
-import test from 'ava';
-import {stub} from 'sinon';
-const getRegistry = require('../src/lib/get-registry');
-
-test('Get registry from package.json', t => {
-  // Retrieve the registry with the get-registry module and verify it returns the one from the package.json in parameter
-  t.is(getRegistry({name: 'publish-config', publishConfig: {registry: 'a'}}, {}), 'a');
-});
-
-test('Prioritize the package.json registry config', t => {
-  // Stub the npmconf object
-  const get = stub();
-
-  // Retrieve the registry with the get-registry module and verify it returns the one from the package.json in parameter
-  t.is(getRegistry({name: 'publish-config', publishConfig: {registry: 'b'}}, {get}), 'b');
-
-  // Verify the registry has been retrieved from the package.json without trying the stubbed npmconf
-  t.true(get.notCalled);
-});
-
-test('Get registry for regular package name', t => {
-  // Stub the npmconf object returns 'b' for 'registry' property
-  const get = stub()
-    .withArgs('registry')
-    .returns('b');
-
-  // Retrieve the registry with the get-registry module and verify it returns the one configured in the stubbed npmconf
-  t.is(getRegistry({name: 'normal'}, {get}), 'b');
-
-  // Verify the registry has been retrieved by calling the stubbed npmconf
-  t.true(get.calledWithExactly('registry'));
-});
-
-test('Get default registry', t => {
-  // Stub the npmconf object, returns 'null'
-  const get = stub().returns(null);
-
-  // Retrieve the registry with the get-registry module and verify it returns default one
-  t.is(getRegistry({name: 'normal'}, {get}), 'https://registry.npmjs.org/');
-
-  // Verify the module tried first to retrieve the registry by calling the stubbed npmconf
-  t.true(get.calledWithExactly('registry'));
-});
-
-test('Get registry for scoped package name', t => {
-  // Stub the npmconf object, returns 'c' for '@scoped/registry' property
-  const get = stub()
-    .withArgs('@scoped/registry')
-    .returns('c');
-
-  // Retrieve the registry with the get-registry module and verify it returns the one configured in the stubbed npmconf
-  t.is(getRegistry({name: '@scoped/foo'}, {get}), 'c');
-
-  // Verify the registry for the scope '@scoped' has been retrieved by calling the stubbed npmconf
-  t.true(get.calledWithExactly('@scoped/registry'));
-});
-
-test('Get regular registry for scoped package name', t => {
-  // Stub the npmconf object, returns 'd' for 'registry' property
-  const get = stub()
-    .withArgs('registry')
-    .returns('d');
-
-  // Retrieve the registry with the get-registry module and verify it returns the regular default one for `@scoped` packages
-  t.is(getRegistry({name: '@scoped/baz'}, {get}), 'd');
-
-  // Verify the module tried to retrieve the @scoped registry by calling the stubbed npmconf
-  t.true(get.calledWithExactly('@scoped/registry'));
-});
-
-test('Get default registry for scoped package name', t => {
-  // Stub the npmconf object, returns 'd' for 'registry' property
-  const get = stub().returns(null);
-
-  // Retrieve the registry with the get-registry module and verify it returns default one for `@scoped` packages
-  t.is(getRegistry({name: '@scoped/baz'}, {get}), 'https://registry.npmjs.org/');
-
-  // Verify the module tried to retrieve the @scoped registry by calling the stubbed npmconf
-  t.true(get.calledWithExactly('@scoped/registry'));
-  // Verify the module tried to retrieve the regular registry by calling the stubbed npmconf
-  t.true(get.calledWithExactly('registry'));
-});

test/git.test.js

@@ -0,0 +1,242 @@
+import test from 'ava';
+import tempy from 'tempy';
+import {
+  getTagHead,
+  isRefInHistory,
+  fetch,
+  getGitHead,
+  repoUrl,
+  tag,
+  push,
+  getTags,
+  isGitRepo,
+  verifyTagName,
+  isBranchUpToDate,
+} from '../lib/git';
+import {
+  gitRepo,
+  gitCommits,
+  gitCheckout,
+  gitTagVersion,
+  gitShallowClone,
+  gitGetCommits,
+  gitAddConfig,
+  gitCommitTag,
+  gitRemoteTagHead,
+  gitPush,
+  gitDetachedHead,
+} from './helpers/git-utils';
+
+test('Get the last commit sha', async t => {
+  // Create a git repository, set the current working directory at the root of the repo
+  const {cwd} = await gitRepo();
+  // Add commits to the master branch
+  const commits = await gitCommits(['First'], {cwd});
+
+  const result = await getGitHead({cwd});
+
+  t.is(result, commits[0].hash);
+});
+
+test('Throw error if the last commit sha cannot be found', async t => {
+  // Create a git repository, set the current working directory at the root of the repo
+  const {cwd} = await gitRepo();
+
+  await t.throwsAsync(getGitHead({cwd}), Error);
+});
+
+test('Unshallow and fetch repository', async t => {
+  // Create a git repository, set the current working directory at the root of the repo
+  let {cwd, repositoryUrl} = await gitRepo();
+  // Add commits to the master branch
+  await gitCommits(['First', 'Second'], {cwd});
+  // Create a shallow clone with only 1 commit
+  cwd = await gitShallowClone(repositoryUrl);
+
+  // Verify the shallow clone contains only one commit
+  t.is((await gitGetCommits(undefined, {cwd})).length, 1);
+
+  await fetch(repositoryUrl, {cwd});
+
+  // Verify the shallow clone contains all the commits
+  t.is((await gitGetCommits(undefined, {cwd})).length, 2);
+});
+
+test('Do not throw error when unshallow a complete repository', async t => {
+  // Create a git repository, set the current working directory at the root of the repo
+  const {cwd, repositoryUrl} = await gitRepo();
+  // Add commits to the master branch
+  await gitCommits(['First'], {cwd});
+  await t.notThrowsAsync(fetch(repositoryUrl, {cwd}));
+});
+
+test('Fetch all tags on a detached head repository', async t => {
+  let {cwd, repositoryUrl} = await gitRepo();
+
+  await gitCommits(['First'], {cwd});
+  await gitTagVersion('v1.0.0', undefined, {cwd});
+  await gitCommits(['Second'], {cwd});
+  await gitTagVersion('v1.0.1', undefined, {cwd});
+  const [commit] = await gitCommits(['Third'], {cwd});
+  await gitTagVersion('v1.1.0', undefined, {cwd});
+  await gitPush(repositoryUrl, 'master', {cwd});
+  cwd = await gitDetachedHead(repositoryUrl, commit.hash);
+
+  await fetch(repositoryUrl, {cwd});
+
+  t.deepEqual((await getTags({cwd})).sort(), ['v1.0.0', 'v1.0.1', 'v1.1.0'].sort());
+});
+
+test('Verify if the commit `sha` is in the direct history of the current branch', async t => {
+  // Create a git repository, set the current working directory at the root of the repo
+  const {cwd} = await gitRepo();
+  // Add commits to the master branch
+  const commits = await gitCommits(['First'], {cwd});
+  // Create the new branch 'other-branch' from master
+  await gitCheckout('other-branch', true, {cwd});
+  // Add commits to the 'other-branch' branch
+  const otherCommits = await gitCommits(['Second'], {cwd});
+  await gitCheckout('master', false, {cwd});
+
+  t.true(await isRefInHistory(commits[0].hash, {cwd}));
+  t.falsy(await isRefInHistory(otherCommits[0].hash, {cwd}));
+  await t.throwsAsync(isRefInHistory('non-existant-sha', {cwd}));
+});
+
+test('Get the commit sha for a given tag or falsy if the tag does not exists', async t => {
+  // Create a git repository, set the current working directory at the root of the repo
+  const {cwd} = await gitRepo();
+  // Add commits to the master branch
+  const commits = await gitCommits(['First'], {cwd});
+  // Create the tag corresponding to version 1.0.0
+  await gitTagVersion('v1.0.0', undefined, {cwd});
+
+  t.is(await getTagHead('v1.0.0', {cwd}), commits[0].hash);
+  t.falsy(await getTagHead('missing_tag', {cwd}));
+});
+
+test('Return git remote repository url from config', async t => {
+  // Create a git repository, set the current working directory at the root of the repo
+  const {cwd} = await gitRepo();
+  // Add remote.origin.url config
+  await gitAddConfig('remote.origin.url', 'git@hostname.com:owner/package.git', {cwd});
+
+  t.is(await repoUrl({cwd}), 'git@hostname.com:owner/package.git');
+});
+
+test('Return git remote repository url set while cloning', async t => {
+  // Create a git repository, set the current working directory at the root of the repo
+  let {cwd, repositoryUrl} = await gitRepo();
+  await gitCommits(['First'], {cwd});
+  // Create a clone
+  cwd = await gitShallowClone(repositoryUrl);
+
+  t.is(await repoUrl({cwd}), repositoryUrl);
+});
+
+test('Return falsy if git repository url is not set', async t => {
+  // Create a git repository, set the current working directory at the root of the repo
+  const {cwd} = await gitRepo();
+
+  t.falsy(await repoUrl({cwd}));
+});
+
+test('Add tag on head commit', async t => {
+  // Create a git repository, set the current working directory at the root of the repo
+  const {cwd} = await gitRepo();
+  const commits = await gitCommits(['Test commit'], {cwd});
+
+  await tag('tag_name', {cwd});
+
+  await t.is(await gitCommitTag(commits[0].hash, {cwd}), 'tag_name');
+});
+
+test('Push tag to remote repository', async t => {
+  // Create a git repository with a remote, set the current working directory at the root of the repo
+  const {cwd, repositoryUrl} = await gitRepo(true);
+  const commits = await gitCommits(['Test commit'], {cwd});
+
+  await tag('tag_name', {cwd});
+  await push(repositoryUrl, {cwd});
+
+  t.is(await gitRemoteTagHead(repositoryUrl, 'tag_name', {cwd}), commits[0].hash);
+});
+
+test('Push tag to remote repository with remote branch ahaed', async t => {
+  const {cwd, repositoryUrl} = await gitRepo(true);
+  const commits = await gitCommits(['First'], {cwd});
+  await gitPush(repositoryUrl, 'master', {cwd});
+  const tmpRepo = await gitShallowClone(repositoryUrl);
+  await gitCommits(['Second'], {cwd: tmpRepo});
+  await gitPush('origin', 'master', {cwd: tmpRepo});
+
+  await tag('tag_name', {cwd});
+  await push(repositoryUrl, {cwd});
+
+  t.is(await gitRemoteTagHead(repositoryUrl, 'tag_name', {cwd}), commits[0].hash);
+});
+
+test('Return "true" if in a Git repository', async t => {
+  // Create a git repository with a remote, set the current working directory at the root of the repo
+  const {cwd} = await gitRepo(true);
+
+  t.true(await isGitRepo({cwd}));
+});
+
+test('Return falsy if not in a Git repository', async t => {
+  const cwd = tempy.directory();
+
+  t.falsy(await isGitRepo({cwd}));
+});
+
+test('Return "true" for valid tag names', async t => {
+  t.true(await verifyTagName('1.0.0'));
+  t.true(await verifyTagName('v1.0.0'));
+  t.true(await verifyTagName('tag_name'));
+  t.true(await verifyTagName('tag/name'));
+});
+
+test('Return falsy for invalid tag names', async t => {
+  t.falsy(await verifyTagName('?1.0.0'));
+  t.falsy(await verifyTagName('*1.0.0'));
+  t.falsy(await verifyTagName('[1.0.0]'));
+  t.falsy(await verifyTagName('1.0.0..'));
+});
+
+test('Throws error if obtaining the tags fails', async t => {
+  const cwd = tempy.directory();
+
+  await t.throwsAsync(getTags({cwd}));
+});
+
+test('Return "true" if repository is up to date', async t => {
+  const {cwd, repositoryUrl} = await gitRepo(true);
+  await gitCommits(['First'], {cwd});
+  await gitPush(repositoryUrl, 'master', {cwd});
+
+  t.true(await isBranchUpToDate('master', {cwd}));
+});
+
+test('Return falsy if repository is not up to date', async t => {
+  const {cwd, repositoryUrl} = await gitRepo(true);
+  await gitCommits(['First'], {cwd});
+  await gitCommits(['Second'], {cwd});
+  await gitPush(repositoryUrl, 'master', {cwd});
+
+  t.true(await isBranchUpToDate('master', {cwd}));
+
+  const tmpRepo = await gitShallowClone(repositoryUrl);
+  await gitCommits(['Third'], {cwd: tmpRepo});
+  await gitPush('origin', 'master', {cwd: tmpRepo});
+
+  t.falsy(await isBranchUpToDate('master', {cwd}));
+});
+
+test('Return "true" if local repository is ahead', async t => {
+  const {cwd, repositoryUrl} = await gitRepo(true);
+  await gitCommits(['First'], {cwd});
+  await gitPush(repositoryUrl, 'master', {cwd});
+  await gitCommits(['Second'], {cwd});
+
+  t.true(await isBranchUpToDate('master', {cwd}));
+});

test/github-release.test.js

@@ -1,91 +0,0 @@
-import test from 'ava';
-import {gitRepo, gitCommits, gitHead} from './helpers/git-utils';
-import nock from 'nock';
-import {authenticate} from './helpers/mock-github';
-import githubRelease from '../src/lib/github-release';
-
-test.beforeEach(t => {
-  // Save the current working diretory
-  t.context.cwd = process.cwd();
-});
-
-test.afterEach.always(t => {
-  // Restore the current working directory
-  process.chdir(t.context.cwd);
-  // Reset nock
-  nock.cleanAll();
-});
-
-test.serial('Github release with default url', async t => {
-  // Create a git repository, set the current working directory at the root of the repo
-  await gitRepo();
-  // Add commits to the master branch
-  await gitCommits(['fix: First fix', 'feat: Second feature']);
-
-  const sha = await gitHead();
-  const owner = 'test_user';
-  const repo = 'test_repo';
-  const githubToken = 'github_token';
-  const notes = 'Test release note body';
-  const version = '1.0.0';
-  const branch = 'master';
-  const tagName = `v${version}`;
-  const options = {branch, githubToken};
-  const pkg = {version, repository: {url: `git+https://othertesturl.com/${owner}/${repo}.git`}};
-  const releaseUrl = `https://othertesturl.com/${owner}/${repo}/releases/${version}`;
-
-  // Mock github API for releases and git/refs endpoints
-  const github = authenticate({githubToken})
-    .post(`/repos/${owner}/${repo}/releases`, {
-      tag_name: tagName,
-      target_commitish: branch,
-      name: tagName,
-      body: notes,
-    })
-    .reply(200, {html_url: releaseUrl})
-    .post(`/repos/${owner}/${repo}/git/refs`, {ref: `refs/tags/${tagName}`, sha})
-    .reply({});
-
-  // Call the post module
-  t.is(releaseUrl, await githubRelease(pkg, notes, version, options));
-  // Verify the releases and git/refs endpoint have been call with expected requests
-  t.true(github.isDone());
-});
-
-test.serial('Github release with custom url', async t => {
-  // Create a git repository, set the current working directory at the root of the repo
-  await gitRepo();
-  // Add commits to the master branch
-  await gitCommits(['fix: First fix', 'feat: Second feature']);
-
-  const sha = await gitHead();
-  const owner = 'test_user';
-  const repo = 'test_repo';
-  const githubUrl = 'https://testurl.com:443';
-  const githubToken = 'github_token';
-  const githubApiPathPrefix = 'prefix';
-  const notes = 'Test release note body';
-  const version = '1.0.0';
-  const branch = 'master';
-  const tagName = `v${version}`;
-  const options = {branch, githubUrl, githubToken, githubApiPathPrefix};
-  const pkg = {version, repository: {url: `git@othertesturl.com:${owner}/${repo}.git`}};
-  const releaseUrl = `https://othertesturl.com/${owner}/${repo}/releases/${version}`;
-
-  // Mock github API for releases and git/refs endpoints
-  const github = authenticate({githubUrl, githubToken, githubApiPathPrefix})
-    .post(`/repos/${owner}/${repo}/releases`, {
-      tag_name: tagName,
-      target_commitish: branch,
-      name: tagName,
-      body: notes,
-    })
-    .reply(200, {html_url: releaseUrl})
-    .post(`/repos/${owner}/${repo}/git/refs`, {ref: `refs/tags/${tagName}`, sha})
-    .reply({});
-
-  // Call the post module
-  t.is(releaseUrl, await githubRelease(pkg, notes, version, options));
-  // Verify the releases and git/refs endpoint have been call with expected requests
-  t.true(github.isDone());
-});