diff --git a/.travis/node-versions.yml b/.travis/node-versions.yml
index 416335cdaa..0824e8e112 100644
--- a/.travis/node-versions.yml
+++ b/.travis/node-versions.yml
@@ -1,4 +1,3 @@
node_js:
- 12
- - 10
- - 8.16
+ - 10.13
diff --git a/README.md b/README.md
index a5a1049dd8..a82ac5f8ef 100644
--- a/README.md
+++ b/README.md
@@ -24,6 +24,9 @@
+
+
**semantic-release** automates the whole package release workflow including: determining the next version number, generating the release notes and publishing the package.
@@ -39,6 +42,7 @@ This removes the immediate connection between human emotions and version numbers
- 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
+- Publish on different distribution channels (such as [npm dist-tags](https://docs.npmjs.com/cli/dist-tag)) based on git merges
- 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)
@@ -68,11 +72,12 @@ Here is an example of the release type that will be done based on a commit messa
### 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.
+For each new commits added to one of the release branches (for example `master`, `next`, `beta`), 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.
+**semantic-release** offers various ways to control the timing, the content and the audience of published releases. See example workflows in the following recipes:
+- [Using distribution channels](docs/recipes/distribution-channels.md#publishing-on-distribution-channels)
+- [Maintenance releases](docs/recipes/maintenance-releases.md#publishing-maintenance-releases)
+- [Pre-releases](docs/recipes/pre-releases.md#publishing-pre-releases)
### Release steps
@@ -90,6 +95,14 @@ After running the tests, the command `semantic-release` will execute the followi
| Publish | Publish the release. |
| Notify | Notify of new releases or errors. |
+## Requirements
+
+In order to use **semantic-release** you need:
+- To host your code in a [Git repository](https://git-scm.com)
+- Use a Continuous Integration service that allows you to [securely set up credentials](docs/usage/ci-configuration.md#authentication)
+- Git CLI version [2.7.1 or higher](docs/support/FAQ.md#why-does-semantic-release-require-git-version--271) installed in your Continuous Integration environment
+- [Node.js](https://nodejs.org) version [8.16.0 or higher](docs/support/FAQ.md#why-does-semantic-release-require-node-version--816) installed in your Continuous Integration environment
+
## Documentation
- Usage
@@ -98,14 +111,16 @@ After running the tests, the command `semantic-release` will execute the followi
- [CI Configuration](docs/usage/ci-configuration.md#ci-configuration)
- [Configuration](docs/usage/configuration.md#configuration)
- [Plugins](docs/usage/plugins.md)
+ - [Workflow configuration](docs/usage/workflow-configuration.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#ci-configurations)
- - [Git hosted services](docs/recipes/README.md#git-hosted-services)
- - [Package managers and languages](docs/recipes/README.md#package-managers-and-languages)
+ - [CI configurations](docs/recipes/README.md)
+ - [Git hosted services](docs/recipes/README.md)
+ - [Release workflow](docs/recipes/README.md)
+ - [Package managers and languages](docs/recipes/README.md)
- Developer guide
- [JavaScript API](docs/developer-guide/js-api.md)
- [Plugins development](docs/developer-guide/plugin.md)
diff --git a/SUMMARY.md b/SUMMARY.md
index e6ce15b072..a28efb45a1 100644
--- a/SUMMARY.md
+++ b/SUMMARY.md
@@ -6,6 +6,7 @@
- [CI Configuration](docs/usage/ci-configuration.md#ci-configuration)
- [Configuration](docs/usage/configuration.md#configuration)
- [Plugins](docs/usage/plugins.md)
+- [Workflow configuration](docs/usage/workflow-configuration.md)
- [Shareable configurations](docs/usage/shareable-configurations.md)
## Extending
diff --git a/bin/semantic-release.js b/bin/semantic-release.js
index 12dd2b56b6..8cfbaadaa0 100755
--- a/bin/semantic-release.js
+++ b/bin/semantic-release.js
@@ -10,7 +10,7 @@ var execa = require('execa');
var findVersions = require('find-versions');
var pkg = require('../package.json');
-var MIN_GIT_VERSION = '2.0.0';
+var MIN_GIT_VERSION = '2.7.1';
if (!semver.satisfies(process.version, pkg.engines.node)) {
console.error(
@@ -35,7 +35,7 @@ execa('git', ['--version'])
process.exit(1);
});
-// Node 8+ from this point on
+// Node 10+ from this point on
require('../cli')()
.then(exitCode => {
process.exitCode = exitCode;
diff --git a/cli.js b/cli.js
index d8780d7fbf..58c14bc4d1 100755
--- a/cli.js
+++ b/cli.js
@@ -19,7 +19,7 @@ module.exports = async () => {
Usage:
semantic-release [options] [plugins]`);
})
- .option('b', {alias: 'branch', describe: 'Git branch to release from', type: 'string', group: 'Options'})
+ .option('b', {alias: 'branches', describe: 'Git branches to release from', ...stringList, 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'})
diff --git a/docs/developer-guide/js-api.md b/docs/developer-guide/js-api.md
index 33b041759d..ed4a261a42 100644
--- a/docs/developer-guide/js-api.md
+++ b/docs/developer-guide/js-api.md
@@ -12,7 +12,14 @@ const stderrBuffer = WritableStreamBuffer();
try {
const result = await semanticRelease({
// Core options
- branch: 'master',
+ branches: [
+ '+([0-9])?(.{+([0-9]),x}).x',
+ 'master',
+ 'next',
+ 'next-major',
+ {name: 'beta', prerelease: true},
+ {name: 'alpha', prerelease: true}
+ ],
repositoryUrl: 'https://github.com/me/my-package.git',
// Shareable config
extends: 'my-shareable-config',
@@ -123,11 +130,12 @@ 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. |
+| 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. |
+| channel | `String` | The distribution channel on which the last release was initially made available (`undefined` for the default distribution channel). |
**Notes**: If no previous release is found, `lastRelease` will be an empty `Object`.
@@ -137,6 +145,7 @@ Example:
gitHead: 'da39a3ee5e6b4b0d3255bfef95601890afd80709',
version: '1.0.0',
gitTag: 'v1.0.0',
+ channel: 'next'
}
```
@@ -206,13 +215,14 @@ 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. |
+| 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. |
+| channel | `String` | The distribution channel on which the next release will be made available (`undefined` for the default distribution channel). |
Example:
```js
@@ -222,6 +232,7 @@ Example:
version: '1.1.0',
gitTag: 'v1.1.0',
notes: 'Release notes for version 1.1.0...',
+ channel : 'next'
}
```
@@ -229,19 +240,20 @@ Example:
Type: `Array`
-The list of releases published, one release per [publish plugin](../usage/plugins.md#publish-plugin).`. As `master` and `1.x` branches have diverged, the cherry picking might require to resolve conflicts.
+
+Once the conflicts are resolved and the commit is pushed to `1.x`, **semantic-release** will release the version `1.1.2` on the dist-tag `@release-1.x` which contains `feat: a feature`, `fix: a fix` and `fix: another fix` but not `feat: drop Node.js 6 support \n\n BREAKING CHANGE: Node.js >= 8 required`.
+
+The Git history of the repository is now:
+
+```
+* feat: initial commit # => v1.0.0 on @latest
+| \
+* | feat: drop Node.js 6 support \n\n BREAKING CHANGE: Node.js >= 8 required # => v2.0.0 on @latest
+| | \
+| * | feat: a feature # => v1.1.0 on @1.x
+| | * fix: a fix # => v1.0.1 on @1.0.x
+| | /|
+| * | Merge branch 1.0.x into 1.x # => v1.1.1 on @1.x
+| /| |
+* | | Merge branch 1.x into master # => v2.1.0 on @latest
+* | | fix: another fix # => v2.1.1 on @latest
+| | |
+| * | fix: another fix # => v1.1.2 on @1.x
+```
diff --git a/docs/recipes/pre-releases.md b/docs/recipes/pre-releases.md
new file mode 100644
index 0000000000..7bfb1ff4cb
--- /dev/null
+++ b/docs/recipes/pre-releases.md
@@ -0,0 +1,196 @@
+# Publishing pre-releases
+
+This recipe will walk you through a simple example that uses pre-releases to publish beta versions while working on a future major release and then make only one release on the default distribution.
+
+This example uses the **semantic-release** default configuration:
+- [branches](../usage/configuration.md#branches): `['+([0-9])?(.{+([0-9]),x}).x', 'master', 'next', 'next-major', {name: 'beta', prerelease: true}, {name: 'alpha', prerelease: true}]`
+- [plugins](../usage/configuration.md#plugins): `['@semantic-release/commit-analyzer', '@semantic-release/release-notes-generator', '@semantic-release/npm', '@semantic-release/github']`
+
+## Initial release
+
+We'll start by making the first commit of the project, with the code for the initial release and the message `feat: initial commit`. When pushing that commit, on `master` **semantic-release** will release the version `1.0.0` and make it available on the default distribution channel which is the dist-tag `@latest` for npm.
+
+The Git history of the repository is:
+
+```
+* feat: initial commit # => v1.0.0 on @latest
+```
+
+## Working on a future release
+
+We now decide to work on a future major release, which will be composed of multiple features, some of them being breaking changes. We want to publish our package for each new feature developed for test purpose, however we do not want to increment our package version or make it available to our users until all the features are developed and tested.
+
+To implement that workflow we can create the branch `beta` and commit our first feature there. When pushing that commit, **semantic-release** will publish the pre-release version `2.0.0-beta.1` on the dist-tag `@beta`. That allow us to run integration tests by installing our module with `npm install example-module@beta`. Other users installing with `npm install example-module` will still receive the version `1.0.0`.
+
+The Git history of the repository is now:
+
+```
+* feat: initial commit # => v1.0.0 on @latest
+| \
+| * feat: first feature \n\n BREAKING CHANGE: it breaks something # => v2.0.0-beta.1 on @beta
+```
+
+We can continue to work on our future release by committing and pushing other features or bug fixes on the `beta` branch. With each push, **semantic-release** will publish a new pre-release on the dist-tag `@beta`, which allow us to run our integration tests.
+
+With another feature, the Git history of the repository is now:
+
+```
+* feat: initial commit # => v1.0.0 on @latest
+| \
+| * feat: first feature \n\n BREAKING CHANGE: it breaks something # => v2.0.0-beta.1 on @beta
+| * feat: second feature # => v2.0.0-beta.2 on @beta
+```
+
+## Releasing a bug fix on the default distribution channel
+
+In the meantime we can also continue to commit changes and release updates to our users.
+
+For example, we can commit a bug fix with the message `fix: a fix` to `master`. When pushing that commit, **semantic-release** will release the version `1.0.1` on the dist-tag `@latest`.
+
+The Git history of the repository is now:
+
+```
+* feat: initial commit # => v1.0.0 on @latest
+| \
+| * feat: first feature \n\n BREAKING CHANGE: it breaks something # => v2.0.0-beta.1 on @beta
+| * feat: second feature # => v2.0.0-beta.2 on @beta
+* | fix: a fix # => v1.0.1 on @latest
+```
+
+## Working on another future release
+
+We now decide to work on another future major release, in parallel of the beta one, which will also be composed of multiple features, some of them being breaking changes.
+
+To implement that workflow we can create the branch `alpha` from the branch `beta` and commit our first feature there. When pushing that commit, **semantic-release** will publish the pre-release version `3.0.0-alpha.1` on the dist-tag `@alpha`. That allow us to run integration tests by installing our module with `npm install example-module@alpha`. Other users installing with `npm install example-module` will still receive the version `1.0.0`.
+
+The Git history of the repository is now:
+
+```
+* feat: initial commit # => v1.0.0 on @latest
+| \
+| * feat: first feature \n\n BREAKING CHANGE: it breaks something # => v2.0.0-beta.1 on @beta
+| * feat: second feature # => v2.0.0-beta.2 on @beta
+* | fix: a fix # => v1.0.1 on @latest
+| | \
+| | * feat: first feature of other release \n\n BREAKING CHANGE: it breaks something # => v3.0.0-alpha.1 on @alpha
+```
+
+We can continue to work on our future release by committing and pushing other features or bug fixes on the `alpha` branch. With each push, **semantic-release** will publish a new pre-release on the dist-tag `@alpha`, which allow us to run our integration tests.
+
+With another feature, the Git history of the repository is now:
+
+```
+* feat: initial commit # => v1.0.0 on @latest
+| \
+| * feat: first feature \n\n BREAKING CHANGE: it breaks something # => v2.0.0-beta.1 on @beta
+| * feat: second feature # => v2.0.0-beta.2 on @beta
+* | fix: a fix # => v1.0.1 on @latest
+| | \
+| | * feat: first feature of other release \n\n BREAKING CHANGE: it breaks something # => v3.0.0-alpha.1 on @alpha
+| | * feat: second feature of other release # => v3.0.0-alpha.2 on @alpha
+```
+
+## Publishing the 2.0.0 beta release to the default distribution channel
+
+Once we've developed and pushed all the feature we want to include in the future version `2.0.0` in the `beta` branch and all our tests are successful we can release it to our users.
+
+To do so we need to merge our changes made on `beta` into `master`. As `beta` and `master` branches have diverged, this merge might require to resolve conflicts.
+
+Once the conflicts are resolved and the merge commit is pushed to `master`, **semantic-release** will release the version `2.0.0` on the dist-tag `@latest`.
+
+The Git history of the repository is now:
+
+```
+* feat: initial commit # => v1.0.0 on @latest
+| \
+| * feat: first feature \n\n BREAKING CHANGE: it breaks something # => v2.0.0-beta.1 on @beta
+| * feat: second feature # => v2.0.0-beta.2 on @beta
+* | fix: a fix # => v1.0.1 on @latest
+| | \
+| | * feat: first feature of other release \n\n BREAKING CHANGE: it breaks something # => v3.0.0-alpha.1 on @alpha
+| | * feat: second feature of other release # => v3.0.0-alpha.2 on @alpha
+| /| |
+* | | Merge branch beta into master # => v2.0.0 on @latest
+```
+
+## Publishing the 3.0.0 alpha release to the beta distribution channel
+
+Now that we published our the version `2.0.0` that was previously in beta, we decide to promote the version `3.0.0` in alpha to beta.
+
+To do so we need to merge our changes made on `alpha` into `beta`. There should be no conflict as `alpha` is strictly ahead of `master`.
+
+Once the merge commit is pushed to `beta`, **semantic-release** will publish the pre-release version `3.0.0-beta.1` on the dist-tag `@beta`, which allow us to run our integration tests.
+
+The Git history of the repository is now:
+
+```
+* feat: initial commit # => v1.0.0 on @latest
+| \
+| * feat: first feature \n\n BREAKING CHANGE: it breaks something # => v2.0.0-beta.1 on @beta
+| * feat: second feature # => v2.0.0-beta.2 on @beta
+* | fix: a fix # => v1.0.1 on @latest
+| | \
+| | * feat: first feature of other release \n\n BREAKING CHANGE: it breaks something # => v3.0.0-alpha.1 on @alpha
+| | * feat: second feature of other release # => v3.0.0-alpha.2 on @alpha
+| /| |
+* | | Merge branch beta into master # => v2.0.0 on @latest
+| | /|
+| * | Merge branch alpha into beta # => v3.0.0-beta.1 on @beta
+```
+
+## Publishing the 3.0.0 beta release to the default distribution channel
+
+Once we've developed and pushed all the feature we want to include in the future version `3.0.0` in the `beta` branch and all our tests are successful we can release it to our users.
+
+To do so we need to merge our changes made on `beta` into `master`. As `beta` and `master` branches have diverged, this merge might require to resolve conflicts.
+
+Once the conflicts are resolved and the merge commit is pushed to `master`, **semantic-release** will release the version `3.0.0` on the dist-tag `@latest`.
+
+The Git history of the repository is now:
+
+```
+* feat: initial commit # => v1.0.0 on @latest
+| \
+| * feat: first feature \n\n BREAKING CHANGE: it breaks something # => v2.0.0-beta.1 on @beta
+| * feat: second feature # => v2.0.0-beta.2 on @beta
+* | fix: a fix # => v1.0.1 on @latest
+| | \
+| | * feat: first feature of other release \n\n BREAKING CHANGE: it breaks something # => v3.0.0-alpha.1 on @alpha
+| | * feat: second feature of other release # => v3.0.0-alpha.2 on @alpha
+| /| |
+* | | Merge branch beta into master # => v2.0.0 on @latest
+| | /|
+| * | Merge branch alpha into beta # => v3.0.0-beta.1 on @beta
+| /| |
+* | | Merge branch beta into master # => v3.0.0 on @latest
+```
+
+## Working on a third future release
+
+We can now start to work on a new future major release, version `4.0.0`, on the `@beta` distribution channel.
+
+To do so we fist need to update the `beta` branch with all the changes from `master` (the commits `fix: a fix`). As `beta` and `master` branches have diverged, this merge might require to resolve conflicts.
+
+We can now commit our new feature on `beta`. When pushing that commit, **semantic-release** will publish the pre-release version `3.1.0-beta.1` on the dist-tag `@beta`. That allow us to run integration tests by installing our module with `npm install example-module@beta`. Other users installing with `npm install example-module` will still receive the version `3.0.0`.
+
+The Git history of the repository is now:
+
+```
+* feat: initial commit # => v1.0.0 on @latest
+| \
+| * feat: first feature \n\n BREAKING CHANGE: it breaks something # => v2.0.0-beta.1 on @beta
+| * feat: second feature # => v2.0.0-beta.2 on @beta
+* | fix: a fix # => v1.0.1 on @latest
+| | \
+| | * feat: first feature of other release \n\n BREAKING CHANGE: it breaks something # => v3.0.0-alpha.1 on @alpha
+| | * feat: second feature of other release # => v3.0.0-alpha.2 on @alpha
+| /| |
+* | | Merge branch beta into master # => v2.0.0 on @latest
+| | /|
+| * | Merge branch alpha into beta # => v3.0.0-beta.1 on @beta
+| /| |
+* | | Merge branch beta into master # => v3.0.0 on @latest
+| \| |
+| * | Merge branch master into beta
+| * | feat: new feature # => v3.1.0-beta.1 on @beta
+```
diff --git a/docs/support/FAQ.md b/docs/support/FAQ.md
index 5ce9fdfe6e..40ef307269 100644
--- a/docs/support/FAQ.md
+++ b/docs/support/FAQ.md
@@ -38,7 +38,7 @@ Yes with the [dry-run options](../usage/configuration.md#dryrun) which prints to
## 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.16](#why-does-semantic-release-require-node-version--816) and specifies it in its `package.json`s [`engines`](https://docs.npmjs.com/files/package.json#engines) key.
+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 >= 10.13](#why-does-semantic-release-require-node-version--1013) 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:
@@ -48,7 +48,7 @@ $ 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.16.
+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 >= 10.13.
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:
@@ -73,7 +73,7 @@ Yes, **semantic-release** is a Node CLI application but it can be used to publis
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.16](#why-does-semantic-release-require-node-version--816) to execute the `semantic-release` command
+- Make sure your CI job executing the `semantic-release` command has access to [Node >= 10.13](#why-does-semantic-release-require-node-version--1013) to execute the `semantic-release` command
See the [CI configuration recipes](../recipes/README.md#ci-configurations) for more details on specific CI environments.
@@ -222,7 +222,7 @@ If you need more control over the timing of releases, see [Triggering a release]
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.
+If your project is under heavy development, with frequent breaking changes, and is not production ready yet we recommend [publishing pre-releases](../recipes/pre-releases.md#publishing-pre-releases).
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`.
@@ -232,12 +232,16 @@ See [“Introduction to SemVer” - Irina Gebauer](https://blog.greenkeeper.io/i
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.16?
+## Why does semantic-release require Node version >= 10.13?
-**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.16 or higher**.
+**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 10.13 or higher**.
See [Node version requirement](./node-version.md#node-version-requirement) for more details and solutions.
+## Why does semantic-release require Git version >= 2.7.1?
+
+**semantic-release** uses Git CLI commands to read information about the repository such as branches, commit history and tags. Certain commands and options (such as [the `--merged` option of the `git tag` command](https://git-scm.com/docs/git-tag/2.7.0#git-tag---no-mergedltcommitgt) or bug fixes related to `git ls-files`) used by **semantic-release** are only available in Git version 2.7.1 and higher.
+
## 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.
diff --git a/docs/support/node-version.md b/docs/support/node-version.md
index 633a8c7271..8a6266a5ad 100644
--- a/docs/support/node-version.md
+++ b/docs/support/node-version.md
@@ -1,6 +1,6 @@
# 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.16 or higher**.
+**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 10 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.
@@ -8,9 +8,9 @@ See our [Node Support Policy](node-support-policy.md) for our long-term promise
## Recommended solution
-### Run at least one CI job with Node >= 8.16
+### Run at least one CI job with Node >= 10.13
-The recommended approach is to run the `semantic-release` command from a CI job running on Node 8.16 or higher. This can either be a job used by your project to test on Node >= 8.16 or a dedicated job for the release steps.
+The recommended approach is to run the `semantic-release` command from a CI job running on Node 10.13 or higher. This can either be a job used by your project to test on Node >= 10.13 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.
diff --git a/docs/usage/README.md b/docs/usage/README.md
index 636326ff04..758b34a35d 100644
--- a/docs/usage/README.md
+++ b/docs/usage/README.md
@@ -5,4 +5,5 @@
- [CI Configuration](ci-configuration.md#ci-configuration)
- [Configuration](configuration.md#configuration)
- [Plugins](plugins.md)
+- [Workflow configuration](workflow-configuration.md)
- [Shareable configurations](shareable-configurations.md)
diff --git a/docs/usage/configuration.md b/docs/usage/configuration.md
index dc9f8c657a..4c9ff1e898 100644
--- a/docs/usage/configuration.md
+++ b/docs/usage/configuration.md
@@ -1,7 +1,7 @@
# Configuration
**semantic-release** configuration consists of:
-- Git repository ([URL](#repositoryurl) and options [release branch](#branch) and [tag format](#tagformat))
+- Git repository ([URL](#repositoryurl) and options [release branches](#branches) and [tag format](#tagformat))
- Plugins [declaration](#plugins) and options
- Run mode ([debug](#debug), [dry run](#dryrun) and [local (no CI)](#ci))
@@ -24,7 +24,7 @@ The following three examples are the same.
```json
{
"release": {
- "branch": "next"
+ "branches": ["master", "next"]
}
}
```
@@ -32,7 +32,7 @@ The following three examples are the same.
- Via `.releaserc` file:
```json
{
- "branch": "next"
+ "branches": ["master", "next"]
}
```
@@ -58,13 +58,25 @@ List of modules or file paths containing a [shareable configuration](shareable-c
**Note**: Options defined via CLI arguments or in the configuration file will take precedence over the ones defined in any shareable configuration.
-### branch
+### branches
-Type: `String`>} 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);
+module.exports = async ({cwd, env, lastRelease: {gitHead: from}, nextRelease: {gitHead: to = 'HEAD'} = {}, logger}) => {
+ if (from) {
+ debug('Use from: %s', from);
} 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;
- });
+ const commits = await getCommits(from, to, {cwd, env});
+
logger.log(`Found ${commits.length} commits since last release`);
debug('Parsed commits: %o', commits);
return commits;
diff --git a/lib/get-config.js b/lib/get-config.js
index 71d935936d..e80a9f8841 100644
--- a/lib/get-config.js
+++ b/lib/get-config.js
@@ -66,7 +66,14 @@ module.exports = async (context, opts) => {
// Set default options values if not defined yet
options = {
- branch: 'master',
+ branches: [
+ '+([0-9])?(.{+([0-9]),x}).x',
+ 'master',
+ 'next',
+ 'next-major',
+ {name: 'beta', prerelease: true},
+ {name: 'alpha', prerelease: true},
+ ],
repositoryUrl: (await pkgRepoUrl({normalize: false, cwd})) || (await repoUrl({cwd, env})),
tagFormat: `v\${version}`,
plugins: [
@@ -77,6 +84,7 @@ module.exports = async (context, opts) => {
],
// Remove `null` and `undefined` options so they can be replaced with default ones
...pickBy(options, option => !isNil(option)),
+ ...(options.branches ? {branches: castArray(options.branches)} : {}),
};
debug('options values: %O', options);
diff --git a/lib/get-git-auth-url.js b/lib/get-git-auth-url.js
index c0374f7c46..88d63a726c 100644
--- a/lib/get-git-auth-url.js
+++ b/lib/get-git-auth-url.js
@@ -14,7 +14,7 @@ const {verifyAuth} = require('./git');
*
* @return {String} The formatted Git repository URL.
*/
-module.exports = async ({cwd, env, options: {repositoryUrl, branch}}) => {
+module.exports = async ({cwd, env, branch, options: {repositoryUrl}}) => {
const GIT_TOKENS = {
GIT_CREDENTIALS: undefined,
GH_TOKEN: undefined,
@@ -40,14 +40,15 @@ module.exports = async ({cwd, env, options: {repositoryUrl, branch}}) => {
// Test if push is allowed without transforming the URL (e.g. is ssh keys are set up)
try {
- await verifyAuth(repositoryUrl, branch, {cwd, env});
+ await verifyAuth(repositoryUrl, branch.name, {cwd, env});
} catch (_) {
const envVar = Object.keys(GIT_TOKENS).find(envVar => !isNil(env[envVar]));
const gitCredentials = `${GIT_TOKENS[envVar] || ''}${env[envVar] || ''}`;
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) || [];
+ const [match, auth, host, path] =
+ /^(?!.+:\/\/)(?:(?.*)@)?(?.*?):(?.*)$/.exec(repositoryUrl) || [];
const {port, hostname, ...parsed} = parse(
match ? `ssh://${auth ? `${auth}@` : ''}${host}/${path}` : repositoryUrl
);
diff --git a/lib/get-last-release.js b/lib/get-last-release.js
index f30dd5c52f..f8cc5ede91 100644
--- a/lib/get-last-release.js
+++ b/lib/get-last-release.js
@@ -1,51 +1,44 @@
-const {escapeRegExp, template} = require('lodash');
+const {isUndefined} = 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');
+const {makeTag, isSameChannel} = require('./utils');
/**
* 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.
+ * @property {string} gitHead The Git reference used to make the last release.
+ * @property {string} gitTag The git tag associated with the last release.
+ * @property {string} channel The channel on which of the last release was published.
+ * @property {string} name The name of 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`
+ * - Filter out the branch tags that are not valid semantic version
* - Sort the versions
* - Retrive the highest version
*
* @param {Object} context semantic-release context.
+ * @param {Object} params Function parameters.
+ * @param {Object} params.before Find only releases with version number lower than this version.
*
- * @return {Promise} The last tagged release or `undefined` if none is found.
+ * @return {LastRelease} The last tagged release or empty object 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]}))
+module.exports = ({branch, options: {tagFormat}}, {before} = {}) => {
+ const [{version, gitTag, channels} = {}] = branch.tags
.filter(
- tag => tag.version && semver.valid(semver.clean(tag.version)) && !semver.prerelease(semver.clean(tag.version))
+ tag =>
+ ((branch.type === 'prerelease' && tag.channels.some(channel => isSameChannel(branch.channel, channel))) ||
+ !semver.prerelease(tag.version)) &&
+ (isUndefined(before) || semver.lt(tag.version, before))
)
.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};
+ if (gitTag) {
+ return {version, gitTag, channels, gitHead: gitTag, name: makeTag(tagFormat, version)};
}
- logger.log('No git tag version found');
return {};
};
diff --git a/lib/get-next-version.js b/lib/get-next-version.js
index 10089e9faa..05f91a11f4 100644
--- a/lib/get-next-version.js
+++ b/lib/get-next-version.js
@@ -1,13 +1,33 @@
const semver = require('semver');
-const {FIRST_RELEASE} = require('./definitions/constants');
+const {FIRST_RELEASE, FIRSTPRERELEASE} = require('./definitions/constants');
+const {isSameChannel, getLatestVersion, tagsToVersions, highest} = require('./utils');
-module.exports = ({nextRelease: {type}, lastRelease, logger}) => {
+module.exports = ({branch, nextRelease: {type, channel}, lastRelease, logger}) => {
let version;
if (lastRelease.version) {
- version = semver.inc(lastRelease.version, type);
- logger.log(`The next release version is ${version}`);
+ const {major, minor, patch} = semver.parse(lastRelease.version);
+
+ if (branch.type === 'prerelease') {
+ if (
+ semver.prerelease(lastRelease.version) &&
+ lastRelease.channels.some(lastReleaseChannel => isSameChannel(lastReleaseChannel, channel))
+ ) {
+ version = highest(
+ semver.inc(lastRelease.version, 'prerelease'),
+ `${semver.inc(getLatestVersion(tagsToVersions(branch.tags), {withPrerelease: true}), type)}-${
+ branch.prerelease
+ }.${FIRSTPRERELEASE}`
+ );
+ } else {
+ version = `${semver.inc(`${major}.${minor}.${patch}`, type)}-${branch.prerelease}.${FIRSTPRERELEASE}`;
+ }
+ } else {
+ version = semver.inc(lastRelease.version, type);
+ }
+
+ logger.log('The next release version is %s', version);
} else {
- version = FIRST_RELEASE;
+ version = branch.type === 'prerelease' ? `${FIRST_RELEASE}-${branch.prerelease}.${FIRSTPRERELEASE}` : FIRST_RELEASE;
logger.log(`There is no previous release, the next release version is ${version}`);
}
diff --git a/lib/get-release-to-add.js b/lib/get-release-to-add.js
new file mode 100644
index 0000000000..a5ac7d884d
--- /dev/null
+++ b/lib/get-release-to-add.js
@@ -0,0 +1,60 @@
+const {uniqBy, intersection} = require('lodash');
+const semver = require('semver');
+const semverDiff = require('semver-diff');
+const getLastRelease = require('./get-last-release');
+const {makeTag, getLowerBound} = require('./utils');
+
+/**
+ * Find releases that have been merged from from a higher branch but not added on the channel of the current branch.
+ *
+ * @param {Object} context semantic-release context.
+ *
+ * @return {Array} Last release and next release to be added on the channel of the current branch.
+ */
+module.exports = context => {
+ const {
+ branch,
+ branches,
+ options: {tagFormat},
+ } = context;
+
+ const higherChannels = branches
+ // Consider only releases of higher branches
+ .slice(branches.findIndex(({name}) => name === branch.name) + 1)
+ // Exclude prerelease branches
+ .filter(({type}) => type !== 'prerelease')
+ .map(({channel}) => channel || null);
+
+ const versiontoAdd = uniqBy(
+ branch.tags.filter(
+ ({channels, version}) =>
+ !channels.includes(branch.channel || null) &&
+ intersection(channels, higherChannels).length > 0 &&
+ (branch.type !== 'maintenance' || semver.gte(version, getLowerBound(branch.mergeRange)))
+ ),
+ 'version'
+ ).sort((a, b) => semver.compare(b.version, a.version))[0];
+
+ if (versiontoAdd) {
+ const {version, gitTag, channels} = versiontoAdd;
+ const lastRelease = getLastRelease(context, {before: version});
+ if (semver.gt(getLastRelease(context).version, version)) {
+ return;
+ }
+
+ const type = lastRelease.version ? semverDiff(lastRelease.version, version) : 'major';
+ const name = makeTag(tagFormat, version);
+ return {
+ lastRelease,
+ currentRelease: {type, version, channels, gitTag, name, gitHead: gitTag},
+ nextRelease: {
+ type,
+ version,
+ channel: branch.channel || null,
+ gitTag: makeTag(tagFormat, version),
+ name,
+ gitHead: gitTag,
+ },
+ };
+ }
+};
diff --git a/lib/git.js b/lib/git.js
index a190f71045..dc75018ac3 100644
--- a/lib/git.js
+++ b/lib/git.js
@@ -1,5 +1,10 @@
+const gitLogParser = require('git-log-parser');
+const getStream = require('get-stream');
const execa = require('execa');
const debug = require('debug')('semantic-release:git');
+const {GIT_NOTE_REF} = require('./definitions/constants');
+
+Object.assign(gitLogParser.fields, {hash: 'H', message: 'B', gitTags: 'd', committerDate: {key: 'ci', type: Date}});
/**
* Get the commit sha for a given tag.
@@ -7,50 +12,76 @@ const debug = require('debug')('semantic-release:git');
* @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`.
+ * @return {String} The commit sha of the tag in parameter or `null`.
*/
async function getTagHead(tagName, execaOpts) {
- try {
- return (await execa('git', ['rev-list', '-1', tagName], execaOpts)).stdout;
- } catch (error) {
- debug(error);
- }
+ return (await execa('git', ['rev-list', '-1', tagName], execaOpts)).stdout;
}
/**
- * Get all the repository tags.
+ * Get all the tags for a given branch.
*
+ * @param {String} branch The branch for which to retrieve the tags.
* @param {Object} [execaOpts] Options to pass to `execa`.
*
* @return {Array} List of git tags.
* @throws {Error} If the `git` command fails.
*/
-async function getTags(execaOpts) {
- return (await execa('git', ['tag'], execaOpts)).stdout
+async function getTags(branch, execaOpts) {
+ return (await execa('git', ['tag', '--merged', branch], execaOpts)).stdout
.split('\n')
.map(tag => tag.trim())
.filter(Boolean);
}
/**
- * Verify if the `ref` is in the direct history of the current branch.
+ * Retrieve a range of commits.
+ *
+ * @param {String} from to includes all commits made after this sha (does not include this sha).
+ * @param {String} to to includes all commits made before this sha (also include this sha).
+ * @param {Object} [execaOpts] Options to pass to `execa`.
+ * @return {Promise>} The list of commits between `from` and `to`.
+ */
+async function getCommits(from, to, execaOpts) {
+ return (
+ await getStream.array(
+ gitLogParser.parse(
+ {_: `${from ? from + '..' : ''}${to}`},
+ {cwd: execaOpts.cwd, env: {...process.env, ...execaOpts.env}}
+ )
+ )
+ ).map(({message, gitTags, ...commit}) => ({...commit, message: message.trim(), gitTags: gitTags.trim()}));
+}
+
+/**
+ * Get all the repository branches.
+ *
+ * @param {String} repositoryUrl The remote repository URL.
+ * @param {Object} [execaOpts] Options to pass to `execa`.
+ *
+ * @return {Array} List of git branches.
+ * @throws {Error} If the `git` command fails.
+ */
+async function getBranches(repositoryUrl, execaOpts) {
+ return (await execa('git', ['ls-remote', '--heads', repositoryUrl], execaOpts)).stdout
+ .split('\n')
+ .map(branch => branch.match(/^.+refs\/heads\/(?.+)$/)[1])
+ .filter(Boolean);
+}
+
+/**
+ * Verify if the `ref` exits
*
- * @param {String} ref The reference to look for.
+ * @param {String} ref The reference to verify.
* @param {Object} [execaOpts] Options to pass to `execa`.
*
- * @return {Boolean} `true` if the reference is in the history of the current branch, falsy otherwise.
+ * @return {Boolean} `true` if the reference exists, falsy otherwise.
*/
-async function isRefInHistory(ref, execaOpts) {
+async function isRefExists(ref, execaOpts) {
try {
- await execa('git', ['merge-base', '--is-ancestor', ref, 'HEAD'], execaOpts);
- return true;
+ return (await execa('git', ['rev-parse', '--verify', ref], execaOpts)).exitCode === 0;
} catch (error) {
- if (error.exitCode === 1) {
- return false;
- }
-
debug(error);
- throw error;
}
}
@@ -58,13 +89,59 @@ async function isRefInHistory(ref, execaOpts) {
* Unshallow the git repository if necessary and fetch all the tags.
*
* @param {String} repositoryUrl The remote repository URL.
+ * @param {String} branch The repository branch to fetch.
* @param {Object} [execaOpts] Options to pass to `execa`.
*/
-async function fetch(repositoryUrl, execaOpts) {
+async function fetch(repositoryUrl, branch, ciBranch, execaOpts) {
+ const isLocalExists =
+ (await execa('git', ['rev-parse', '--verify', branch], {...execaOpts, reject: false})).exitCode === 0;
+
try {
- await execa('git', ['fetch', '--unshallow', '--tags', repositoryUrl], execaOpts);
+ await execa(
+ 'git',
+ [
+ 'fetch',
+ '--unshallow',
+ '--tags',
+ ...(branch === ciBranch && isLocalExists
+ ? [repositoryUrl]
+ : ['--update-head-ok', repositoryUrl, `+refs/heads/${branch}:refs/heads/${branch}`]),
+ ],
+ execaOpts
+ );
} catch (_) {
- await execa('git', ['fetch', '--tags', repositoryUrl], execaOpts);
+ await execa(
+ 'git',
+ [
+ 'fetch',
+ '--tags',
+ ...(branch === ciBranch && isLocalExists
+ ? [repositoryUrl]
+ : ['--update-head-ok', repositoryUrl, `+refs/heads/${branch}:refs/heads/${branch}`]),
+ ],
+ execaOpts
+ );
+ }
+}
+
+/**
+ * Unshallow the git repository if necessary and fetch all the notes.
+ *
+ * @param {String} repositoryUrl The remote repository URL.
+ * @param {Object} [execaOpts] Options to pass to `execa`.
+ */
+async function fetchNotes(repositoryUrl, execaOpts) {
+ try {
+ await execa(
+ 'git',
+ ['fetch', '--unshallow', repositoryUrl, `+refs/notes/${GIT_NOTE_REF}:refs/notes/${GIT_NOTE_REF}`],
+ execaOpts
+ );
+ } catch (_) {
+ await execa('git', ['fetch', repositoryUrl, `+refs/notes/${GIT_NOTE_REF}:refs/notes/${GIT_NOTE_REF}`], {
+ ...execaOpts,
+ reject: false,
+ });
}
}
@@ -113,7 +190,7 @@ async function isGitRepo(execaOpts) {
* 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 {String} branch The repository branch for which to verify write access.
* @param {Object} [execaOpts] Options to pass to `execa`.
*
* @throws {Error} if not authorized to push.
@@ -131,12 +208,13 @@ async function verifyAuth(repositoryUrl, branch, execaOpts) {
* Tag the commit head on the local repository.
*
* @param {String} tagName The name of the tag.
+ * @param {String} ref The Git reference to 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);
+async function tag(tagName, ref, execaOpts) {
+ await execa('git', ['tag', tagName, ref], execaOpts);
}
/**
@@ -151,6 +229,18 @@ async function push(repositoryUrl, execaOpts) {
await execa('git', ['push', '--tags', repositoryUrl], execaOpts);
}
+/**
+ * Push notes 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 pushNotes(repositoryUrl, execaOpts) {
+ await execa('git', ['push', repositoryUrl, `refs/notes/${GIT_NOTE_REF}`], execaOpts);
+}
+
/**
* Verify a tag name is a valid Git reference.
*
@@ -167,6 +257,22 @@ async function verifyTagName(tagName, execaOpts) {
}
}
+/**
+ * Verify a branch name is a valid Git reference.
+ *
+ * @param {String} branch the branch name to verify.
+ * @param {Object} [execaOpts] Options to pass to `execa`.
+ *
+ * @return {Boolean} `true` if valid, falsy otherwise.
+ */
+async function verifyBranchName(branch, execaOpts) {
+ try {
+ return (await execa('git', ['check-ref-format', `refs/heads/${branch}`], execaOpts)).exitCode === 0;
+ } catch (error) {
+ debug(error);
+ }
+}
+
/**
* Verify the local branch is up to date with the remote one.
*
@@ -177,25 +283,62 @@ async function verifyTagName(tagName, execaOpts) {
* @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(repositoryUrl, branch, execaOpts) {
- const {stdout: remoteHead} = await execa('git', ['ls-remote', '--heads', repositoryUrl, branch], execaOpts);
+ return (
+ (await getGitHead(execaOpts)) ===
+ (await execa('git', ['ls-remote', '--heads', repositoryUrl, branch], execaOpts)).stdout.match(/^(?[\w+)?/)[1]
+ );
+}
+
+/**
+ * Get and parse the JSON note of a given reference.
+ *
+ * @param {String} ref The Git reference for which to retrieve the note.
+ * @param {Object} [execaOpts] Options to pass to `execa`.
+ *
+ * @return {Object} the parsed JSON note if there is one, an empty object otherwise.
+ */
+async function getNote(ref, execaOpts) {
try {
- return await isRefInHistory(remoteHead.match(/^(\w+)?/)[1], execaOpts);
+ return JSON.parse((await execa('git', ['notes', '--ref', GIT_NOTE_REF, 'show', ref], execaOpts)).stdout);
} catch (error) {
+ if (error.exitCode === 1) {
+ return {};
+ }
+
debug(error);
+ throw error;
}
}
+/**
+ * Get and parse the JSON note of a given reference.
+ *
+ * @param {Object} note The object to save in the reference note.
+ * @param {String} ref The Git reference to add the note to.
+ * @param {Object} [execaOpts] Options to pass to `execa`.
+ */
+async function addNote(note, ref, execaOpts) {
+ await execa('git', ['notes', '--ref', GIT_NOTE_REF, 'add', '-f', '-m', JSON.stringify(note), ref], execaOpts);
+}
+
module.exports = {
getTagHead,
getTags,
- isRefInHistory,
+ getCommits,
+ getBranches,
+ isRefExists,
fetch,
+ fetchNotes,
getGitHead,
repoUrl,
isGitRepo,
verifyAuth,
tag,
push,
+ pushNotes,
verifyTagName,
isBranchUpToDate,
+ verifyBranchName,
+ getNote,
+ addNote,
};
diff --git a/lib/utils.js b/lib/utils.js
index b3e1a2509c..14d9d028b1 100644
--- a/lib/utils.js
+++ b/lib/utils.js
@@ -1,4 +1,5 @@
-const {isFunction} = require('lodash');
+const {isFunction, union, template} = require('lodash');
+const semver = require('semver');
const hideSensitive = require('./hide-sensitive');
function extractErrors(err) {
@@ -17,4 +18,79 @@ function hideSensitiveValues(env, objs) {
});
}
-module.exports = {extractErrors, hideSensitiveValues};
+function tagsToVersions(tags) {
+ return tags.map(({version}) => version);
+}
+
+function isMajorRange(range) {
+ return /^\d+\.x(?:\.x)?$/i.test(range);
+}
+
+function isMaintenanceRange(range) {
+ return /^\d+\.(?:\d+|x)(?:\.x)?$/i.test(range);
+}
+
+function getUpperBound(range) {
+ return semver.valid(range)
+ ? range
+ : ((semver.validRange(range) || '').match(/<(?]\d+\.\d+\.\d+)$/) || [])[1];
+}
+
+function getLowerBound(range) {
+ return ((semver.validRange(range) || '').match(/(?\d+\.\d+\.\d+)/) || [])[1];
+}
+
+function highest(version1, version2) {
+ return version1 && version2 ? (semver.gt(version1, version2) ? version1 : version2) : version1 || version2;
+}
+
+function lowest(version1, version2) {
+ return version1 && version2 ? (semver.lt(version1, version2) ? version1 : version2) : version1 || version2;
+}
+
+function getLatestVersion(versions, {withPrerelease} = {}) {
+ return versions.filter(version => withPrerelease || !semver.prerelease(version)).sort(semver.rcompare)[0];
+}
+
+function getEarliestVersion(versions, {withPrerelease} = {}) {
+ return versions.filter(version => withPrerelease || !semver.prerelease(version)).sort(semver.compare)[0];
+}
+
+function getFirstVersion(versions, lowerBranches) {
+ const lowerVersion = union(...lowerBranches.map(({tags}) => tagsToVersions(tags))).sort(semver.rcompare);
+ if (lowerVersion[0]) {
+ return versions.sort(semver.compare).find(version => semver.gt(version, lowerVersion[0]));
+ }
+
+ return getEarliestVersion(versions);
+}
+
+function getRange(min, max) {
+ return `>=${min}${max ? ` <${max}` : ''}`;
+}
+
+function makeTag(tagFormat, version) {
+ return template(tagFormat)({version});
+}
+
+function isSameChannel(channel, otherChannel) {
+ return channel === otherChannel || (!channel && !otherChannel);
+}
+
+module.exports = {
+ extractErrors,
+ hideSensitiveValues,
+ tagsToVersions,
+ isMajorRange,
+ isMaintenanceRange,
+ getUpperBound,
+ getLowerBound,
+ highest,
+ lowest,
+ getLatestVersion,
+ getEarliestVersion,
+ getFirstVersion,
+ getRange,
+ makeTag,
+ isSameChannel,
+};
diff --git a/lib/verify.js b/lib/verify.js
index 462d9a60da..c789191146 100644
--- a/lib/verify.js
+++ b/lib/verify.js
@@ -1,9 +1,14 @@
-const {template} = require('lodash');
+const {template, isString, isPlainObject} = 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}}) => {
+module.exports = async context => {
+ const {
+ cwd,
+ env,
+ options: {repositoryUrl, tagFormat, branches},
+ } = context;
const errors = [];
if (!(await isGitRepo({cwd, env}))) {
@@ -14,16 +19,24 @@ module.exports = async ({cwd, env, options: {repositoryUrl, tagFormat}}) => {
// Verify that compiling the `tagFormat` produce a valid Git tag
if (!(await verifyTagName(template(tagFormat)({version: '0.0.0'})))) {
- errors.push(getError('EINVALIDTAGFORMAT', {tagFormat}));
+ errors.push(getError('EINVALIDTAGFORMAT', context));
}
// 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}));
+ errors.push(getError('ETAGNOVERSION', context));
}
+ branches.forEach(branch => {
+ if (
+ !((isString(branch) && branch.trim()) || (isPlainObject(branch) && isString(branch.name) && branch.name.trim()))
+ ) {
+ errors.push(getError('EINVALIDBRANCH', {branch}));
+ }
+ });
+
if (errors.length > 0) {
throw new AggregateError(errors);
}
diff --git a/package.json b/package.json
index aebb181685..01bf4aa4c9 100644
--- a/package.json
+++ b/package.json
@@ -22,10 +22,10 @@
"Pierre Vanduynslager (https://twitter.com/@pvdlg_)"
],
"dependencies": {
- "@semantic-release/commit-analyzer": "^6.1.0",
+ "@semantic-release/commit-analyzer": "^7.0.0-beta",
"@semantic-release/error": "^2.2.0",
- "@semantic-release/github": "^5.1.0",
- "@semantic-release/npm": "^5.0.5",
+ "@semantic-release/github": "^5.6.0-beta",
+ "@semantic-release/npm": "^6.0.0-beta",
"@semantic-release/release-notes-generator": "^7.1.2",
"aggregate-error": "^3.0.0",
"cosmiconfig": "^6.0.0",
@@ -41,11 +41,13 @@
"lodash": "^4.17.15",
"marked": "^0.7.0",
"marked-terminal": "^3.2.0",
- "p-locate": "^4.0.0",
+ "micromatch": "^4.0.2",
+ "p-each-series": "^2.1.0",
"p-reduce": "^2.0.0",
"read-pkg-up": "^7.0.0",
"resolve-from": "^5.0.0",
"semver": "^6.0.0",
+ "semver-diff": "^3.1.1",
"signale": "^1.2.1",
"yargs": "^15.0.1"
},
@@ -70,7 +72,7 @@
"xo": "^0.25.0"
},
"engines": {
- "node": ">=8.16"
+ "node": ">=10.13"
},
"files": [
"bin",
@@ -111,7 +113,7 @@
"trailingComma": "es5"
},
"publishConfig": {
- "tag": "next"
+ "access": "public"
},
"repository": {
"type": "git",
diff --git a/test/branches/branches.test.js b/test/branches/branches.test.js
new file mode 100644
index 0000000000..a87bbba790
--- /dev/null
+++ b/test/branches/branches.test.js
@@ -0,0 +1,259 @@
+import test from 'ava';
+import {union} from 'lodash';
+import semver from 'semver';
+import proxyquire from 'proxyquire';
+
+const getBranch = (branches, branch) => branches.find(({name}) => name === branch);
+const release = (branches, name, version) => getBranch(branches, name).tags.push({version});
+const merge = (branches, source, target, tag) => {
+ getBranch(branches, target).tags = union(
+ getBranch(branches, source).tags.filter(({version}) => !tag || semver.cmp(version, '<=', tag)),
+ getBranch(branches, target).tags
+ );
+};
+
+test('Enforce ranges with branching release workflow', async t => {
+ const branches = [
+ {name: '1.x', tags: []},
+ {name: '1.0.x', tags: []},
+ {name: 'master', tags: []},
+ {name: 'next', tags: []},
+ {name: 'next-major', tags: []},
+ {name: 'beta', prerelease: true, tags: []},
+ {name: 'alpha', prerelease: true, tags: []},
+ ];
+ const getBranches = proxyquire('../../lib/branches', {'./get-tags': () => branches, './expand': () => []});
+
+ let result = (await getBranches('repositoryUrl', 'master', {options: {branches}})).map(({name, range}) => ({
+ name,
+ range,
+ }));
+ t.is(getBranch(result, '1.0.x').range, '>=1.0.0 <1.0.0', 'Cannot release on 1.0.x before a releasing on master');
+ t.is(getBranch(result, '1.x').range, '>=1.1.0 <1.0.0', 'Cannot release on 1.x before a releasing on master');
+ t.is(getBranch(result, 'master').range, '>=1.0.0');
+ t.is(getBranch(result, 'next').range, '>=1.0.0');
+ t.is(getBranch(result, 'next-major').range, '>=1.0.0');
+
+ release(branches, 'master', '1.0.0');
+ result = (await getBranches('repositoryUrl', 'master', {options: {branches}})).map(({name, range}) => ({
+ name,
+ range,
+ }));
+ t.is(getBranch(result, '1.0.x').range, '>=1.0.0 <1.0.0', 'Cannot release on 1.0.x before a releasing on master');
+ t.is(getBranch(result, '1.x').range, '>=1.1.0 <1.0.0', 'Cannot release on 1.x before a releasing on master');
+ t.is(getBranch(result, 'master').range, '>=1.0.0');
+ t.is(getBranch(result, 'next').range, '>=1.0.0');
+ t.is(getBranch(result, 'next-major').range, '>=1.0.0');
+
+ release(branches, 'master', '1.0.1');
+ result = (await getBranches('repositoryUrl', 'master', {options: {branches}})).map(({name, range}) => ({
+ name,
+ range,
+ }));
+ t.is(getBranch(result, 'master').range, '>=1.0.1', 'Can release only > than 1.0.1 on master');
+ t.is(getBranch(result, 'next').range, '>=1.0.1', 'Can release only > than 1.0.1 on next');
+ t.is(getBranch(result, 'next-major').range, '>=1.0.1', 'Can release only > than 1.0.1 on next-major');
+
+ merge(branches, 'master', 'next');
+ merge(branches, 'master', 'next-major');
+ result = (await getBranches('repositoryUrl', 'master', {options: {branches}})).map(({name, range}) => ({
+ name,
+ range,
+ }));
+ t.is(getBranch(result, 'master').range, '>=1.0.1', 'Can release only > than 1.0.1 on master');
+ t.is(getBranch(result, 'next').range, '>=1.0.1', 'Can release only > than 1.0.1 on next');
+ t.is(getBranch(result, 'next-major').range, '>=1.0.1', 'Can release only > than 1.0.1 on next-major');
+
+ release(branches, 'next', '1.1.0');
+ release(branches, 'next', '1.1.1');
+ result = (await getBranches('repositoryUrl', 'master', {options: {branches}})).map(({name, range}) => ({
+ name,
+ range,
+ }));
+ t.is(getBranch(result, 'master').range, '>=1.0.1 <1.1.0', 'Can release only patch, > than 1.0.1 on master');
+ t.is(getBranch(result, 'next').range, '>=1.1.1', 'Can release only > than 1.1.1 on next');
+ t.is(getBranch(result, 'next-major').range, '>=1.1.1', 'Can release > than 1.1.1 on next-major');
+
+ release(branches, 'next-major', '2.0.0');
+ release(branches, 'next-major', '2.0.1');
+ result = (await getBranches('repositoryUrl', 'master', {options: {branches}})).map(({name, range}) => ({
+ name,
+ range,
+ }));
+ t.is(getBranch(result, 'master').range, '>=1.0.1 <1.1.0', 'Can release only patch, > than 1.0.1 on master');
+ t.is(getBranch(result, 'next').range, '>=1.1.1 <2.0.0', 'Can release only patch or minor, > than 1.1.0 on next');
+ t.is(getBranch(result, 'next-major').range, '>=2.0.1', 'Can release any version, > than 2.0.1 on next-major');
+
+ merge(branches, 'next-major', 'beta');
+ release(branches, 'beta', '3.0.0-beta.1');
+ merge(branches, 'beta', 'alpha');
+ release(branches, 'alpha', '4.0.0-alpha.1');
+ result = (await getBranches('repositoryUrl', 'master', {options: {branches}})).map(({name, range}) => ({
+ name,
+ range,
+ }));
+ t.is(getBranch(result, 'next-major').range, '>=2.0.1', 'Can release any version, > than 2.0.1 on next-major');
+
+ merge(branches, 'master', '1.0.x');
+ merge(branches, 'master', '1.x');
+ result = (await getBranches('repositoryUrl', 'master', {options: {branches}})).map(({name, range}) => ({
+ name,
+ range,
+ }));
+ t.is(getBranch(result, 'master').range, '>=1.0.1 <1.1.0', 'Can release only patch, > than 1.0.1 on master');
+ t.is(
+ getBranch(result, '1.0.x').range,
+ '>=1.0.1 <1.0.1',
+ 'Cannot release on 1.0.x before >= 1.1.0 is released on master'
+ );
+ t.is(getBranch(result, '1.x').range, '>=1.1.0 <1.0.1', 'Cannot release on 1.x before >= 1.2.0 is released on master');
+
+ release(branches, 'master', '1.0.2');
+ release(branches, 'master', '1.0.3');
+ release(branches, 'master', '1.0.4');
+ result = (await getBranches('repositoryUrl', 'master', {options: {branches}})).map(({name, range}) => ({
+ name,
+ range,
+ }));
+ t.is(getBranch(result, 'master').range, '>=1.0.4 <1.1.0', 'Can release only patch, > than 1.0.4 on master');
+ t.is(
+ getBranch(result, '1.0.x').range,
+ '>=1.0.1 <1.0.2',
+ 'Cannot release on 1.0.x before >= 1.1.0 is released on master'
+ );
+ t.is(getBranch(result, '1.x').range, '>=1.1.0 <1.0.2', 'Cannot release on 1.x before >= 1.2.0 is released on master');
+
+ merge(branches, 'next', 'master');
+ result = (await getBranches('repositoryUrl', 'master', {options: {branches}})).map(({name, range}) => ({
+ name,
+ range,
+ }));
+
+ t.is(getBranch(result, 'master').range, '>=1.1.1', 'Can release only > than 1.1.1 on master');
+ t.is(getBranch(result, 'next').range, '>=1.1.1 <2.0.0', 'Can release only patch or minor, > than 1.1.1 on next');
+ t.is(getBranch(result, 'next-major').range, '>=2.0.1', 'Can release any version, > than 2.0.1 on next-major');
+ t.is(
+ getBranch(result, '1.0.x').range,
+ '>=1.0.1 <1.0.2',
+ 'Cannot release on 1.0.x before 1.0.x version from master are merged'
+ );
+ t.is(getBranch(result, '1.x').range, '>=1.1.0 <1.0.2', 'Cannot release on 1.x before >= 2.0.0 is released on master');
+
+ merge(branches, 'master', '1.0.x', '1.0.4');
+ result = (await getBranches('repositoryUrl', 'master', {options: {branches}})).map(({name, range}) => ({
+ name,
+ range,
+ }));
+ t.is(getBranch(result, 'master').range, '>=1.1.1', 'Can release only > than 1.1.1 on master');
+ t.is(getBranch(result, '1.0.x').range, '>=1.0.4 <1.1.0', 'Can release on 1.0.x only within range');
+ t.is(getBranch(result, '1.x').range, '>=1.1.0 <1.1.0', 'Cannot release on 1.x before >= 2.0.0 is released on master');
+
+ merge(branches, 'master', '1.x');
+ result = (await getBranches('repositoryUrl', 'master', {options: {branches}})).map(({name, range}) => ({
+ name,
+ range,
+ }));
+ t.is(getBranch(result, 'master').range, '>=1.1.1', 'Can release only > than 1.1.1 on master');
+ t.is(getBranch(result, '1.0.x').range, '>=1.0.4 <1.1.0', 'Can release on 1.0.x only within range');
+ t.is(getBranch(result, '1.x').range, '>=1.1.1 <1.1.1', 'Cannot release on 1.x before >= 2.0.0 is released on master');
+
+ merge(branches, 'next-major', 'next');
+ merge(branches, 'next', 'master');
+ result = (await getBranches('repositoryUrl', 'master', {options: {branches}})).map(({name, range}) => ({
+ name,
+ range,
+ }));
+ t.is(getBranch(result, 'master').range, '>=2.0.1', 'Can release only > than 2.0.1 on master');
+ t.is(getBranch(result, 'next').range, '>=2.0.1', 'Can release only > than 2.0.1 on next');
+ t.is(getBranch(result, 'next-major').range, '>=2.0.1', 'Can release only > than 2.0.1 on next-major');
+ t.is(getBranch(result, '1.x').range, '>=1.1.1 <2.0.0', 'Can release on 1.x only within range');
+
+ merge(branches, 'beta', 'master');
+ release(branches, 'master', '3.0.0');
+ result = (await getBranches('repositoryUrl', 'master', {options: {branches}})).map(({name, range}) => ({
+ name,
+ range,
+ }));
+ t.is(getBranch(result, 'master').range, '>=3.0.0', 'Can release only > than 3.0.0 on master');
+ t.is(getBranch(result, 'next').range, '>=3.0.0', 'Can release only > than 3.0.0 on next');
+ t.is(getBranch(result, 'next-major').range, '>=3.0.0', 'Can release only > than 3.0.0 on next-major');
+
+ branches.push({name: '1.1.x', tags: []});
+ merge(branches, '1.x', '1.1.x');
+ result = (await getBranches('repositoryUrl', 'master', {options: {branches}})).map(({name, range}) => ({
+ name,
+ range,
+ }));
+ t.is(getBranch(result, '1.0.x').range, '>=1.0.4 <1.1.0', 'Can release on 1.0.x only within range');
+ t.is(getBranch(result, '1.1.x').range, '>=1.1.1 <1.2.0', 'Can release on 1.1.x only within range');
+ t.is(getBranch(result, '1.x').range, '>=1.2.0 <2.0.0', 'Can release on 1.x only within range');
+});
+
+test('Throw SemanticReleaseError for invalid configurations', async t => {
+ const branches = [
+ {name: '123', range: '123', tags: []},
+ {name: '1.x', tags: []},
+ {name: 'maintenance-1', range: '1.x', tags: []},
+ {name: '1.x.x', tags: []},
+ {name: 'beta', prerelease: '', tags: []},
+ {name: 'alpha', prerelease: 'alpha', tags: []},
+ {name: 'preview', prerelease: 'alpha', tags: []},
+ ];
+ const getBranches = proxyquire('../../lib/branches', {'./get-tags': () => branches, './expand': () => []});
+ const errors = [...(await t.throwsAsync(getBranches('repositoryUrl', 'master', {options: {branches}})))];
+
+ t.is(errors[0].name, 'SemanticReleaseError');
+ t.is(errors[0].code, 'EMAINTENANCEBRANCH');
+ t.truthy(errors[0].message);
+ t.truthy(errors[0].details);
+ t.is(errors[1].name, 'SemanticReleaseError');
+ t.is(errors[1].code, 'EMAINTENANCEBRANCHES');
+ t.truthy(errors[1].message);
+ t.truthy(errors[1].details);
+ t.is(errors[2].name, 'SemanticReleaseError');
+ t.is(errors[2].code, 'EPRERELEASEBRANCH');
+ t.truthy(errors[2].message);
+ t.truthy(errors[2].details);
+ t.is(errors[3].name, 'SemanticReleaseError');
+ t.is(errors[3].code, 'EPRERELEASEBRANCHES');
+ t.truthy(errors[3].message);
+ t.truthy(errors[3].details);
+ t.is(errors[4].name, 'SemanticReleaseError');
+ t.is(errors[4].code, 'ERELEASEBRANCHES');
+ t.truthy(errors[4].message);
+ t.truthy(errors[4].details);
+});
+
+test('Throw a SemanticReleaseError if there is duplicate branches', async t => {
+ const branches = [
+ {name: 'master', tags: []},
+ {name: 'master', tags: []},
+ ];
+ const getBranches = proxyquire('../../lib/branches', {'./get-tags': () => branches, './expand': () => []});
+
+ const errors = [...(await t.throwsAsync(getBranches('repositoryUrl', 'master', {options: {branches}})))];
+
+ t.is(errors[0].name, 'SemanticReleaseError');
+ t.is(errors[0].code, 'EDUPLICATEBRANCHES');
+ t.truthy(errors[0].message);
+ t.truthy(errors[0].details);
+});
+
+test('Throw a SemanticReleaseError for each invalid branch name', async t => {
+ const branches = [
+ {name: '~master', tags: []},
+ {name: '^master', tags: []},
+ ];
+ const getBranches = proxyquire('../../lib/branches', {'./get-tags': () => branches, './expand': () => []});
+
+ const errors = [...(await t.throwsAsync(getBranches('repositoryUrl', 'master', {options: {branches}})))];
+
+ t.is(errors[0].name, 'SemanticReleaseError');
+ t.is(errors[0].code, 'EINVALIDBRANCHNAME');
+ t.truthy(errors[0].message);
+ t.truthy(errors[0].details);
+ t.is(errors[1].name, 'SemanticReleaseError');
+ t.is(errors[1].code, 'EINVALIDBRANCHNAME');
+ t.truthy(errors[1].message);
+ t.truthy(errors[1].details);
+});
diff --git a/test/branches/expand.test.js b/test/branches/expand.test.js
new file mode 100644
index 0000000000..a912e193da
--- /dev/null
+++ b/test/branches/expand.test.js
@@ -0,0 +1,54 @@
+import test from 'ava';
+import expand from '../../lib/branches/expand';
+import {gitRepo, gitCommits, gitCheckout, gitPush} from '../helpers/git-utils';
+
+test('Expand branches defined with globs', async t => {
+ const {cwd, repositoryUrl} = await gitRepo(true);
+ await gitCommits(['First'], {cwd});
+ await gitPush(repositoryUrl, 'master', {cwd});
+ await gitCheckout('1.0.x', true, {cwd});
+ await gitCommits(['Second'], {cwd});
+ await gitPush(repositoryUrl, '1.0.x', {cwd});
+ await gitCheckout('1.x.x', true, {cwd});
+ await gitCommits(['Third'], {cwd});
+ await gitPush(repositoryUrl, '1.x.x', {cwd});
+ await gitCheckout('2.x', true, {cwd});
+ await gitCommits(['Fourth'], {cwd});
+ await gitPush(repositoryUrl, '2.x', {cwd});
+ await gitCheckout('next', true, {cwd});
+ await gitCommits(['Fifth'], {cwd});
+ await gitPush(repositoryUrl, 'next', {cwd});
+ await gitCheckout('pre/foo', true, {cwd});
+ await gitCommits(['Sixth'], {cwd});
+ await gitPush(repositoryUrl, 'pre/foo', {cwd});
+ await gitCheckout('pre/bar', true, {cwd});
+ await gitCommits(['Seventh'], {cwd});
+ await gitPush(repositoryUrl, 'pre/bar', {cwd});
+ await gitCheckout('beta', true, {cwd});
+ await gitCommits(['Eighth'], {cwd});
+ await gitPush(repositoryUrl, 'beta', {cwd});
+
+ const branches = [
+ // Should match all maintenance type branches
+ {name: '+([0-9])?(.{+([0-9]),x}).x'},
+ {name: 'master', channel: 'latest'},
+ {name: 'next'},
+ {name: 'pre/{foo,bar}', channel: `\${name.replace(/^pre\\//g, '')}`, prerelease: true},
+ // Should be ignored as there is no matching branches in the repo
+ {name: 'missing'},
+ // Should be ignored as the matching branch in the repo is already matched by `/^pre\\/(\\w+)$/gi`
+ {name: '*/foo', channel: 'foo', prerelease: 'foo'},
+ {name: 'beta', channel: `channel-\${name}`, prerelease: true},
+ ];
+
+ t.deepEqual(await expand(repositoryUrl, {cwd}, branches), [
+ {name: '1.0.x'},
+ {name: '1.x.x'},
+ {name: '2.x'},
+ {name: 'master', channel: 'latest'},
+ {name: 'next'},
+ {name: 'pre/bar', channel: 'bar', prerelease: true},
+ {name: 'pre/foo', channel: 'foo', prerelease: true},
+ {name: 'beta', channel: 'channel-beta', prerelease: true},
+ ]);
+});
diff --git a/test/branches/get-tags.test.js b/test/branches/get-tags.test.js
new file mode 100644
index 0000000000..7321f92323
--- /dev/null
+++ b/test/branches/get-tags.test.js
@@ -0,0 +1,153 @@
+import test from 'ava';
+import getTags from '../../lib/branches/get-tags';
+import {gitRepo, gitCommits, gitTagVersion, gitCheckout, gitAddNote} from '../helpers/git-utils';
+
+test('Get the valid tags', async t => {
+ const {cwd} = await gitRepo();
+ const commits = await gitCommits(['First'], {cwd});
+ await gitTagVersion('foo', undefined, {cwd});
+ await gitTagVersion('v2.0.0', undefined, {cwd});
+ commits.push(...(await gitCommits(['Second'], {cwd})));
+ await gitTagVersion('v1.0.0', undefined, {cwd});
+ commits.push(...(await gitCommits(['Third'], {cwd})));
+ await gitTagVersion('v3.0', undefined, {cwd});
+ commits.push(...(await gitCommits(['Fourth'], {cwd})));
+ await gitTagVersion('v3.0.0-beta.1', undefined, {cwd});
+
+ const result = await getTags({cwd, options: {tagFormat: `v\${version}`}}, [{name: 'master'}]);
+
+ t.deepEqual(result, [
+ {
+ name: 'master',
+ tags: [
+ {gitTag: 'v1.0.0', version: '1.0.0', channels: [null]},
+ {gitTag: 'v2.0.0', version: '2.0.0', channels: [null]},
+ {gitTag: 'v3.0.0-beta.1', version: '3.0.0-beta.1', channels: [null]},
+ ],
+ },
+ ]);
+});
+
+test('Get the valid tags from multiple branches', async t => {
+ const {cwd} = await gitRepo();
+ await gitCommits(['First'], {cwd});
+ await gitTagVersion('v1.0.0', undefined, {cwd});
+ await gitAddNote(JSON.stringify({channels: [null, '1.x']}), 'v1.0.0', {cwd});
+ await gitCommits(['Second'], {cwd});
+ await gitTagVersion('v1.1.0', undefined, {cwd});
+ await gitAddNote(JSON.stringify({channels: [null, '1.x']}), 'v1.1.0', {cwd});
+ await gitCheckout('1.x', true, {cwd});
+ await gitCheckout('master', false, {cwd});
+ await gitCommits(['Third'], {cwd});
+ await gitTagVersion('v2.0.0', undefined, {cwd});
+ await gitAddNote(JSON.stringify({channels: [null, 'next']}), 'v2.0.0', {cwd});
+ await gitCheckout('next', true, {cwd});
+ await gitCommits(['Fourth'], {cwd});
+ await gitTagVersion('v3.0.0', undefined, {cwd});
+ await gitAddNote(JSON.stringify({channels: ['next']}), 'v3.0.0', {cwd});
+
+ const result = await getTags({cwd, options: {tagFormat: `v\${version}`}}, [
+ {name: '1.x'},
+ {name: 'master'},
+ {name: 'next'},
+ ]);
+
+ t.deepEqual(result, [
+ {
+ name: '1.x',
+ tags: [
+ {gitTag: 'v1.0.0', version: '1.0.0', channels: [null, '1.x']},
+ {gitTag: 'v1.1.0', version: '1.1.0', channels: [null, '1.x']},
+ ],
+ },
+ {
+ name: 'master',
+ tags: [...result[0].tags, {gitTag: 'v2.0.0', version: '2.0.0', channels: [null, 'next']}],
+ },
+ {
+ name: 'next',
+ tags: [...result[1].tags, {gitTag: 'v3.0.0', version: '3.0.0', channels: ['next']}],
+ },
+ ]);
+});
+
+test('Return branches with and empty tags array if no valid tag is found', async t => {
+ const {cwd} = await gitRepo();
+ 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 getTags({cwd, options: {tagFormat: `prefix@v\${version}`}}, [{name: 'master'}]);
+
+ t.deepEqual(result, [{name: 'master', tags: []}]);
+});
+
+test('Return branches with and empty tags array if no valid tag is found in history of configured branches', async t => {
+ const {cwd} = await gitRepo();
+ await gitCommits(['First'], {cwd});
+ await gitCheckout('next', true, {cwd});
+ await gitCommits(['Second'], {cwd});
+ await gitTagVersion('v1.0.0', undefined, {cwd});
+ await gitAddNote(JSON.stringify({channels: [null, 'next']}), 'v1.0.0', {cwd});
+ await gitCommits(['Third'], {cwd});
+ await gitTagVersion('v2.0.0', undefined, {cwd});
+ await gitAddNote(JSON.stringify({channels: [null, 'next']}), 'v2.0.0', {cwd});
+ await gitCommits(['Fourth'], {cwd});
+ await gitTagVersion('v3.0.0', undefined, {cwd});
+ await gitAddNote(JSON.stringify({channels: [null, 'next']}), 'v3.0.0', {cwd});
+ await gitCheckout('master', false, {cwd});
+
+ const result = await getTags({cwd, options: {tagFormat: `prefix@v\${version}`}}, [{name: 'master'}, {name: 'next'}]);
+
+ t.deepEqual(result, [
+ {name: 'master', tags: []},
+ {name: 'next', tags: []},
+ ]);
+});
+
+test('Get the highest valid tag corresponding to the "tagFormat"', async t => {
+ const {cwd} = await gitRepo();
+ await gitCommits(['First'], {cwd});
+
+ await gitTagVersion('1.0.0', undefined, {cwd});
+ t.deepEqual(await getTags({cwd, options: {tagFormat: `\${version}`}}, [{name: 'master'}]), [
+ {name: 'master', tags: [{gitTag: '1.0.0', version: '1.0.0', channels: [null]}]},
+ ]);
+
+ await gitTagVersion('foo-1.0.0-bar', undefined, {cwd});
+ t.deepEqual(await getTags({cwd, options: {tagFormat: `foo-\${version}-bar`}}, [{name: 'master'}]), [
+ {name: 'master', tags: [{gitTag: 'foo-1.0.0-bar', version: '1.0.0', channels: [null]}]},
+ ]);
+
+ await gitTagVersion('foo-v1.0.0-bar', undefined, {cwd});
+ t.deepEqual(await getTags({cwd, options: {tagFormat: `foo-v\${version}-bar`}}, [{name: 'master'}]), [
+ {
+ name: 'master',
+ tags: [{gitTag: 'foo-v1.0.0-bar', version: '1.0.0', channels: [null]}],
+ },
+ ]);
+
+ await gitTagVersion('(.+)/1.0.0/(a-z)', undefined, {cwd});
+ t.deepEqual(await getTags({cwd, options: {tagFormat: `(.+)/\${version}/(a-z)`}}, [{name: 'master'}]), [
+ {
+ name: 'master',
+ tags: [{gitTag: '(.+)/1.0.0/(a-z)', version: '1.0.0', channels: [null]}],
+ },
+ ]);
+
+ await gitTagVersion('2.0.0-1.0.0-bar.1', undefined, {cwd});
+ t.deepEqual(await getTags({cwd, options: {tagFormat: `2.0.0-\${version}-bar.1`}}, [{name: 'master'}]), [
+ {
+ name: 'master',
+ tags: [{gitTag: '2.0.0-1.0.0-bar.1', version: '1.0.0', channels: [null]}],
+ },
+ ]);
+
+ await gitTagVersion('3.0.0-bar.2', undefined, {cwd});
+ t.deepEqual(await getTags({cwd, options: {tagFormat: `\${version}-bar.2`}}, [{name: 'master'}]), [
+ {name: 'master', tags: [{gitTag: '3.0.0-bar.2', version: '3.0.0', channels: [null]}]},
+ ]);
+});
diff --git a/test/branches/normalize.test.js b/test/branches/normalize.test.js
new file mode 100644
index 0000000000..765ec866ae
--- /dev/null
+++ b/test/branches/normalize.test.js
@@ -0,0 +1,397 @@
+import test from 'ava';
+import normalize from '../../lib/branches/normalize';
+
+const toTags = versions => versions.map(version => ({version}));
+
+test('Maintenance branches - initial state', t => {
+ const maintenance = [
+ {name: '1.x', channel: '1.x', tags: []},
+ {name: '1.1.x', tags: []},
+ {name: '1.2.x', tags: []},
+ ];
+ const release = [{name: 'master', tags: []}];
+ t.deepEqual(
+ normalize.maintenance({maintenance, release}).map(({type, name, range, accept, channel, mergeRange}) => ({
+ type,
+ name,
+ range,
+ accept,
+ channel,
+ mergeRange,
+ })),
+ [
+ {
+ type: 'maintenance',
+ name: '1.1.x',
+ range: '>=1.1.0 <1.0.0',
+ accept: [],
+ channel: '1.1.x',
+ mergeRange: '>=1.1.0 <1.2.0',
+ },
+ {
+ type: 'maintenance',
+ name: '1.2.x',
+ range: '>=1.2.0 <1.0.0',
+ accept: [],
+ channel: '1.2.x',
+ mergeRange: '>=1.2.0 <1.3.0',
+ },
+ {
+ type: 'maintenance',
+ name: '1.x',
+ range: '>=1.3.0 <1.0.0',
+ accept: [],
+ channel: '1.x',
+ mergeRange: '>=1.3.0 <2.0.0',
+ },
+ ]
+ );
+});
+
+test('Maintenance branches - cap range to first release present on default branch and not in any Maintenance one', t => {
+ const maintenance = [
+ {name: '1.x', tags: toTags(['1.0.0', '1.1.0', '1.1.1', '1.2.0', '1.2.1', '1.3.0', '1.4.0', '1.5.0'])},
+ {name: 'name', range: '1.1.x', tags: toTags(['1.0.0', '1.0.1', '1.1.0', '1.1.1'])},
+ {name: '1.2.x', tags: toTags(['1.0.0', '1.1.0', '1.1.1', '1.2.0', '1.2.1'])},
+ {name: '2.x.x', tags: toTags(['1.0.0', '1.1.0', '1.1.1', '1.2.0', '1.2.1', '1.5.0'])},
+ ];
+ const release = [
+ {
+ name: 'master',
+ tags: toTags(['1.0.0', '1.1.0', '1.1.1', '1.2.0', '1.2.1', '1.3.0', '1.4.0', '1.5.0', '1.6.0', '2.0.0']),
+ },
+ ];
+
+ t.deepEqual(
+ normalize
+ .maintenance({maintenance, release})
+ .map(({type, name, range, accept, channel, mergeRange: maintenanceRange}) => ({
+ type,
+ name,
+ range,
+ accept,
+ channel,
+ mergeRange: maintenanceRange,
+ })),
+ [
+ {
+ type: 'maintenance',
+ name: 'name',
+ range: '>=1.1.1 <1.2.0',
+ accept: ['patch'],
+ channel: 'name',
+ mergeRange: '>=1.1.0 <1.2.0',
+ },
+ {
+ type: 'maintenance',
+ name: '1.2.x',
+ range: '>=1.2.1 <1.3.0',
+ accept: ['patch'],
+ channel: '1.2.x',
+ mergeRange: '>=1.2.0 <1.3.0',
+ },
+ {
+ type: 'maintenance',
+ name: '1.x',
+ range: '>=1.5.0 <1.6.0',
+ accept: ['patch'],
+ channel: '1.x',
+ mergeRange: '>=1.3.0 <2.0.0',
+ },
+ {
+ type: 'maintenance',
+ name: '2.x.x',
+ range: '>=2.0.0 <1.6.0',
+ accept: [],
+ channel: '2.x.x',
+ mergeRange: '>=2.0.0 <3.0.0',
+ },
+ ]
+ );
+});
+
+test('Maintenance branches - cap range to default branch last release if all release are also present on maintenance branch', t => {
+ const maintenance = [
+ {name: '1.x', tags: toTags(['1.0.0', '1.2.0', '1.3.0'])},
+ {name: '2.x.x', tags: toTags(['1.0.0', '1.2.0', '1.3.0', '2.0.0'])},
+ ];
+ const release = [{name: 'master', tags: toTags(['1.0.0', '1.2.0', '1.3.0', '2.0.0'])}];
+
+ t.deepEqual(
+ normalize.maintenance({maintenance, release}).map(({type, name, range, accept, channel, mergeRange}) => ({
+ type,
+ name,
+ range,
+ accept,
+ channel,
+ mergeRange,
+ })),
+ [
+ {
+ type: 'maintenance',
+ name: '1.x',
+ range: '>=1.3.0 <2.0.0',
+ accept: ['patch', 'minor'],
+ channel: '1.x',
+ mergeRange: '>=1.0.0 <2.0.0',
+ },
+ {
+ type: 'maintenance',
+ name: '2.x.x',
+ range: '>=2.0.0 <2.0.0',
+ accept: [],
+ channel: '2.x.x',
+ mergeRange: '>=2.0.0 <3.0.0',
+ },
+ ]
+ );
+});
+
+test('Release branches - initial state', t => {
+ const release = [
+ {name: 'master', tags: []},
+ {name: 'next', channel: 'next', tags: []},
+ {name: 'next-major', tags: []},
+ ];
+
+ t.deepEqual(
+ normalize
+ .release({release})
+ .map(({type, name, range, accept, channel, main}) => ({type, name, range, accept, channel, main})),
+ [
+ {
+ type: 'release',
+ name: 'master',
+ range: '>=1.0.0',
+ accept: ['patch', 'minor', 'major'],
+ channel: undefined,
+ main: true,
+ },
+ {
+ type: 'release',
+ name: 'next',
+ range: '>=1.0.0',
+ accept: ['patch', 'minor', 'major'],
+ channel: 'next',
+ main: false,
+ },
+ {
+ type: 'release',
+ name: 'next-major',
+ range: '>=1.0.0',
+ accept: ['patch', 'minor', 'major'],
+ channel: 'next-major',
+ main: false,
+ },
+ ]
+ );
+});
+
+test('Release branches - 3 release branches', t => {
+ const release = [
+ {name: 'master', tags: toTags(['1.0.0', '1.0.1', '1.0.2'])},
+ {name: 'next', tags: toTags(['1.0.0', '1.0.1', '1.0.2', '1.1.0', '1.2.0'])},
+ {name: 'next-major', tags: toTags(['1.0.0', '1.0.1', '1.0.2', '1.1.0', '1.2.0', '2.0.0', '2.0.1', '2.1.0'])},
+ ];
+
+ t.deepEqual(
+ normalize
+ .release({release})
+ .map(({type, name, range, accept, channel, main}) => ({type, name, range, accept, channel, main})),
+ [
+ {type: 'release', name: 'master', range: '>=1.0.2 <1.1.0', accept: ['patch'], channel: undefined, main: true},
+ {
+ type: 'release',
+ name: 'next',
+ range: '>=1.2.0 <2.0.0',
+ accept: ['patch', 'minor'],
+ channel: 'next',
+ main: false,
+ },
+ {
+ type: 'release',
+ name: 'next-major',
+ range: '>=2.1.0',
+ accept: ['patch', 'minor', 'major'],
+ channel: 'next-major',
+ main: false,
+ },
+ ]
+ );
+});
+
+test('Release branches - 2 release branches', t => {
+ const release = [
+ {name: 'master', tags: toTags(['1.0.0', '1.0.1', '1.1.0', '1.1.1', '1.2.0'])},
+ {name: 'next', tags: toTags(['1.0.0', '1.0.1', '1.1.0', '1.1.1', '1.2.0', '2.0.0', '2.0.1', '2.1.0'])},
+ ];
+
+ t.deepEqual(
+ normalize
+ .release({release})
+ .map(({type, name, range, accept, channel, main}) => ({type, name, range, accept, channel, main})),
+ [
+ {
+ type: 'release',
+ name: 'master',
+ range: '>=1.2.0 <2.0.0',
+ accept: ['patch', 'minor'],
+ channel: undefined,
+ main: true,
+ },
+ {
+ type: 'release',
+ name: 'next',
+ range: '>=2.1.0',
+ accept: ['patch', 'minor', 'major'],
+ channel: 'next',
+ main: false,
+ },
+ ]
+ );
+});
+
+test('Release branches - 1 release branches', t => {
+ const release = [{name: 'master', tags: toTags(['1.0.0', '1.1.0', '1.1.1', '1.2.0'])}];
+
+ t.deepEqual(
+ normalize.release({release}).map(({type, name, range, accept, channel}) => ({type, name, range, accept, channel})),
+ [{type: 'release', name: 'master', range: '>=1.2.0', accept: ['patch', 'minor', 'major'], channel: undefined}]
+ );
+});
+
+test('Release branches - cap ranges to first release only present on following branch', t => {
+ const release = [
+ {name: 'master', tags: toTags(['1.0.0', '1.1.0', '1.2.0', '2.0.0'])},
+ {name: 'next', tags: toTags(['1.0.0', '1.1.0', '1.2.0', '2.0.0', '2.1.0'])},
+ {name: 'next-major', tags: toTags(['1.0.0', '1.1.0', '1.2.0', '2.0.0', '2.1.0', '2.2.0'])},
+ ];
+
+ t.deepEqual(
+ normalize
+ .release({release})
+ .map(({type, name, range, accept, channel, main}) => ({type, name, range, accept, channel, main})),
+ [
+ {type: 'release', name: 'master', range: '>=2.0.0 <2.1.0', accept: ['patch'], channel: undefined, main: true},
+ {type: 'release', name: 'next', range: '>=2.1.0 <2.2.0', accept: ['patch'], channel: 'next', main: false},
+ {
+ type: 'release',
+ name: 'next-major',
+ range: '>=2.2.0',
+ accept: ['patch', 'minor', 'major'],
+ channel: 'next-major',
+ main: false,
+ },
+ ]
+ );
+});
+
+test('Release branches - Handle missing previous tags in branch history', t => {
+ const release = [
+ {name: 'master', tags: toTags(['1.0.0', '2.0.0'])},
+ {name: 'next', tags: toTags(['1.0.0', '1.1.0', '1.1.1', '1.2.0', '2.0.0'])},
+ ];
+
+ t.deepEqual(
+ normalize
+ .release({release})
+ .map(({type, name, range, accept, channel, main}) => ({type, name, range, accept, channel, main})),
+ [
+ {
+ type: 'release',
+ name: 'master',
+ range: '>=2.0.0',
+ accept: ['patch', 'minor', 'major'],
+ channel: undefined,
+ main: true,
+ },
+ {
+ type: 'release',
+ name: 'next',
+ range: '>=2.0.0',
+ accept: ['patch', 'minor', 'major'],
+ channel: 'next',
+ main: false,
+ },
+ ]
+ );
+});
+
+test('Release branches - limit releases on 2nd and 3rd branch based on 1st branch last release', t => {
+ const release = [
+ {name: 'master', tags: toTags(['1.0.0', '1.1.0', '2.0.0', '3.0.0'])},
+ {name: 'next', tags: toTags(['1.0.0', '1.1.0'])},
+ {name: 'next-major', tags: toTags(['1.0.0', '1.1.0', '2.0.0'])},
+ ];
+
+ t.deepEqual(
+ normalize
+ .release({release})
+ .map(({type, name, range, accept, channel, main}) => ({type, name, range, accept, channel, main})),
+ [
+ {
+ type: 'release',
+ name: 'master',
+ range: '>=3.0.0',
+ accept: ['patch', 'minor', 'major'],
+ channel: undefined,
+ main: true,
+ },
+ {
+ type: 'release',
+ name: 'next',
+ range: '>=3.0.0',
+ accept: ['patch', 'minor', 'major'],
+ channel: 'next',
+ main: false,
+ },
+ {
+ type: 'release',
+ name: 'next-major',
+ range: '>=3.0.0',
+ accept: ['patch', 'minor', 'major'],
+ channel: 'next-major',
+ main: false,
+ },
+ ]
+ );
+});
+
+test('Prerelease branches', t => {
+ const prerelease = [
+ {name: 'beta', channel: 'beta', prerelease: true, tags: []},
+ {name: 'alpha', prerelease: 'preview', tags: []},
+ ];
+
+ t.deepEqual(
+ normalize.prerelease({prerelease}).map(({type, name, channel}) => ({type, name, channel})),
+ [
+ {type: 'prerelease', name: 'beta', channel: 'beta'},
+ {type: 'prerelease', name: 'alpha', channel: 'alpha'},
+ ]
+ );
+});
+
+test('Allow to set channel to "false" to prevent default', t => {
+ const maintenance = [{name: '1.x', channel: false, tags: []}];
+ const release = [
+ {name: 'master', channel: false, tags: []},
+ {name: 'next', channel: false, tags: []},
+ ];
+ const prerelease = [{name: 'beta', channel: false, prerelease: true, tags: []}];
+ t.deepEqual(
+ normalize.maintenance({maintenance, release}).map(({name, channel}) => ({name, channel})),
+ [{name: '1.x', channel: false}]
+ );
+ t.deepEqual(
+ normalize.release({release}).map(({name, channel}) => ({name, channel})),
+ [
+ {name: 'master', channel: false},
+ {name: 'next', channel: false},
+ ]
+ );
+ t.deepEqual(
+ normalize.prerelease({prerelease}).map(({name, channel}) => ({name, channel})),
+ [{name: 'beta', channel: false}]
+ );
+});
diff --git a/test/cli.test.js b/test/cli.test.js
index 216db79dab..ee713addaf 100644
--- a/test/cli.test.js
+++ b/test/cli.test.js
@@ -29,6 +29,7 @@ test.serial('Pass options to semantic-release API', async t => {
'',
'-b',
'master',
+ 'next',
'-r',
'https://github/com/owner/repo.git',
'-t',
@@ -68,7 +69,7 @@ test.serial('Pass options to semantic-release API', async t => {
const exitCode = await cli();
- t.is(run.args[0][0].branch, 'master');
+ t.deepEqual(run.args[0][0].branches, ['master', 'next']);
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']);
@@ -92,7 +93,7 @@ test.serial('Pass options to semantic-release API with alias arguments', async t
const argv = [
'',
'',
- '--branch',
+ '--branches',
'master',
'--repository-url',
'https://github/com/owner/repo.git',
@@ -110,7 +111,7 @@ test.serial('Pass options to semantic-release API with alias arguments', async t
const exitCode = await cli();
- t.is(run.args[0][0].branch, 'master');
+ t.deepEqual(run.args[0][0].branches, ['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']);
diff --git a/test/definitions/branches.test.js b/test/definitions/branches.test.js
new file mode 100644
index 0000000000..222334d054
--- /dev/null
+++ b/test/definitions/branches.test.js
@@ -0,0 +1,86 @@
+import test from 'ava';
+import {maintenance, prerelease, release} from '../../lib/definitions/branches';
+
+test('A "maintenance" branch is identified by having a "range" property or a "name" formatted like "N.x", "N.x.x" or "N.N.x"', t => {
+ t.true(maintenance.filter({name: '1.x.x'}));
+ t.true(maintenance.filter({name: '1.0.x'}));
+ t.true(maintenance.filter({name: '1.x'}));
+ t.true(maintenance.filter({name: 'some-name', range: '1.x.x'}));
+ t.true(maintenance.filter({name: 'some-name', range: '1.1.x'}));
+ t.true(maintenance.filter({name: 'some-name', range: ''}));
+ t.true(maintenance.filter({name: 'some-name', range: true}));
+
+ t.false(maintenance.filter({name: 'some-name', range: null}));
+ t.false(maintenance.filter({name: 'some-name', range: false}));
+ t.false(maintenance.filter({name: 'some-name'}));
+ t.false(maintenance.filter({name: '1.0.0'}));
+ t.false(maintenance.filter({name: 'x.x.x'}));
+});
+
+test('A "maintenance" branches must have a "range" property formatted like "N.x", "N.x.x" or "N.N.x"', t => {
+ t.true(maintenance.branchValidator({name: 'some-name', range: '1.x.x'}));
+ t.true(maintenance.branchValidator({name: 'some-name', range: '1.1.x'}));
+
+ t.false(maintenance.branchValidator({name: 'some-name', range: '^1.0.0'}));
+ t.false(maintenance.branchValidator({name: 'some-name', range: '>=1.0.0 <2.0.0'}));
+ t.false(maintenance.branchValidator({name: 'some-name', range: '1.0.0'}));
+ t.false(maintenance.branchValidator({name: 'some-name', range: 'wrong-range'}));
+ t.false(maintenance.branchValidator({name: 'some-name', range: true}));
+ t.false(maintenance.branchValidator({name: 'some-name', range: ''}));
+});
+
+test('The "maintenance" branches must have unique ranges', t => {
+ t.true(maintenance.branchesValidator([{range: '1.x.x'}, {range: '1.0.x'}]));
+
+ t.false(maintenance.branchesValidator([{range: '1.x.x'}, {range: '1.x.x'}]));
+ t.false(maintenance.branchesValidator([{range: '1.x.x'}, {range: '1.x'}]));
+});
+
+test('A "prerelease" branch is identified by having a thruthy "prerelease" property', t => {
+ t.true(prerelease.filter({name: 'some-name', prerelease: true}));
+ t.true(prerelease.filter({name: 'some-name', prerelease: 'beta'}));
+ t.true(prerelease.filter({name: 'some-name', prerelease: ''}));
+
+ t.false(prerelease.filter({name: 'some-name', prerelease: null}));
+ t.false(prerelease.filter({name: 'some-name', prerelease: false}));
+ t.false(prerelease.filter({name: 'some-name'}));
+});
+
+test('A "prerelease" branch must have a valid prerelease detonation in "prerelease" property or in "name" if "prerelease" is "true"', t => {
+ t.true(prerelease.branchValidator({name: 'beta', prerelease: true}));
+ t.true(prerelease.branchValidator({name: 'some-name', prerelease: 'beta'}));
+
+ t.false(prerelease.branchValidator({name: 'some-name', prerelease: ''}));
+ t.false(prerelease.branchValidator({name: 'some-name', prerelease: null}));
+ t.false(prerelease.branchValidator({name: 'some-name', prerelease: false}));
+ t.false(prerelease.branchValidator({name: 'some-name', prerelease: '000'}));
+ t.false(prerelease.branchValidator({name: 'some-name', prerelease: '#beta'}));
+ t.false(prerelease.branchValidator({name: '000', prerelease: true}));
+ t.false(prerelease.branchValidator({name: '#beta', prerelease: true}));
+});
+
+test('The "prerelease" branches must have unique "prerelease" property', t => {
+ t.true(prerelease.branchesValidator([{prerelease: 'beta'}, {prerelease: 'alpha'}]));
+
+ t.false(prerelease.branchesValidator([{range: 'beta'}, {range: 'beta'}, {range: 'alpha'}]));
+});
+
+test('A "release" branch is identified by not havin a "range" or "prerelease" property or a "name" formatted like "N.x", "N.x.x" or "N.N.x"', t => {
+ t.true(release.filter({name: 'some-name'}));
+
+ t.false(release.filter({name: '1.x.x'}));
+ t.false(release.filter({name: '1.0.x'}));
+ t.false(release.filter({name: 'some-name', range: '1.x.x'}));
+ t.false(release.filter({name: 'some-name', range: '1.1.x'}));
+ t.false(release.filter({name: 'some-name', prerelease: true}));
+ t.false(release.filter({name: 'some-name', prerelease: 'beta'}));
+});
+
+test('There must be between 1 and 3 release branches', t => {
+ t.true(release.branchesValidator([{name: 'branch1'}]));
+ t.true(release.branchesValidator([{name: 'branch1'}, {name: 'branch2'}]));
+ t.true(release.branchesValidator([{name: 'branch1'}, {name: 'branch2'}, {name: 'branch3'}]));
+
+ t.false(release.branchesValidator([]));
+ t.false(release.branchesValidator([{name: 'branch1'}, {name: 'branch2'}, {name: 'branch3'}, {name: 'branch4'}]));
+});
diff --git a/test/definitions/plugins.test.js b/test/definitions/plugins.test.js
index ac4f75a9b0..0a6de485df 100644
--- a/test/definitions/plugins.test.js
+++ b/test/definitions/plugins.test.js
@@ -33,6 +33,16 @@ test('The "publish" plugin output, if defined, must be an object or "false"', t
t.true(plugins.publish.outputValidator(false));
});
+test('The "addChannel" plugin output, if defined, must be an object', t => {
+ t.false(plugins.addChannel.outputValidator(1));
+ t.false(plugins.addChannel.outputValidator('string'));
+
+ t.true(plugins.addChannel.outputValidator({}));
+ t.true(plugins.addChannel.outputValidator());
+ t.true(plugins.addChannel.outputValidator(null));
+ t.true(plugins.addChannel.outputValidator(''));
+});
+
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`);
diff --git a/test/get-commits.test.js b/test/get-commits.test.js
index 2fee322fa1..5313f917a6 100644
--- a/test/get-commits.test.js
+++ b/test/get-commits.test.js
@@ -66,6 +66,25 @@ test('Get all commits since gitHead (from lastRelease) on a detached head repo',
t.truthy(result[0].committer.name);
});
+test('Get all commits between lastRelease.gitHead and a shas', 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, between commit 'First' and 'Third'
+ const result = await getCommits({
+ cwd,
+ lastRelease: {gitHead: commits[commits.length - 1].hash},
+ nextRelease: {gitHead: commits[1].hash},
+ logger: t.context.logger,
+ });
+
+ // Verify the commits created and retrieved by the module are identical
+ t.is(result.length, 1);
+ t.deepEqual(result, commits.slice(1, commits.length - 1));
+});
+
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
const {cwd} = await gitRepo();
diff --git a/test/get-config.test.js b/test/get-config.test.js
index 28efa0b60d..80fd72d064 100644
--- a/test/get-config.test.js
+++ b/test/get-config.test.js
@@ -6,7 +6,7 @@ import {omit} from 'lodash';
import proxyquire from 'proxyquire';
import {stub} from 'sinon';
import yaml from 'js-yaml';
-import {gitRepo, gitCommits, gitShallowClone, gitAddConfig} from './helpers/git-utils';
+import {gitRepo, gitTagVersion, gitCommits, gitShallowClone, gitAddConfig} from './helpers/git-utils';
const DEFAULT_PLUGINS = [
'@semantic-release/commit-analyzer',
@@ -23,8 +23,10 @@ test.beforeEach(t => {
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
- const {cwd} = await gitRepo();
+ const {cwd} = await gitRepo(true);
await gitCommits(['First'], {cwd});
+ await gitTagVersion('v1.0.0', undefined, {cwd});
+ await gitTagVersion('v1.1.0', undefined, {cwd});
// Add remote.origin.url config
await gitAddConfig('remote.origin.url', 'git@host.null:owner/repo.git', {cwd});
// Create package.json in repository root
@@ -33,21 +35,35 @@ test('Default values, reading repositoryUrl from package.json', async t => {
const {options: result} = await t.context.getConfig({cwd});
// Verify the default options are set
- t.is(result.branch, 'master');
+ t.deepEqual(result.branches, [
+ '+([0-9])?(.{+([0-9]),x}).x',
+ 'master',
+ 'next',
+ 'next-major',
+ {name: 'beta', prerelease: true},
+ {name: 'alpha', prerelease: true},
+ ]);
t.is(result.repositoryUrl, 'https://host.null/owner/package.git');
t.is(result.tagFormat, `v\${version}`);
});
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
- const {cwd} = await gitRepo();
+ const {cwd} = await gitRepo(true);
// Add remote.origin.url config
await gitAddConfig('remote.origin.url', 'https://host.null/owner/module.git', {cwd});
const {options: result} = await t.context.getConfig({cwd});
// Verify the default options are set
- t.is(result.branch, 'master');
+ t.deepEqual(result.branches, [
+ '+([0-9])?(.{+([0-9]),x}).x',
+ 'master',
+ 'next',
+ 'next-major',
+ {name: 'beta', prerelease: true},
+ {name: 'alpha', prerelease: true},
+ ]);
t.is(result.repositoryUrl, 'https://host.null/owner/module.git');
t.is(result.tagFormat, `v\${version}`);
});
@@ -62,7 +78,14 @@ test('Default values, reading repositoryUrl (http url) from package.json if not
const {options: result} = await t.context.getConfig({cwd});
// Verify the default options are set
- t.is(result.branch, 'master');
+ t.deepEqual(result.branches, [
+ '+([0-9])?(.{+([0-9]),x}).x',
+ 'master',
+ 'next',
+ 'next-major',
+ {name: 'beta', prerelease: true},
+ {name: 'alpha', prerelease: true},
+ ]);
t.is(result.repositoryUrl, 'https://host.null/owner/module.git');
t.is(result.tagFormat, `v\${version}`);
});
@@ -85,7 +108,7 @@ test('Read options from package.json', async t => {
const options = {
analyzeCommits: {path: 'analyzeCommits', param: 'analyzeCommits_param'},
generateNotes: 'generateNotes',
- branch: 'test_branch',
+ branches: ['test_branch'],
repositoryUrl: 'https://host.null/owner/module.git',
tagFormat: `v\${version}`,
plugins: false,
@@ -95,10 +118,11 @@ test('Read options from package.json', async t => {
const {options: result} = await t.context.getConfig({cwd});
+ const expected = {...options, branches: ['test_branch']};
// Verify the options contains the plugin config from package.json
- t.deepEqual(result, options);
+ t.deepEqual(result, expected);
// Verify the plugins module is called with the plugin options from package.json
- t.deepEqual(t.context.plugins.args[0][0], {cwd, options});
+ t.deepEqual(t.context.plugins.args[0][0], {options: expected, cwd});
});
test('Read options from .releaserc.yml', async t => {
@@ -106,7 +130,7 @@ test('Read options from .releaserc.yml', async t => {
const {cwd} = await gitRepo();
const options = {
analyzeCommits: {path: 'analyzeCommits', param: 'analyzeCommits_param'},
- branch: 'test_branch',
+ branches: ['test_branch'],
repositoryUrl: 'https://host.null/owner/module.git',
tagFormat: `v\${version}`,
plugins: false,
@@ -116,10 +140,11 @@ test('Read options from .releaserc.yml', async t => {
const {options: result} = await t.context.getConfig({cwd});
+ const expected = {...options, branches: ['test_branch']};
// Verify the options contains the plugin config from package.json
- t.deepEqual(result, options);
+ t.deepEqual(result, expected);
// Verify the plugins module is called with the plugin options from package.json
- t.deepEqual(t.context.plugins.args[0][0], {cwd, options});
+ t.deepEqual(t.context.plugins.args[0][0], {options: expected, cwd});
});
test('Read options from .releaserc.json', async t => {
@@ -127,7 +152,7 @@ test('Read options from .releaserc.json', async t => {
const {cwd} = await gitRepo();
const options = {
analyzeCommits: {path: 'analyzeCommits', param: 'analyzeCommits_param'},
- branch: 'test_branch',
+ branches: ['test_branch'],
repositoryUrl: 'https://host.null/owner/module.git',
tagFormat: `v\${version}`,
plugins: false,
@@ -137,10 +162,11 @@ test('Read options from .releaserc.json', async t => {
const {options: result} = await t.context.getConfig({cwd});
+ const expected = {...options, branches: ['test_branch']};
// Verify the options contains the plugin config from package.json
- t.deepEqual(result, options);
+ t.deepEqual(result, expected);
// Verify the plugins module is called with the plugin options from package.json
- t.deepEqual(t.context.plugins.args[0][0], {cwd, options});
+ t.deepEqual(t.context.plugins.args[0][0], {options: expected, cwd});
});
test('Read options from .releaserc.js', async t => {
@@ -148,7 +174,7 @@ test('Read options from .releaserc.js', async t => {
const {cwd} = await gitRepo();
const options = {
analyzeCommits: {path: 'analyzeCommits', param: 'analyzeCommits_param'},
- branch: 'test_branch',
+ branches: ['test_branch'],
repositoryUrl: 'https://host.null/owner/module.git',
tagFormat: `v\${version}`,
plugins: false,
@@ -158,10 +184,11 @@ test('Read options from .releaserc.js', async t => {
const {options: result} = await t.context.getConfig({cwd});
+ const expected = {...options, branches: ['test_branch']};
// Verify the options contains the plugin config from package.json
- t.deepEqual(result, options);
+ t.deepEqual(result, expected);
// Verify the plugins module is called with the plugin options from package.json
- t.deepEqual(t.context.plugins.args[0][0], {cwd, options});
+ t.deepEqual(t.context.plugins.args[0][0], {options: expected, cwd});
});
test('Read options from release.config.js', async t => {
@@ -169,7 +196,7 @@ test('Read options from release.config.js', async t => {
const {cwd} = await gitRepo();
const options = {
analyzeCommits: {path: 'analyzeCommits', param: 'analyzeCommits_param'},
- branch: 'test_branch',
+ branches: ['test_branch'],
repositoryUrl: 'https://host.null/owner/module.git',
tagFormat: `v\${version}`,
plugins: false,
@@ -179,10 +206,11 @@ test('Read options from release.config.js', async t => {
const {options: result} = await t.context.getConfig({cwd});
+ const expected = {...options, branches: ['test_branch']};
// Verify the options contains the plugin config from package.json
- t.deepEqual(result, options);
+ t.deepEqual(result, expected);
// Verify the plugins module is called with the plugin options from package.json
- t.deepEqual(t.context.plugins.args[0][0], {cwd, options});
+ t.deepEqual(t.context.plugins.args[0][0], {options: expected, cwd});
});
test('Prioritise CLI/API parameters over file configuration and git repo', async t => {
@@ -193,11 +221,11 @@ test('Prioritise CLI/API parameters over file configuration and git repo', async
cwd = await gitShallowClone(repositoryUrl);
const pkgOptions = {
analyzeCommits: {path: 'analyzeCommits', param: 'analyzeCommits_pkg'},
- branch: 'branch_pkg',
+ branches: ['branch_pkg'],
};
const options = {
analyzeCommits: {path: 'analyzeCommits', param: 'analyzeCommits_cli'},
- branch: 'branch_cli',
+ branches: ['branch_cli'],
repositoryUrl: 'http://cli-url.com/owner/package',
tagFormat: `cli\${version}`,
plugins: false,
@@ -208,10 +236,11 @@ test('Prioritise CLI/API parameters over file configuration and git repo', async
const result = await t.context.getConfig({cwd}, options);
+ const expected = {...options, branches: ['branch_cli']};
// Verify the options contains the plugin config from CLI/API
- t.deepEqual(result.options, options);
+ t.deepEqual(result.options, expected);
// Verify the plugins module is called with the plugin options from CLI/API
- t.deepEqual(t.context.plugins.args[0][0], {cwd, options});
+ t.deepEqual(t.context.plugins.args[0][0], {options: expected, cwd});
});
test('Read configuration from file path in "extends"', async t => {
@@ -221,7 +250,7 @@ test('Read configuration from file path in "extends"', async t => {
const options = {
analyzeCommits: {path: 'analyzeCommits', param: 'analyzeCommits_param'},
generateNotes: 'generateNotes',
- branch: 'test_branch',
+ branches: ['test_branch'],
repositoryUrl: 'https://host.null/owner/module.git',
tagFormat: `v\${version}`,
plugins: ['plugin-1', ['plugin-2', {plugin2Opt: 'value'}]],
@@ -232,10 +261,11 @@ test('Read configuration from file path in "extends"', async t => {
const {options: result} = await t.context.getConfig({cwd});
+ const expected = {...options, branches: ['test_branch']};
// Verify the options contains the plugin config from shareable.json
- t.deepEqual(result, options);
+ t.deepEqual(result, expected);
// 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][0], {options: expected, cwd});
t.deepEqual(t.context.plugins.args[0][1], {
analyzeCommits: './shareable.json',
generateNotes: './shareable.json',
@@ -251,7 +281,7 @@ test('Read configuration from module path in "extends"', async t => {
const options = {
analyzeCommits: {path: 'analyzeCommits', param: 'analyzeCommits_param'},
generateNotes: 'generateNotes',
- branch: 'test_branch',
+ branches: ['test_branch'],
repositoryUrl: 'https://host.null/owner/module.git',
tagFormat: `v\${version}`,
plugins: false,
@@ -260,12 +290,13 @@ test('Read configuration from module path in "extends"', async t => {
await outputJson(path.resolve(cwd, 'package.json'), {release: pkgOptions});
await outputJson(path.resolve(cwd, 'node_modules/shareable/index.json'), options);
- const {options: results} = await t.context.getConfig({cwd});
+ const {options: result} = await t.context.getConfig({cwd});
+ const expected = {...options, branches: ['test_branch']};
// Verify the options contains the plugin config from shareable.json
- t.deepEqual(results, options);
+ t.deepEqual(result, expected);
// 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][0], {options: expected, cwd});
t.deepEqual(t.context.plugins.args[0][1], {
analyzeCommits: 'shareable',
generateNotes: 'shareable',
@@ -279,14 +310,14 @@ test('Read configuration from an array of paths in "extends"', async t => {
const options1 = {
verifyRelease: 'verifyRelease1',
analyzeCommits: {path: 'analyzeCommits1', param: 'analyzeCommits_param1'},
- branch: 'test_branch',
+ branches: ['test_branch'],
repositoryUrl: 'https://host.null/owner/module.git',
};
const options2 = {
verifyRelease: 'verifyRelease2',
generateNotes: 'generateNotes2',
analyzeCommits: {path: 'analyzeCommits2', param: 'analyzeCommits_param2'},
- branch: 'test_branch',
+ branches: ['test_branch'],
tagFormat: `v\${version}`,
plugins: false,
};
@@ -295,12 +326,13 @@ test('Read configuration from an array of paths in "extends"', async t => {
await outputJson(path.resolve(cwd, 'shareable1.json'), options1);
await outputJson(path.resolve(cwd, 'shareable2.json'), options2);
- const {options: results} = await t.context.getConfig({cwd});
+ const {options: result} = await t.context.getConfig({cwd});
+ const expected = {...options1, ...options2, branches: ['test_branch']};
// Verify the options contains the plugin config from shareable1.json and shareable2.json
- t.deepEqual(results, {...options1, ...options2});
+ t.deepEqual(result, expected);
// 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][0], {options: expected, cwd});
t.deepEqual(t.context.plugins.args[0][1], {
verifyRelease1: './shareable1.json',
verifyRelease2: './shareable2.json',
@@ -315,7 +347,7 @@ test('Prioritize configuration from config file over "extends"', async t => {
const {cwd} = await gitRepo();
const pkgOptions = {
extends: './shareable.json',
- branch: 'test_pkg',
+ branches: ['test_pkg'],
generateNotes: 'generateNotes',
publish: [{path: 'publishPkg', param: 'publishPkg_param'}],
};
@@ -323,7 +355,7 @@ test('Prioritize configuration from config file over "extends"', async t => {
analyzeCommits: 'analyzeCommits',
generateNotes: 'generateNotesShareable',
publish: [{path: 'publishShareable', param: 'publishShareable_param'}],
- branch: 'test_branch',
+ branches: ['test_branch'],
repositoryUrl: 'https://host.null/owner/module.git',
tagFormat: `v\${version}`,
plugins: false,
@@ -332,12 +364,13 @@ test('Prioritize configuration from config file over "extends"', async t => {
await outputJson(path.resolve(cwd, 'package.json'), {release: pkgOptions});
await outputJson(path.resolve(cwd, 'shareable.json'), options1);
- const {options} = await t.context.getConfig({cwd});
+ const {options: result} = await t.context.getConfig({cwd});
+ const expected = omit({...options1, ...pkgOptions, branches: ['test_pkg']}, 'extends');
// Verify the options contains the plugin config from package.json and shareable.json
- t.deepEqual(options, omit({...options1, ...pkgOptions}, 'extends'));
+ t.deepEqual(result, expected);
// 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][0], {options: expected, cwd});
t.deepEqual(t.context.plugins.args[0][1], {
analyzeCommits: './shareable.json',
generateNotesShareable: './shareable.json',
@@ -350,13 +383,13 @@ test('Prioritize configuration from cli/API options over "extends"', async t =>
const {cwd} = await gitRepo();
const cliOptions = {
extends: './shareable2.json',
- branch: 'branch_opts',
+ branches: ['branch_opts'],
publish: [{path: 'publishOpts', param: 'publishOpts_param'}],
repositoryUrl: 'https://host.null/owner/module.git',
};
const pkgOptions = {
extends: './shareable1.json',
- branch: 'branch_pkg',
+ branches: ['branch_pkg'],
generateNotes: 'generateNotes',
publish: [{path: 'publishPkg', param: 'publishPkg_param'}],
};
@@ -364,13 +397,13 @@ test('Prioritize configuration from cli/API options over "extends"', async t =>
analyzeCommits: 'analyzeCommits1',
generateNotes: 'generateNotesShareable1',
publish: [{path: 'publishShareable', param: 'publishShareable_param1'}],
- branch: 'test_branch1',
+ branches: ['test_branch1'],
repositoryUrl: 'https://host.null/owner/module.git',
};
const options2 = {
analyzeCommits: 'analyzeCommits2',
publish: [{path: 'publishShareable', param: 'publishShareable_param2'}],
- branch: 'test_branch2',
+ branches: ['test_branch2'],
tagFormat: `v\${version}`,
plugins: false,
};
@@ -379,15 +412,13 @@ test('Prioritize configuration from cli/API options over "extends"', async t =>
await outputJson(path.resolve(cwd, 'shareable1.json'), options1);
await outputJson(path.resolve(cwd, 'shareable2.json'), options2);
- const {options} = await t.context.getConfig({cwd}, cliOptions);
+ const {options: result} = await t.context.getConfig({cwd}, cliOptions);
+ const expected = omit({...options2, ...pkgOptions, ...cliOptions, branches: ['branch_opts']}, 'extends');
// Verify the options contains the plugin config from package.json and shareable2.json
- t.deepEqual(options, omit({...options2, ...pkgOptions, ...cliOptions}, 'extends'));
+ t.deepEqual(result, expected);
// 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'),
- });
+ t.deepEqual(t.context.plugins.args[0][0], {options: expected, cwd});
});
test('Allow to unset properties defined in shareable config with "null"', async t => {
@@ -396,7 +427,7 @@ test('Allow to unset properties defined in shareable config with "null"', async
const pkgOptions = {
extends: './shareable.json',
analyzeCommits: null,
- branch: 'test_branch',
+ branches: ['test_branch'],
repositoryUrl: 'https://host.null/owner/module.git',
plugins: null,
};
@@ -427,6 +458,7 @@ test('Allow to unset properties defined in shareable config with "null"', async
},
cwd,
});
+
t.deepEqual(t.context.plugins.args[0][1], {
generateNotes: './shareable.json',
analyzeCommits: './shareable.json',
@@ -440,7 +472,7 @@ test('Allow to unset properties defined in shareable config with "undefined"', a
const pkgOptions = {
extends: './shareable.json',
analyzeCommits: undefined,
- branch: 'test_branch',
+ branches: ['test_branch'],
repositoryUrl: 'https://host.null/owner/module.git',
};
const options1 = {
@@ -453,18 +485,17 @@ test('Allow to unset properties defined in shareable config with "undefined"', a
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});
+ const {options: result} = await t.context.getConfig({cwd});
+ const expected = {
+ ...omit(options1, 'analyzeCommits'),
+ ...omit(pkgOptions, ['extends', 'analyzeCommits']),
+ branches: ['test_branch'],
+ };
// Verify the options contains the plugin config from shareable.json
- t.deepEqual(options, {...omit(options1, 'analyzeCommits'), ...omit(pkgOptions, ['extends', 'analyzeCommits'])});
+ t.deepEqual(result, expected);
// 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][0], {options: expected, cwd});
t.deepEqual(t.context.plugins.args[0][1], {
generateNotes: './shareable.json',
analyzeCommits: './shareable.json',
diff --git a/test/get-git-auth-url.test.js b/test/get-git-auth-url.test.js
index 4401e34bbd..b12933ead2 100644
--- a/test/get-git-auth-url.test.js
+++ b/test/get-git-auth-url.test.js
@@ -8,7 +8,7 @@ test('Return the same "git" formatted URL if "gitCredentials" is not defined', a
const {cwd} = await gitRepo();
t.is(
- await getAuthUrl({cwd, env, options: {branch: 'master', repositoryUrl: 'git@host.null:owner/repo.git'}}),
+ await getAuthUrl({cwd, env, branch: {name: 'master'}, options: {repositoryUrl: 'git@host.null:owner/repo.git'}}),
'git@host.null:owner/repo.git'
);
});
@@ -17,7 +17,12 @@ test('Return the same "https" formatted URL if "gitCredentials" is not defined',
const {cwd} = await gitRepo();
t.is(
- await getAuthUrl({cwd, env, options: {branch: 'master', repositoryUrl: 'https://host.null/owner/repo.git'}}),
+ await getAuthUrl({
+ cwd,
+ env,
+ branch: {name: 'master'},
+ options: {repositoryUrl: 'https://host.null/owner/repo.git'},
+ }),
'https://host.null/owner/repo.git'
);
});
@@ -26,7 +31,12 @@ test('Return the "https" formatted URL if "gitCredentials" is not defined and re
const {cwd} = await gitRepo();
t.is(
- await getAuthUrl({cwd, env, options: {branch: 'master', repositoryUrl: 'git+https://host.null/owner/repo.git'}}),
+ await getAuthUrl({
+ cwd,
+ env,
+ branch: {name: 'master'},
+ options: {repositoryUrl: 'git+https://host.null/owner/repo.git'},
+ }),
'https://host.null/owner/repo.git'
);
});
@@ -35,7 +45,7 @@ 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'}}),
+ await getAuthUrl({cwd, env, vranch: {name: 'master'}, options: {repositoryUrl: 'git@host.null:owner/repo'}}),
'git@host.null:owner/repo'
);
});
@@ -47,7 +57,8 @@ test('Handle "https" URL with group and subgroup', async t => {
await getAuthUrl({
cwd,
env,
- options: {branch: 'master', repositoryUrl: 'https://host.null/group/subgroup/owner/repo.git'},
+ branch: {name: 'master'},
+ options: {repositoryUrl: 'https://host.null/group/subgroup/owner/repo.git'},
}),
'https://host.null/group/subgroup/owner/repo.git'
);
@@ -60,7 +71,8 @@ test('Handle "git" URL with group and subgroup', async t => {
await getAuthUrl({
cwd,
env,
- options: {branch: 'master', repositoryUrl: 'git@host.null:group/subgroup/owner/repo.git'},
+ branch: {name: 'master'},
+ options: {repositoryUrl: 'git@host.null:group/subgroup/owner/repo.git'},
}),
'git@host.null:group/subgroup/owner/repo.git'
);
@@ -70,7 +82,12 @@ test('Convert shorthand URL', async t => {
const {cwd} = await gitRepo();
t.is(
- await getAuthUrl({cwd, env, options: {repositoryUrl: 'semantic-release/semantic-release'}}),
+ await getAuthUrl({
+ cwd,
+ env,
+ branch: {name: 'master'},
+ options: {repositoryUrl: 'semantic-release/semantic-release'},
+ }),
'https://github.com/semantic-release/semantic-release.git'
);
});
@@ -82,7 +99,8 @@ test('Convert GitLab shorthand URL', async t => {
await getAuthUrl({
cwd,
env,
- options: {branch: 'master', repositoryUrl: 'gitlab:semantic-release/semantic-release'},
+ branch: {name: 'master'},
+ options: {repositoryUrl: 'gitlab:semantic-release/semantic-release'},
}),
'https://gitlab.com/semantic-release/semantic-release.git'
);
@@ -95,7 +113,8 @@ test('Return the "https" formatted URL if "gitCredentials" is defined and reposi
await getAuthUrl({
cwd,
env: {...env, GIT_CREDENTIALS: 'user:pass'},
- options: {branch: 'master', repositoryUrl: 'git@host.null:owner/repo.git'},
+ branch: {name: 'master'},
+ options: {repositoryUrl: 'git@host.null:owner/repo.git'},
}),
'https://user:pass@host.null/owner/repo.git'
);
@@ -121,7 +140,8 @@ test('Return the "https" formatted URL if "gitCredentials" is defined and reposi
await getAuthUrl({
cwd,
env: {...env, GIT_CREDENTIALS: 'user:pass'},
- options: {branch: 'master', repositoryUrl: 'https://host.null/owner/repo.git'},
+ branch: {name: 'master'},
+ options: {repositoryUrl: 'https://host.null/owner/repo.git'},
}),
'https://user:pass@host.null/owner/repo.git'
);
@@ -134,7 +154,8 @@ test('Return the "http" formatted URL if "gitCredentials" is defined and reposit
await getAuthUrl({
cwd,
env: {...env, GIT_CREDENTIALS: 'user:pass'},
- options: {branch: 'master', repositoryUrl: 'http://host.null/owner/repo.git'},
+ branch: {name: 'master'},
+ options: {repositoryUrl: 'http://host.null/owner/repo.git'},
}),
'http://user:pass@host.null/owner/repo.git'
);
@@ -160,7 +181,8 @@ test('Return the "https" formatted URL if "gitCredentials" is defined and reposi
await getAuthUrl({
cwd,
env: {...env, GIT_CREDENTIALS: 'user:pass'},
- options: {branch: 'master', repositoryUrl: 'git+https://host.null/owner/repo.git'},
+ branch: {name: 'master'},
+ options: {repositoryUrl: 'git+https://host.null/owner/repo.git'},
}),
'https://user:pass@host.null/owner/repo.git'
);
@@ -173,7 +195,8 @@ test('Return the "http" formatted URL if "gitCredentials" is defined and reposit
await getAuthUrl({
cwd,
env: {...env, GIT_CREDENTIALS: 'user:pass'},
- options: {branch: 'master', repositoryUrl: 'git+http://host.null/owner/repo.git'},
+ branch: {name: 'master'},
+ options: {repositoryUrl: 'git+http://host.null/owner/repo.git'},
}),
'http://user:pass@host.null/owner/repo.git'
);
@@ -199,7 +222,8 @@ test('Return the "https" formatted URL if "gitCredentials" is defined with "GH_T
await getAuthUrl({
cwd,
env: {...env, GH_TOKEN: 'token'},
- options: {branch: 'master', repositoryUrl: 'git@host.null:owner/repo.git'},
+ branch: {name: 'master'},
+ options: {repositoryUrl: 'git@host.null:owner/repo.git'},
}),
'https://token@host.null/owner/repo.git'
);
@@ -212,7 +236,8 @@ test('Return the "https" formatted URL if "gitCredentials" is defined with "GITH
await getAuthUrl({
cwd,
env: {...env, GITHUB_TOKEN: 'token'},
- options: {branch: 'master', repositoryUrl: 'git@host.null:owner/repo.git'},
+ branch: {name: 'master'},
+ options: {repositoryUrl: 'git@host.null:owner/repo.git'},
}),
'https://token@host.null/owner/repo.git'
);
@@ -225,7 +250,8 @@ test('Return the "https" formatted URL if "gitCredentials" is defined with "GL_T
await getAuthUrl({
cwd,
env: {...env, GL_TOKEN: 'token'},
- options: {branch: 'master', repositoryUrl: 'git@host.null:owner/repo.git'},
+ branch: {name: 'master'},
+ options: {repositoryUrl: 'git@host.null:owner/repo.git'},
}),
'https://gitlab-ci-token:token@host.null/owner/repo.git'
);
@@ -238,7 +264,8 @@ test('Return the "https" formatted URL if "gitCredentials" is defined with "GITL
await getAuthUrl({
cwd,
env: {...env, GITLAB_TOKEN: 'token'},
- options: {branch: 'master', repositoryUrl: 'git@host.null:owner/repo.git'},
+ branch: {name: 'master'},
+ options: {repositoryUrl: 'git@host.null:owner/repo.git'},
}),
'https://gitlab-ci-token:token@host.null/owner/repo.git'
);
@@ -251,7 +278,8 @@ test('Return the "https" formatted URL if "gitCredentials" is defined with "BB_T
await getAuthUrl({
cwd,
env: {...env, BB_TOKEN: 'token'},
- options: {branch: 'master', repositoryUrl: 'git@host.null:owner/repo.git'},
+ branch: {name: 'master'},
+ options: {repositoryUrl: 'git@host.null:owner/repo.git'},
}),
'https://x-token-auth:token@host.null/owner/repo.git'
);
@@ -264,7 +292,8 @@ test('Return the "https" formatted URL if "gitCredentials" is defined with "BITB
await getAuthUrl({
cwd,
env: {...env, BITBUCKET_TOKEN: 'token'},
- options: {branch: 'master', repositoryUrl: 'git@host.null:owner/repo.git'},
+ branch: {name: 'master'},
+ options: {repositoryUrl: 'git@host.null:owner/repo.git'},
}),
'https://x-token-auth:token@host.null/owner/repo.git'
);
@@ -290,7 +319,8 @@ test('Handle "https" URL with group and subgroup, with "GIT_CREDENTIALS"', async
await getAuthUrl({
cwd,
env: {...env, GIT_CREDENTIALS: 'user:pass'},
- options: {branch: 'master', repositoryUrl: 'https://host.null/group/subgroup/owner/repo.git'},
+ branch: {name: 'master'},
+ options: {repositoryUrl: 'https://host.null/group/subgroup/owner/repo.git'},
}),
'https://user:pass@host.null/group/subgroup/owner/repo.git'
);
@@ -303,7 +333,8 @@ test('Handle "git" URL with group and subgroup, with "GIT_CREDENTIALS', async t
await getAuthUrl({
cwd,
env: {...env, GIT_CREDENTIALS: 'user:pass'},
- options: {branch: 'master', repositoryUrl: 'git@host.null:group/subgroup/owner/repo.git'},
+ branch: {name: 'master'},
+ options: {repositoryUrl: 'git@host.null:group/subgroup/owner/repo.git'},
}),
'https://user:pass@host.null/group/subgroup/owner/repo.git'
);
@@ -313,7 +344,12 @@ 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}}),
+ await getAuthUrl({
+ cwd,
+ env: {...env, GIT_CREDENTIALS: 'user:pass'},
+ branch: {name: 'master'},
+ options: {repositoryUrl},
+ }),
repositoryUrl
);
});
diff --git a/test/get-last-release.test.js b/test/get-last-release.test.js
index bf842ccdea..bb3a2ee26e 100644
--- a/test/get-last-release.test.js
+++ b/test/get-last-release.test.js
@@ -1,151 +1,80 @@
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});
+test('Get the highest non-prerelease valid tag', t => {
+ const result = getLastRelease({
+ branch: {
+ name: 'master',
+ tags: [
+ {version: '2.0.0', gitTag: 'v2.0.0', gitHead: 'v2.0.0'},
+ {version: '1.0.0', gitTag: 'v1.0.0', gitHead: 'v1.0.0'},
+ {version: '3.0.0-beta.1', gitTag: 'v3.0.0-beta.1', gitHead: 'v3.0.0-beta.1'},
+ ],
+ type: 'release',
+ },
+ options: {tagFormat: `v\${version}`},
+ });
- t.deepEqual(result, {});
- t.is(t.context.log.args[0][0], 'No git tag version found');
+ t.deepEqual(result, {version: '2.0.0', gitTag: 'v2.0.0', name: 'v2.0.0', gitHead: 'v2.0.0', channels: undefined});
});
-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',
+test('Get the highest prerelease valid tag, ignoring other tags from other prerelease channels', t => {
+ const result = getLastRelease({
+ branch: {
+ name: 'beta',
+ prerelease: 'beta',
+ channel: 'beta',
+ tags: [
+ {version: '1.0.0-beta.1', gitTag: 'v1.0.0-beta.1', gitHead: 'v1.0.0-beta.1', channels: ['beta']},
+ {version: '1.0.0-beta.2', gitTag: 'v1.0.0-beta.2', gitHead: 'v1.0.0-beta.2', channels: ['beta']},
+ {version: '1.0.0-alpha.1', gitTag: 'v1.0.0-alpha.1', gitHead: 'v1.0.0-alpha.1', channels: ['alpha']},
+ ],
+ type: 'prerelease',
+ },
+ options: {tagFormat: `v\${version}`},
});
- 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',
+ t.deepEqual(result, {
+ version: '1.0.0-beta.2',
+ gitTag: 'v1.0.0-beta.2',
+ name: 'v1.0.0-beta.2',
+ gitHead: 'v1.0.0-beta.2',
+ channels: ['beta'],
});
+});
- 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',
+test('Return empty object if no valid tag is found', t => {
+ const result = getLastRelease({
+ branch: {
+ name: 'master',
+ tags: [{version: '3.0.0-beta.1', gitTag: 'v3.0.0-beta.1', gitHead: 'v3.0.0-beta.1'}],
+ type: 'release',
+ },
+ options: {tagFormat: `v\${version}`},
});
- 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',
- });
+ t.deepEqual(result, {});
+});
- 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 the highest non-prerelease valid tag before a certain version', t => {
+ const result = getLastRelease(
+ {
+ branch: {
+ name: 'master',
+ channel: undefined,
+ tags: [
+ {version: '2.0.0', gitTag: 'v2.0.0', gitHead: 'v2.0.0'},
+ {version: '1.0.0', gitTag: 'v1.0.0', gitHead: 'v1.0.0'},
+ {version: '2.0.0-beta.1', gitTag: 'v2.0.0-beta.1', gitHead: 'v2.0.0-beta.1'},
+ {version: '2.1.0', gitTag: 'v2.1.0', gitHead: 'v2.1.0'},
+ {version: '2.1.1', gitTag: 'v2.1.1', gitHead: 'v2.1.1'},
+ ],
+ type: 'release',
+ },
+ options: {tagFormat: `v\${version}`},
+ },
+ {before: '2.1.0'}
+ );
+
+ t.deepEqual(result, {version: '2.0.0', gitTag: 'v2.0.0', name: 'v2.0.0', gitHead: 'v2.0.0', channels: undefined});
});
diff --git a/test/get-next-version.test.js b/test/get-next-version.test.js
index ecbaee889b..2bd808d1ee 100644
--- a/test/get-next-version.test.js
+++ b/test/get-next-version.test.js
@@ -9,33 +9,269 @@ test.beforeEach(t => {
});
test('Increase version for patch release', t => {
- const version = getNextVersion({
- nextRelease: {type: 'patch'},
- lastRelease: {version: '1.0.0'},
- logger: t.context.logger,
- });
- t.is(version, '1.0.1');
+ t.is(
+ getNextVersion({
+ branch: {name: 'master', type: 'release', tags: [{gitTag: 'v1.0.0', version: '1.0.0', channels: [null]}]},
+ nextRelease: {type: 'patch'},
+ lastRelease: {version: '1.0.0', channels: [null]},
+ logger: t.context.logger,
+ }),
+ '1.0.1'
+ );
});
test('Increase version for minor release', t => {
- const version = getNextVersion({
- nextRelease: {type: 'minor'},
- lastRelease: {version: '1.0.0'},
- logger: t.context.logger,
- });
- t.is(version, '1.1.0');
+ t.is(
+ getNextVersion({
+ branch: {name: 'master', type: 'release', tags: [{gitTag: 'v1.0.0', version: '1.0.0', channels: [null]}]},
+ nextRelease: {type: 'minor'},
+ lastRelease: {version: '1.0.0', channels: [null]},
+ logger: t.context.logger,
+ }),
+ '1.1.0'
+ );
});
test('Increase version for major release', t => {
- const version = getNextVersion({
- nextRelease: {type: 'major'},
- lastRelease: {version: '1.0.0'},
- logger: t.context.logger,
- });
- t.is(version, '2.0.0');
+ t.is(
+ getNextVersion({
+ branch: {name: 'master', type: 'release', tags: [{gitTag: 'v1.0.0', version: '1.0.0', channels: [null]}]},
+ nextRelease: {type: 'major'},
+ lastRelease: {version: '1.0.0', channels: [null]},
+ logger: t.context.logger,
+ }),
+ '2.0.0'
+ );
});
test('Return 1.0.0 if there is no previous release', t => {
- const version = getNextVersion({nextRelease: {type: 'minor'}, lastRelease: {}, logger: t.context.logger});
- t.is(version, '1.0.0');
+ t.is(
+ getNextVersion({
+ branch: {name: 'master', type: 'release', tags: []},
+ nextRelease: {type: 'minor'},
+ lastRelease: {},
+ logger: t.context.logger,
+ }),
+ '1.0.0'
+ );
+});
+
+test('Increase version for patch release on prerelease branch', t => {
+ t.is(
+ getNextVersion({
+ branch: {
+ name: 'beta',
+ type: 'prerelease',
+ prerelease: 'beta',
+ tags: [{gitTag: 'v1.0.0', version: '1.0.0', channels: [null]}],
+ },
+ nextRelease: {type: 'patch', channel: 'beta'},
+ lastRelease: {version: '1.0.0', channels: [null]},
+ logger: t.context.logger,
+ }),
+ '1.0.1-beta.1'
+ );
+
+ t.is(
+ getNextVersion({
+ branch: {
+ name: 'beta',
+ type: 'prerelease',
+ prerelease: 'beta',
+ tags: [
+ {gitTag: 'v1.0.0', version: '1.0.0', channels: [null]},
+ {gitTag: 'v1.0.1-beta.1', version: '1.0.1-beta.1', channels: ['beta']},
+ ],
+ },
+ nextRelease: {type: 'patch', channel: 'beta'},
+ lastRelease: {version: '1.0.1-beta.1', channels: ['beta']},
+ logger: t.context.logger,
+ }),
+ '1.0.1-beta.2'
+ );
+
+ t.is(
+ getNextVersion({
+ branch: {
+ name: 'alpha',
+ type: 'prerelease',
+ prerelease: 'alpha',
+ tags: [{gitTag: 'v1.0.1-beta.1', version: '1.0.1-beta.1', channels: ['beta']}],
+ },
+ nextRelease: {type: 'patch', channel: 'alpha'},
+ lastRelease: {version: '1.0.1-beta.1', channels: ['beta']},
+ logger: t.context.logger,
+ }),
+ '1.0.2-alpha.1'
+ );
+});
+
+test('Increase version for minor release on prerelease branch', t => {
+ t.is(
+ getNextVersion({
+ branch: {
+ name: 'beta',
+ type: 'prerelease',
+ prerelease: 'beta',
+ tags: [{gitTag: 'v1.0.0', version: '1.0.0', channels: [null]}],
+ },
+ nextRelease: {type: 'minor', channel: 'beta'},
+ lastRelease: {version: '1.0.0', channels: [null]},
+ logger: t.context.logger,
+ }),
+ '1.1.0-beta.1'
+ );
+
+ t.is(
+ getNextVersion({
+ branch: {
+ name: 'beta',
+ type: 'prerelease',
+ prerelease: 'beta',
+ tags: [
+ {gitTag: 'v1.0.0', version: '1.0.0', channels: [null]},
+ {gitTag: 'v1.1.0-beta.1', version: '1.1.0-beta.1', channels: ['beta']},
+ ],
+ },
+ nextRelease: {type: 'minor', channel: 'beta'},
+ lastRelease: {version: '1.1.0-beta.1', channels: ['beta']},
+ logger: t.context.logger,
+ }),
+ '1.1.0-beta.2'
+ );
+
+ t.is(
+ getNextVersion({
+ branch: {
+ name: 'alpha',
+ type: 'prerelease',
+ prerelease: 'alpha',
+ tags: [{gitTag: 'v1.1.0-beta.1', version: '1.1.0-beta.1', channels: ['beta']}],
+ },
+ nextRelease: {type: 'minor', channel: 'alpha'},
+ lastRelease: {version: '1.1.0-beta.1', channels: ['beta']},
+ logger: t.context.logger,
+ }),
+ '1.2.0-alpha.1'
+ );
+});
+
+test('Increase version for major release on prerelease branch', t => {
+ t.is(
+ getNextVersion({
+ branch: {
+ name: 'beta',
+ type: 'prerelease',
+ prerelease: 'beta',
+ tags: [{gitTag: 'v1.0.0', version: '1.0.0', channels: [null]}],
+ },
+ nextRelease: {type: 'major', channel: 'beta'},
+ lastRelease: {version: '1.0.0', channels: [null]},
+ logger: t.context.logger,
+ }),
+ '2.0.0-beta.1'
+ );
+
+ t.is(
+ getNextVersion({
+ branch: {
+ name: 'beta',
+ type: 'prerelease',
+ prerelease: 'beta',
+ tags: [
+ {gitTag: 'v1.0.0', version: '1.0.0', channels: [null]},
+ {gitTag: 'v2.0.0-beta.1', version: '2.0.0-beta.1', channels: ['beta']},
+ ],
+ },
+ nextRelease: {type: 'major', channel: 'beta'},
+ lastRelease: {version: '2.0.0-beta.1', channels: ['beta']},
+ logger: t.context.logger,
+ }),
+ '2.0.0-beta.2'
+ );
+
+ t.is(
+ getNextVersion({
+ branch: {
+ name: 'alpha',
+ type: 'prerelease',
+ prerelease: 'alpha',
+ tags: [{gitTag: 'v2.0.0-beta.1', version: '2.0.0-beta.1', channels: ['beta']}],
+ },
+ nextRelease: {type: 'major', channel: 'alpha'},
+ lastRelease: {version: '2.0.0-beta.1', channels: ['beta']},
+ logger: t.context.logger,
+ }),
+ '3.0.0-alpha.1'
+ );
+});
+
+test('Return 1.0.0 if there is no previous release on prerelease branch', t => {
+ t.is(
+ getNextVersion({
+ branch: {name: 'beta', type: 'prerelease', prerelease: 'beta', tags: []},
+ nextRelease: {type: 'minor'},
+ lastRelease: {},
+ logger: t.context.logger,
+ }),
+ '1.0.0-beta.1'
+ );
+});
+
+test('Increase version for release on prerelease branch after previous commits were merged to release branch', t => {
+ t.is(
+ getNextVersion({
+ branch: {
+ name: 'beta',
+ type: 'prerelease',
+ prerelease: 'beta',
+ tags: [
+ {gitTag: 'v1.0.0', version: '1.0.0', channels: [null]},
+ {gitTag: 'v1.1.0', version: '1.1.0', channels: [null]}, // Version v1.1.0 released on default branch after beta was merged into master
+ {gitTag: 'v1.1.0-beta.1', version: '1.1.0-beta.1', channels: [null, 'beta']},
+ ],
+ },
+ nextRelease: {type: 'minor'},
+ lastRelease: {version: '1.1.0', channels: [null]},
+ logger: t.context.logger,
+ }),
+ '1.2.0-beta.1'
+ );
+});
+
+test('Increase version for release on prerelease branch based on highest commit type since last regular release', t => {
+ t.is(
+ getNextVersion({
+ branch: {
+ name: 'beta',
+ type: 'prerelease',
+ prerelease: 'beta',
+ tags: [
+ {gitTag: 'v1.0.0', version: '1.0.0', channels: [null]},
+ {gitTag: 'v1.1.0-beta.1', version: '1.1.0-beta.1', channels: [null, 'beta']},
+ ],
+ },
+ nextRelease: {type: 'major'},
+ lastRelease: {version: 'v1.1.0-beta.1', channels: [null]},
+ logger: t.context.logger,
+ }),
+ '2.0.0-beta.1'
+ );
+});
+
+test('Increase version for release on prerelease branch when there is no regular releases on other branches', t => {
+ t.is(
+ getNextVersion({
+ branch: {
+ name: 'beta',
+ type: 'prerelease',
+ prerelease: 'beta',
+ tags: [{gitTag: 'v1.0.0-beta.1', version: '1.0.0-beta.1', channels: ['beta']}],
+ },
+ nextRelease: {type: 'minor', channel: 'beta'},
+ lastRelease: {version: 'v1.0.0-beta.1', channels: ['beta']},
+ logger: t.context.logger,
+ }),
+ '1.0.0-beta.2'
+ );
});
diff --git a/test/get-release-to-add.test.js b/test/get-release-to-add.test.js
new file mode 100644
index 0000000000..823e281792
--- /dev/null
+++ b/test/get-release-to-add.test.js
@@ -0,0 +1,282 @@
+import test from 'ava';
+import getReleaseToAdd from '../lib/get-release-to-add';
+
+test('Return versions merged from release to maintenance branch, excluding lower than branch start range', t => {
+ const result = getReleaseToAdd({
+ branch: {
+ name: '2.x',
+ channel: '2.x',
+ type: 'maintenance',
+ mergeRange: '>=2.0.0 <3.0.0',
+ tags: [
+ {gitTag: 'v2.0.0', version: '2.0.0', channels: ['2.x']},
+ {gitTag: 'v2.0.0', version: '2.0.0', channels: [null]},
+ {gitTag: 'v2.1.0', version: '2.1.0', channels: [null]},
+ {gitTag: 'v2.1.1', version: '2.1.1', channels: [null]},
+ {gitTag: 'v1.0.0', version: '1.0.0', channels: [null]},
+ {gitTag: 'v1.1.0', version: '1.1.0', channels: [null]},
+ ],
+ },
+ branches: [{name: '2.x', channel: '2.x'}, {name: 'master'}],
+ options: {tagFormat: `v\${version}`},
+ });
+
+ t.deepEqual(result, {
+ lastRelease: {version: '2.1.0', channels: [null], gitTag: 'v2.1.0', name: 'v2.1.0', gitHead: 'v2.1.0'},
+ currentRelease: {
+ type: 'patch',
+ version: '2.1.1',
+ channels: [null],
+ gitTag: 'v2.1.1',
+ name: 'v2.1.1',
+ gitHead: 'v2.1.1',
+ },
+ nextRelease: {
+ type: 'patch',
+ version: '2.1.1',
+ channel: '2.x',
+ gitTag: 'v2.1.1',
+ name: 'v2.1.1',
+ gitHead: 'v2.1.1',
+ },
+ });
+});
+
+test('Return versions merged between release branches', t => {
+ const result = getReleaseToAdd({
+ branch: {
+ name: 'master',
+ tags: [
+ {gitTag: 'v1.0.0', version: '1.0.0', channels: [null, 'next']},
+ {gitTag: 'v1.1.0', version: '1.1.0', channels: ['next']},
+ {gitTag: 'v2.0.0', version: '2.0.0', channels: ['next-major']},
+ ],
+ },
+ branches: [{name: 'master'}, {name: 'next', channel: 'next'}, {name: 'next-major', channel: 'next-major'}],
+ options: {tagFormat: `v\${version}`},
+ });
+
+ t.deepEqual(result, {
+ lastRelease: {
+ version: '1.1.0',
+ gitTag: 'v1.1.0',
+ name: 'v1.1.0',
+ gitHead: 'v1.1.0',
+ channels: ['next'],
+ },
+ currentRelease: {
+ type: 'major',
+ version: '2.0.0',
+ channels: ['next-major'],
+ gitTag: 'v2.0.0',
+ name: 'v2.0.0',
+ gitHead: 'v2.0.0',
+ },
+ nextRelease: {
+ type: 'major',
+ version: '2.0.0',
+ channel: null,
+ gitTag: 'v2.0.0',
+ name: 'v2.0.0',
+ gitHead: 'v2.0.0',
+ },
+ });
+});
+
+test('Return releases sorted by ascending order', t => {
+ const result = getReleaseToAdd({
+ branch: {
+ name: 'master',
+ tags: [
+ {gitTag: 'v2.0.0', version: '2.0.0', channels: ['next-major']},
+ {gitTag: 'v1.1.0', version: '1.1.0', channels: ['next']},
+ {gitTag: 'v1.0.0', version: '1.0.0', channels: [null, 'next']},
+ ],
+ },
+ branches: [{name: 'master'}, {name: 'next', channel: 'next'}, {name: 'next-major', channel: 'next-major'}],
+ options: {tagFormat: `v\${version}`},
+ });
+
+ t.deepEqual(result, {
+ lastRelease: {version: '1.1.0', gitTag: 'v1.1.0', name: 'v1.1.0', gitHead: 'v1.1.0', channels: ['next']},
+ currentRelease: {
+ type: 'major',
+ version: '2.0.0',
+ channels: ['next-major'],
+ gitTag: 'v2.0.0',
+ name: 'v2.0.0',
+ gitHead: 'v2.0.0',
+ },
+ nextRelease: {
+ type: 'major',
+ version: '2.0.0',
+ channel: null,
+ gitTag: 'v2.0.0',
+ name: 'v2.0.0',
+ gitHead: 'v2.0.0',
+ },
+ });
+});
+
+test('No lastRelease', t => {
+ const result = getReleaseToAdd({
+ branch: {
+ name: 'master',
+ tags: [{gitTag: 'v1.0.0', version: '1.0.0', channels: ['next']}],
+ },
+ branches: [{name: 'master'}, {name: 'next', channel: 'next'}],
+ options: {tagFormat: `v\${version}`},
+ });
+
+ t.deepEqual(result, {
+ lastRelease: {},
+ currentRelease: {
+ type: 'major',
+ version: '1.0.0',
+ channels: ['next'],
+ gitTag: 'v1.0.0',
+ name: 'v1.0.0',
+ gitHead: 'v1.0.0',
+ },
+ nextRelease: {
+ type: 'major',
+ version: '1.0.0',
+ channel: null,
+ gitTag: 'v1.0.0',
+ name: 'v1.0.0',
+ gitHead: 'v1.0.0',
+ },
+ });
+});
+
+test('Ignore pre-release versions', t => {
+ const result = getReleaseToAdd({
+ branch: {
+ name: 'master',
+ tags: [
+ {gitTag: 'v1.0.0', version: '1.0.0', channels: [null, 'next']},
+ {gitTag: 'v1.1.0', version: '1.1.0', channels: ['next']},
+ {gitTag: 'v2.0.0-alpha.1', version: '2.0.0-alpha.1', channels: ['alpha']},
+ ],
+ },
+ branches: [
+ {name: 'master'},
+ {name: 'next', channel: 'next'},
+ {name: 'alpha', type: 'prerelease', channel: 'alpha'},
+ ],
+ options: {tagFormat: `v\${version}`},
+ });
+
+ t.deepEqual(result, {
+ lastRelease: {version: '1.0.0', channels: [null, 'next'], gitTag: 'v1.0.0', name: 'v1.0.0', gitHead: 'v1.0.0'},
+ currentRelease: {
+ type: 'minor',
+ version: '1.1.0',
+ channels: ['next'],
+ gitTag: 'v1.1.0',
+ name: 'v1.1.0',
+ gitHead: 'v1.1.0',
+ },
+ nextRelease: {
+ type: 'minor',
+ version: '1.1.0',
+ channel: null,
+ gitTag: 'v1.1.0',
+ name: 'v1.1.0',
+ gitHead: 'v1.1.0',
+ },
+ });
+});
+
+test('Exclude versions merged from release to maintenance branch if they have the same "channel"', t => {
+ const result = getReleaseToAdd({
+ branch: {
+ name: '2.x',
+ channel: 'latest',
+ type: 'maintenance',
+ mergeRange: '>=2.0.0 <3.0.0',
+ tags: [
+ {gitTag: 'v2.0.0', version: '2.0.0', channels: [null]},
+ {gitTag: 'v2.0.0', version: '2.0.0', channels: [null]},
+ {gitTag: 'v2.1.0', version: '2.1.0', channels: [null]},
+ {gitTag: 'v2.1.1', version: '2.1.1', channels: [null]},
+ {gitTag: 'v1.0.0', version: '1.0.0', channels: [null]},
+ {gitTag: 'v1.1.0', version: '1.1.0', channels: [null]},
+ ],
+ },
+ branches: [
+ {name: '2.x', channel: 'latest'},
+ {name: 'master', channel: 'latest'},
+ ],
+ options: {tagFormat: `v\${version}`},
+ });
+
+ t.is(result, undefined);
+});
+
+test('Exclude versions merged between release branches if they have the same "channel"', t => {
+ const result = getReleaseToAdd({
+ branch: {
+ name: 'master',
+ channel: 'latest',
+ tags: [
+ {gitTag: 'v1.0.0', channels: ['latest'], version: '1.0.0'},
+ {gitTag: 'v1.1.0', channels: ['latest'], version: '1.1.0'},
+ {gitTag: 'v2.0.0', channels: ['latest'], version: '2.0.0'},
+ ],
+ },
+ branches: [
+ {name: 'master', channel: 'latest'},
+ {name: 'next', channel: 'latest'},
+ {name: 'next-major', channel: 'latest'},
+ ],
+ options: {tagFormat: `v\${version}`},
+ });
+
+ t.is(result, undefined);
+});
+
+test('Exclude versions merged between release branches if they all have "channel" set to "false"', t => {
+ const result = getReleaseToAdd({
+ branch: {
+ name: 'master',
+ channel: false,
+ tags: [
+ {gitTag: 'v1.0.0', version: '1.0.0', channels: [null]},
+ {gitTag: 'v1.1.0', version: '1.1.0', channels: [null]},
+ {gitTag: 'v2.0.0', version: '2.0.0', channels: [null]},
+ ],
+ },
+ branches: [
+ {name: 'master', channel: false},
+ {name: 'next', channel: false},
+ {name: 'next-major', channel: false},
+ ],
+ options: {tagFormat: `v\${version}`},
+ });
+
+ t.is(result, undefined);
+});
+
+test('Exclude versions number less than the latest version already released on that branch', t => {
+ const result = getReleaseToAdd({
+ branch: {
+ name: '2.x',
+ channel: '2.x',
+ type: 'maintenance',
+ mergeRange: '>=2.0.0 <3.0.0',
+ tags: [
+ {gitTag: 'v2.0.0', version: '2.0.0', channels: ['2.x']},
+ {gitTag: 'v2.0.0', version: '2.0.0', channels: [null]},
+ {gitTag: 'v2.1.0', version: '2.1.0', channels: [null]},
+ {gitTag: 'v2.1.1', version: '2.1.1', channels: [null, '2.x']},
+ {gitTag: 'v1.0.0', version: '1.0.0', channels: [null]},
+ {gitTag: 'v1.1.0', version: '1.1.0', channels: [null]},
+ ],
+ },
+ branches: [{name: '2.x', channel: '2.x'}, {name: 'master'}],
+ options: {tagFormat: `v\${version}`},
+ });
+
+ t.is(result, undefined);
+});
diff --git a/test/git.test.js b/test/git.test.js
index 1d79dfb46d..781994f65b 100644
--- a/test/git.test.js
+++ b/test/git.test.js
@@ -2,16 +2,20 @@ import test from 'ava';
import tempy from 'tempy';
import {
getTagHead,
- isRefInHistory,
+ isRefExists,
fetch,
getGitHead,
repoUrl,
tag,
push,
getTags,
+ getBranches,
isGitRepo,
verifyTagName,
isBranchUpToDate,
+ getNote,
+ addNote,
+ fetchNotes,
} from '../lib/git';
import {
gitRepo,
@@ -25,6 +29,9 @@ import {
gitRemoteTagHead,
gitPush,
gitDetachedHead,
+ gitDetachedHeadFromBranch,
+ gitAddNote,
+ gitGetNote,
} from './helpers/git-utils';
test('Get the last commit sha', async t => {
@@ -56,7 +63,7 @@ test('Unshallow and fetch repository', async t => {
// Verify the shallow clone contains only one commit
t.is((await gitGetCommits(undefined, {cwd})).length, 1);
- await fetch(repositoryUrl, {cwd});
+ await fetch(repositoryUrl, 'master', 'master', {cwd});
// Verify the shallow clone contains all the commits
t.is((await gitGetCommits(undefined, {cwd})).length, 2);
@@ -64,10 +71,15 @@ test('Unshallow and fetch repository', async t => {
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
+ const {cwd, repositoryUrl} = await gitRepo(true);
await gitCommits(['First'], {cwd});
- await t.notThrowsAsync(fetch(repositoryUrl, {cwd}));
+ await gitPush(repositoryUrl, 'master', {cwd});
+ await gitCheckout('second-branch', true, {cwd});
+ await gitCommits(['Second'], {cwd});
+ await gitPush(repositoryUrl, 'second-branch', {cwd});
+
+ await t.notThrowsAsync(fetch(repositoryUrl, 'master', 'master', {cwd}));
+ await t.notThrowsAsync(fetch(repositoryUrl, 'second-branch', 'master', {cwd}));
});
test('Fetch all tags on a detached head repository', async t => {
@@ -82,28 +94,66 @@ test('Fetch all tags on a detached head repository', async t => {
await gitPush(repositoryUrl, 'master', {cwd});
cwd = await gitDetachedHead(repositoryUrl, commit.hash);
- await fetch(repositoryUrl, {cwd});
+ await fetch(repositoryUrl, 'master', 'master', {cwd});
- t.deepEqual((await getTags({cwd})).sort(), ['v1.0.0', 'v1.0.1', 'v1.1.0'].sort());
+ t.deepEqual((await getTags('master', {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 => {
+test('Fetch all tags on a repository with a detached head from branch', 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});
+ await gitCheckout('other-branch', true, {cwd});
+ await gitPush(repositoryUrl, 'other-branch', {cwd});
+ await gitCheckout('master', false, {cwd});
+ await gitCommits(['Fourth'], {cwd});
+ await gitTagVersion('v2.0.0', undefined, {cwd});
+ await gitPush(repositoryUrl, 'master', {cwd});
+ cwd = await gitDetachedHeadFromBranch(repositoryUrl, 'other-branch', commit.hash);
+
+ await fetch(repositoryUrl, 'master', 'other-branch', {cwd});
+ await fetch(repositoryUrl, 'other-branch', 'other-branch', {cwd});
+
+ t.deepEqual((await getTags('other-branch', {cwd})).sort(), ['v1.0.0', 'v1.0.1', 'v1.1.0'].sort());
+ t.deepEqual((await getTags('master', {cwd})).sort(), ['v1.0.0', 'v1.0.1', 'v1.1.0', 'v2.0.0'].sort());
+});
+
+test('Verify if a branch 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});
+ 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});
+ await gitCommits(['Second'], {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}));
+ t.true(await isRefExists('master', {cwd}));
+ t.true(await isRefExists('other-branch', {cwd}));
+ t.falsy(await isRefExists('next', {cwd}));
});
-test('Get the commit sha for a given tag or falsy if the tag does not exists', async t => {
+test('Get all branches', async t => {
+ const {cwd, repositoryUrl} = await gitRepo(true);
+ await gitCommits(['First'], {cwd});
+ await gitPush(repositoryUrl, 'master', {cwd});
+ await gitCheckout('second-branch', true, {cwd});
+ await gitCommits(['Second'], {cwd});
+ await gitPush(repositoryUrl, 'second-branch', {cwd});
+ await gitCheckout('third-branch', true, {cwd});
+ await gitCommits(['Third'], {cwd});
+ await gitPush(repositoryUrl, 'third-branch', {cwd});
+
+ t.deepEqual((await getBranches(repositoryUrl, {cwd})).sort(), ['master', 'second-branch', 'third-branch'].sort());
+});
+
+test('Get the commit sha for a given tag', 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
@@ -112,7 +162,6 @@ test('Get the commit sha for a given tag or falsy if the tag does not exists', a
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 => {
@@ -146,7 +195,7 @@ test('Add tag on head commit', async t => {
const {cwd} = await gitRepo();
const commits = await gitCommits(['Test commit'], {cwd});
- await tag('tag_name', {cwd});
+ await tag('tag_name', 'HEAD', {cwd});
await t.is(await gitCommitTag(commits[0].hash, {cwd}), 'tag_name');
});
@@ -156,13 +205,13 @@ test('Push tag to remote repository', async t => {
const {cwd, repositoryUrl} = await gitRepo(true);
const commits = await gitCommits(['Test commit'], {cwd});
- await tag('tag_name', {cwd});
+ await tag('tag_name', 'HEAD', {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 => {
+test('Push tag to remote repository with remote branch ahead', async t => {
const {cwd, repositoryUrl} = await gitRepo(true);
const commits = await gitCommits(['First'], {cwd});
await gitPush(repositoryUrl, 'master', {cwd});
@@ -170,7 +219,7 @@ test('Push tag to remote repository with remote branch ahaed', async t => {
await gitCommits(['Second'], {cwd: tmpRepo});
await gitPush('origin', 'master', {cwd: tmpRepo});
- await tag('tag_name', {cwd});
+ await tag('tag_name', 'HEAD', {cwd});
await push(repositoryUrl, {cwd});
t.is(await gitRemoteTagHead(repositoryUrl, 'tag_name', {cwd}), commits[0].hash);
@@ -206,7 +255,7 @@ test('Return falsy for invalid tag names', async t => {
test('Throws error if obtaining the tags fails', async t => {
const cwd = tempy.directory();
- await t.throwsAsync(getTags({cwd}));
+ await t.throwsAsync(getTags('master', {cwd}));
});
test('Return "true" if repository is up to date', async t => {
@@ -232,11 +281,102 @@ test('Return falsy if repository is not up to date', async t => {
t.falsy(await isBranchUpToDate(repositoryUrl, 'master', {cwd}));
});
-test('Return "true" if local repository is ahead', async t => {
- const {cwd, repositoryUrl} = await gitRepo(true);
+test('Return falsy if detached head repository is not up to date', async t => {
+ let {cwd, repositoryUrl} = await gitRepo();
+
+ const [commit] = await gitCommits(['First'], {cwd});
+ await gitCommits(['Second'], {cwd});
+ await gitPush(repositoryUrl, 'master', {cwd});
+ cwd = await gitDetachedHead(repositoryUrl, commit.hash);
+ await fetch(repositoryUrl, 'master', 'master', {cwd});
+
+ t.falsy(await isBranchUpToDate(repositoryUrl, 'master', {cwd}));
+});
+
+test('Get a commit note', 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});
+
+ await gitAddNote(JSON.stringify({note: 'note'}), commits[0].hash, {cwd});
+
+ t.deepEqual(await getNote(commits[0].hash, {cwd}), {note: 'note'});
+});
+
+test('Return empty object if there is no commit note', 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});
+
+ t.deepEqual(await getNote(commits[0].hash, {cwd}), {});
+});
+
+test('Throw error if a commit note in invalid', 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});
+
+ await gitAddNote('non-json note', commits[0].hash, {cwd});
+
+ await t.throwsAsync(getNote(commits[0].hash, {cwd}));
+});
+
+test('Add a commit note', 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});
+
+ await addNote({note: 'note'}, commits[0].hash, {cwd});
+
+ t.is(await gitGetNote(commits[0].hash, {cwd}), '{"note":"note"}');
+});
+
+test('Overwrite a commit note', 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});
+
+ await addNote({note: 'note'}, commits[0].hash, {cwd});
+ await addNote({note: 'note2'}, commits[0].hash, {cwd});
+
+ t.is(await gitGetNote(commits[0].hash, {cwd}), '{"note":"note2"}');
+});
+
+test('Unshallow and fetch repository with notes', 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
+ const commits = await gitCommits(['First', 'Second'], {cwd});
+ await gitAddNote(JSON.stringify({note: 'note'}), commits[0].hash, {cwd});
+ // Create a shallow clone with only 1 commit
+ cwd = await gitShallowClone(repositoryUrl);
+
+ // Verify the shallow clone doesn't contains the note
+ await t.throwsAsync(gitGetNote(commits[0].hash, {cwd}));
+
+ await fetch(repositoryUrl, 'master', 'master', {cwd});
+ await fetchNotes(repositoryUrl, {cwd});
+
+ // Verify the shallow clone contains the note
+ t.is(await gitGetNote(commits[0].hash, {cwd}), '{"note":"note"}');
+});
+
+test('Fetch all notes on a detached head repository', async t => {
+ let {cwd, repositoryUrl} = await gitRepo();
+
await gitCommits(['First'], {cwd});
+ const [commit] = await gitCommits(['Second'], {cwd});
await gitPush(repositoryUrl, 'master', {cwd});
- await gitCommits(['Second'], {cwd});
+ await gitAddNote(JSON.stringify({note: 'note'}), commit.hash, {cwd});
+ cwd = await gitDetachedHead(repositoryUrl, commit.hash);
- t.true(await isBranchUpToDate(repositoryUrl, 'master', {cwd}));
+ await fetch(repositoryUrl, 'master', 'master', {cwd});
+ await fetchNotes(repositoryUrl, {cwd});
+
+ t.is(await gitGetNote(commit.hash, {cwd}), '{"note":"note"}');
});
diff --git a/test/helpers/git-utils.js b/test/helpers/git-utils.js
index e2c3d452cb..c474801b55 100644
--- a/test/helpers/git-utils.js
+++ b/test/helpers/git-utils.js
@@ -1,9 +1,10 @@
import tempy from 'tempy';
import execa from 'execa';
import fileUrl from 'file-url';
-import pReduce from 'p-reduce';
+import pEachSeries from 'p-each-series';
import gitLogParser from 'git-log-parser';
import getStream from 'get-stream';
+import {GIT_NOTE_REF} from '../../lib/definitions/constants';
/**
* Commit message informations.
@@ -69,10 +70,9 @@ export async function initBareRepo(repositoryUrl, branch = 'master') {
* @returns {Array} The created commits, in reverse order (to match `git log` order).
*/
export async function gitCommits(messages, execaOpts) {
- await pReduce(
+ await pEachSeries(
messages,
- async (_, message) =>
- (await execa('git', ['commit', '-m', message, '--allow-empty', '--no-gpg-sign'], execaOpts)).stdout
+ async message => (await execa('git', ['commit', '-m', message, '--allow-empty', '--no-gpg-sign'], execaOpts)).stdout
);
return (await gitGetCommits(undefined, execaOpts)).slice(0, messages.length);
}
@@ -166,6 +166,17 @@ export async function gitDetachedHead(repositoryUrl, head) {
return cwd;
}
+export async function gitDetachedHeadFromBranch(repositoryUrl, branch, head) {
+ const cwd = tempy.directory();
+
+ await execa('git', ['init'], {cwd});
+ await execa('git', ['remote', 'add', 'origin', repositoryUrl], {cwd});
+ await execa('git', ['fetch', '--force', repositoryUrl, `${branch}:remotes/origin/${branch}`], {cwd});
+ await execa('git', ['reset', '--hard', head], {cwd});
+ await execa('git', ['checkout', '-q', '-B', branch], {cwd});
+ return cwd;
+}
+
/**
* Add a new Git configuration.
*
@@ -202,7 +213,7 @@ export async function gitRemoteTagHead(repositoryUrl, tagName, execaOpts) {
return (await execa('git', ['ls-remote', '--tags', repositoryUrl, tagName], execaOpts)).stdout
.split('\n')
.filter(tag => Boolean(tag))
- .map(tag => tag.match(/^(\S+)/)[1])[0];
+ .map(tag => tag.match(/^(?\S+)/)[1])[0];
}
/**
@@ -229,3 +240,54 @@ export async function gitCommitTag(gitHead, execaOpts) {
export async function gitPush(repositoryUrl, branch, execaOpts) {
await execa('git', ['push', '--tags', repositoryUrl, `HEAD:${branch}`], execaOpts);
}
+
+/**
+ * Merge a branch into the current one with `git merge`.
+ *
+ * @param {String} ref The ref to merge.
+ * @param {Object} [execaOpts] Options to pass to `execa`.
+ */
+export async function merge(ref, execaOpts) {
+ await execa('git', ['merge', '--no-ff', ref], execaOpts);
+}
+
+/**
+ * Merge a branch into the current one with `git merge --ff`.
+ *
+ * @param {String} ref The ref to merge.
+ * @param {Object} [execaOpts] Options to pass to `execa`.
+ */
+export async function mergeFf(ref, execaOpts) {
+ await execa('git', ['merge', '--ff', ref], execaOpts);
+}
+
+/**
+ * Merge a branch into the current one with `git rebase`.
+ *
+ * @param {String} ref The ref to merge.
+ * @param {Object} [execaOpts] Options to pass to `execa`.
+ */
+export async function rebase(ref, execaOpts) {
+ await execa('git', ['rebase', ref], execaOpts);
+}
+
+/**
+ * Add a note to a Git reference.
+ *
+ * @param {String} note The note to add.
+ * @param {String} ref The ref to add the note to.
+ * @param {Object} [execaOpts] Options to pass to `execa`.
+ */
+export async function gitAddNote(note, ref, execaOpts) {
+ await execa('git', ['notes', '--ref', GIT_NOTE_REF, 'add', '-m', note, ref], execaOpts);
+}
+
+/**
+ * Get the note associated with a Git reference.
+ *
+ * @param {String} ref The ref to get the note from.
+ * @param {Object} [execaOpts] Options to pass to `execa`.
+ */
+export async function gitGetNote(ref, execaOpts) {
+ return (await execa('git', ['notes', '--ref', GIT_NOTE_REF, 'show', ref], execaOpts)).stdout;
+}
diff --git a/test/helpers/gitbox.js b/test/helpers/gitbox.js
index 2dba7c2059..6ddd586fb7 100644
--- a/test/helpers/gitbox.js
+++ b/test/helpers/gitbox.js
@@ -3,7 +3,7 @@ import getStream from 'get-stream';
import pRetry from 'p-retry';
import {initBareRepo, gitShallowClone} from './git-utils';
-const IMAGE = 'pvdlg/docker-gitbox';
+const IMAGE = 'pvdlg/docker-gitbox:latest';
const SERVER_PORT = 80;
const HOST_PORT = 2080;
const SERVER_HOST = 'localhost';
diff --git a/test/helpers/npm-utils.js b/test/helpers/npm-utils.js
new file mode 100644
index 0000000000..ea0192a85d
--- /dev/null
+++ b/test/helpers/npm-utils.js
@@ -0,0 +1,5 @@
+import execa from 'execa';
+
+export async function npmView(packageName, env) {
+ return JSON.parse((await execa('npm', ['view', packageName, '--json'], {env})).stdout);
+}
diff --git a/test/index.test.js b/test/index.test.js
index a50b7e5790..08f8075bd1 100644
--- a/test/index.test.js
+++ b/test/index.test.js
@@ -1,5 +1,5 @@
import test from 'ava';
-import {escapeRegExp, isString, sortBy} from 'lodash';
+import {escapeRegExp, isString, sortBy, omit} from 'lodash';
import proxyquire from 'proxyquire';
import {spy, stub} from 'sinon';
import {WritableStreamBuffer} from 'stream-buffers';
@@ -8,6 +8,7 @@ import SemanticReleaseError from '@semantic-release/error';
import {COMMIT_NAME, COMMIT_EMAIL, SECRET_REPLACEMENT} from '../lib/definitions/constants';
import {
gitHead as getGitHead,
+ gitCheckout,
gitTagHead,
gitRepo,
gitCommits,
@@ -15,6 +16,11 @@ import {
gitRemoteTagHead,
gitPush,
gitShallowClone,
+ merge,
+ mergeFf,
+ rebase,
+ gitAddNote,
+ gitGetNote,
} from './helpers/git-utils';
const requireNoCache = proxyquire.noPreserveCache();
@@ -42,12 +48,28 @@ test('Plugins are called with expected values', async t => {
let commits = await gitCommits(['First'], {cwd});
// Create the tag corresponding to version 1.0.0
await gitTagVersion('v1.0.0', undefined, {cwd});
- // Add new commits to the master branch
+ await gitAddNote(JSON.stringify({channels: ['next']}), 'v1.0.0', {cwd});
commits = (await gitCommits(['Second'], {cwd})).concat(commits);
+ await gitCheckout('next', true, {cwd});
+ await gitPush(repositoryUrl, 'next', {cwd});
+ await gitCheckout('master', false, {cwd});
await gitPush(repositoryUrl, 'master', {cwd});
- const lastRelease = {version: '1.0.0', gitHead: commits[commits.length - 1].hash, gitTag: 'v1.0.0'};
- const nextRelease = {type: 'major', version: '2.0.0', gitHead: await getGitHead({cwd}), gitTag: 'v2.0.0'};
+ const lastRelease = {
+ version: '1.0.0',
+ gitHead: commits[commits.length - 1].hash,
+ gitTag: 'v1.0.0',
+ name: 'v1.0.0',
+ channels: ['next'],
+ };
+ const nextRelease = {
+ name: 'v1.1.0',
+ type: 'minor',
+ version: '1.1.0',
+ gitHead: await getGitHead({cwd}),
+ gitTag: 'v1.1.0',
+ channel: null,
+ };
const notes1 = 'Release notes 1';
const notes2 = 'Release notes 2';
const notes3 = 'Release notes 3';
@@ -59,24 +81,68 @@ test('Plugins are called with expected values', async t => {
const generateNotes2 = stub().resolves(notes2);
const generateNotes3 = stub().resolves(notes3);
const release1 = {name: 'Release 1', url: 'https://release1.com'};
+ const release2 = {name: 'Release 2', url: 'https://release2.com'};
+ const addChannel = stub().resolves(release1);
const prepare = stub().resolves();
- const publish1 = stub().resolves(release1);
+ const publish = stub().resolves(release2);
const success = stub().resolves();
- const env = {...process.env};
- const config = {branch: 'master', repositoryUrl, globalOpt: 'global', tagFormat: `v\${version}`};
+ const env = {};
+ const config = {
+ branches: [{name: 'master'}, {name: 'next'}],
+ repositoryUrl,
+ globalOpt: 'global',
+ tagFormat: `v\${version}`,
+ };
+ const branches = [
+ {
+ channel: undefined,
+ name: 'master',
+ range: '>=1.0.0',
+ accept: ['patch', 'minor', 'major'],
+ tags: [{channels: ['next'], gitTag: 'v1.0.0', version: '1.0.0'}],
+ type: 'release',
+ main: true,
+ },
+ {
+ channel: 'next',
+ name: 'next',
+ range: '>=1.0.0',
+ accept: ['patch', 'minor', 'major'],
+ tags: [{channels: ['next'], gitTag: 'v1.0.0', version: '1.0.0'}],
+ type: 'release',
+ main: false,
+ },
+ ];
+ const branch = branches[0];
const options = {
...config,
plugins: false,
verifyConditions: [verifyConditions1, verifyConditions2],
analyzeCommits,
verifyRelease,
+ addChannel,
generateNotes: [generateNotes1, generateNotes2, generateNotes3],
prepare,
- publish: [publish1, pluginNoop],
+ publish: [publish, pluginNoop],
success,
};
const envCi = {branch: 'master', isCi: true, isPr: false};
+ const releases = [
+ {
+ ...omit(lastRelease, 'channels'),
+ ...release1,
+ type: 'major',
+ version: '1.0.0',
+ channel: null,
+ gitTag: 'v1.0.0',
+ notes: `${notes1}\n\n${notes2}\n\n${notes3}`,
+ pluginName: '[Function: functionStub]',
+ },
+ {...nextRelease, ...release2, notes: `${notes1}\n\n${notes2}\n\n${notes3}`, pluginName: '[Function: functionStub]'},
+ {...nextRelease, notes: `${notes1}\n\n${notes2}\n\n${notes3}`, pluginName: pluginNoop},
+ ];
+
const semanticRelease = requireNoCache('..', {
'./lib/get-logger': () => t.context.logger,
'env-ci': () => envCi,
@@ -92,17 +158,112 @@ test('Plugins are called with expected values', async t => {
t.deepEqual(verifyConditions1.args[0][0], config);
t.deepEqual(verifyConditions1.args[0][1].cwd, cwd);
t.deepEqual(verifyConditions1.args[0][1].options, options);
+ t.deepEqual(verifyConditions1.args[0][1].branch, branch);
+ t.deepEqual(verifyConditions1.args[0][1].branches, branches);
t.deepEqual(verifyConditions1.args[0][1].logger, t.context.logger);
+ t.deepEqual(verifyConditions1.args[0][1].envCi, envCi);
t.is(verifyConditions2.callCount, 1);
t.deepEqual(verifyConditions2.args[0][0], config);
t.deepEqual(verifyConditions2.args[0][1].cwd, cwd);
t.deepEqual(verifyConditions2.args[0][1].options, options);
+ t.deepEqual(verifyConditions2.args[0][1].branch, branch);
+ t.deepEqual(verifyConditions2.args[0][1].branches, branches);
t.deepEqual(verifyConditions2.args[0][1].logger, t.context.logger);
t.deepEqual(verifyConditions2.args[0][1].envCi, envCi);
+ t.is(generateNotes1.callCount, 2);
+ t.is(generateNotes2.callCount, 2);
+ t.is(generateNotes3.callCount, 2);
+
+ t.deepEqual(generateNotes1.args[0][0], config);
+ t.deepEqual(generateNotes1.args[0][1].options, options);
+ t.deepEqual(generateNotes1.args[0][1].branch, branch);
+ t.deepEqual(generateNotes1.args[0][1].branches, branches);
+ t.deepEqual(generateNotes1.args[0][1].logger, t.context.logger);
+ t.deepEqual(generateNotes1.args[0][1].lastRelease, {});
+ t.deepEqual(generateNotes1.args[0][1].commits[0].hash, commits[1].hash);
+ t.deepEqual(generateNotes1.args[0][1].commits[0].message, commits[1].message);
+ t.deepEqual(generateNotes1.args[0][1].nextRelease, {
+ ...omit(lastRelease, 'channels'),
+ type: 'major',
+ version: '1.0.0',
+ channel: null,
+ gitTag: 'v1.0.0',
+ name: 'v1.0.0',
+ });
+ t.deepEqual(generateNotes2.args[0][1].envCi, envCi);
+
+ t.deepEqual(generateNotes2.args[0][0], config);
+ t.deepEqual(generateNotes2.args[0][1].options, options);
+ t.deepEqual(generateNotes2.args[0][1].branch, branch);
+ t.deepEqual(generateNotes2.args[0][1].branches, branches);
+ t.deepEqual(generateNotes2.args[0][1].logger, t.context.logger);
+ t.deepEqual(generateNotes2.args[0][1].lastRelease, {});
+ t.deepEqual(generateNotes2.args[0][1].commits[0].hash, commits[1].hash);
+ t.deepEqual(generateNotes2.args[0][1].commits[0].message, commits[1].message);
+ t.deepEqual(generateNotes2.args[0][1].nextRelease, {
+ ...omit(lastRelease, 'channels'),
+ type: 'major',
+ version: '1.0.0',
+ channel: null,
+ gitTag: 'v1.0.0',
+ name: 'v1.0.0',
+ notes: notes1,
+ });
+ t.deepEqual(generateNotes2.args[0][1].envCi, envCi);
+
+ t.deepEqual(generateNotes3.args[0][0], config);
+ t.deepEqual(generateNotes3.args[0][1].options, options);
+ t.deepEqual(generateNotes3.args[0][1].branch, branch);
+ t.deepEqual(generateNotes3.args[0][1].branches, branches);
+ t.deepEqual(generateNotes3.args[0][1].logger, t.context.logger);
+ t.deepEqual(generateNotes3.args[0][1].lastRelease, {});
+ t.deepEqual(generateNotes3.args[0][1].commits[0].hash, commits[1].hash);
+ t.deepEqual(generateNotes3.args[0][1].commits[0].message, commits[1].message);
+ t.deepEqual(generateNotes3.args[0][1].nextRelease, {
+ ...omit(lastRelease, 'channels'),
+ type: 'major',
+ version: '1.0.0',
+ channel: null,
+ gitTag: 'v1.0.0',
+ name: 'v1.0.0',
+ notes: `${notes1}\n\n${notes2}`,
+ });
+ t.deepEqual(generateNotes3.args[0][1].envCi, envCi);
+
+ branch.tags.push({
+ version: '1.0.0',
+ channel: null,
+ gitTag: 'v1.0.0',
+ gitHead: commits[commits.length - 1].hash,
+ });
+
+ t.is(addChannel.callCount, 1);
+ t.deepEqual(addChannel.args[0][0], config);
+ t.deepEqual(addChannel.args[0][1].options, options);
+ t.deepEqual(addChannel.args[0][1].branch, branch);
+ t.deepEqual(addChannel.args[0][1].branches, branches);
+ t.deepEqual(addChannel.args[0][1].logger, t.context.logger);
+ t.deepEqual(addChannel.args[0][1].lastRelease, {});
+ t.deepEqual(addChannel.args[0][1].currentRelease, {...lastRelease, type: 'major'});
+ t.deepEqual(addChannel.args[0][1].nextRelease, {
+ ...omit(lastRelease, 'channels'),
+ type: 'major',
+ version: '1.0.0',
+ channel: null,
+ gitTag: 'v1.0.0',
+ name: 'v1.0.0',
+ notes: `${notes1}\n\n${notes2}\n\n${notes3}`,
+ });
+ t.deepEqual(addChannel.args[0][1].commits[0].hash, commits[1].hash);
+ t.deepEqual(addChannel.args[0][1].commits[0].message, commits[1].message);
+ t.deepEqual(addChannel.args[0][1].envCi, envCi);
+
t.is(analyzeCommits.callCount, 1);
t.deepEqual(analyzeCommits.args[0][0], config);
t.deepEqual(analyzeCommits.args[0][1].options, options);
+ t.deepEqual(analyzeCommits.args[0][1].branch, branch);
+ t.deepEqual(analyzeCommits.args[0][1].branches, branches);
t.deepEqual(analyzeCommits.args[0][1].logger, t.context.logger);
t.deepEqual(analyzeCommits.args[0][1].lastRelease, lastRelease);
t.deepEqual(analyzeCommits.args[0][1].commits[0].hash, commits[0].hash);
@@ -112,6 +273,8 @@ test('Plugins are called with expected values', async t => {
t.is(verifyRelease.callCount, 1);
t.deepEqual(verifyRelease.args[0][0], config);
t.deepEqual(verifyRelease.args[0][1].options, options);
+ t.deepEqual(verifyRelease.args[0][1].branch, branch);
+ t.deepEqual(verifyRelease.args[0][1].branches, branches);
t.deepEqual(verifyRelease.args[0][1].logger, t.context.logger);
t.deepEqual(verifyRelease.args[0][1].lastRelease, lastRelease);
t.deepEqual(verifyRelease.args[0][1].commits[0].hash, commits[0].hash);
@@ -119,39 +282,44 @@ test('Plugins are called with expected values', async t => {
t.deepEqual(verifyRelease.args[0][1].nextRelease, nextRelease);
t.deepEqual(verifyRelease.args[0][1].envCi, envCi);
- t.is(generateNotes1.callCount, 1);
- t.deepEqual(generateNotes1.args[0][0], config);
- t.deepEqual(generateNotes1.args[0][1].options, options);
- t.deepEqual(generateNotes1.args[0][1].logger, t.context.logger);
- t.deepEqual(generateNotes1.args[0][1].lastRelease, lastRelease);
- t.deepEqual(generateNotes1.args[0][1].commits[0].hash, commits[0].hash);
- t.deepEqual(generateNotes1.args[0][1].commits[0].message, commits[0].message);
- t.deepEqual(generateNotes1.args[0][1].nextRelease, nextRelease);
- t.deepEqual(generateNotes1.args[0][1].envCi, envCi);
-
- t.is(generateNotes2.callCount, 1);
- t.deepEqual(generateNotes2.args[0][0], config);
- t.deepEqual(generateNotes2.args[0][1].options, options);
- t.deepEqual(generateNotes2.args[0][1].logger, t.context.logger);
- t.deepEqual(generateNotes2.args[0][1].lastRelease, lastRelease);
- t.deepEqual(generateNotes2.args[0][1].commits[0].hash, commits[0].hash);
- t.deepEqual(generateNotes2.args[0][1].commits[0].message, commits[0].message);
- t.deepEqual(generateNotes2.args[0][1].nextRelease, {...nextRelease, notes: notes1});
- t.deepEqual(generateNotes2.args[0][1].envCi, envCi);
-
- t.is(generateNotes3.callCount, 1);
- t.deepEqual(generateNotes3.args[0][0], config);
- t.deepEqual(generateNotes3.args[0][1].options, options);
- t.deepEqual(generateNotes3.args[0][1].logger, t.context.logger);
- t.deepEqual(generateNotes3.args[0][1].lastRelease, lastRelease);
- t.deepEqual(generateNotes3.args[0][1].commits[0].hash, commits[0].hash);
- t.deepEqual(generateNotes3.args[0][1].commits[0].message, commits[0].message);
- t.deepEqual(generateNotes3.args[0][1].nextRelease, {...nextRelease, notes: `${notes1}\n\n${notes2}`});
- t.deepEqual(generateNotes3.args[0][1].envCi, envCi);
+ t.deepEqual(generateNotes1.args[1][0], config);
+ t.deepEqual(generateNotes1.args[1][1].options, options);
+ t.deepEqual(generateNotes1.args[1][1].branch, branch);
+ t.deepEqual(generateNotes1.args[1][1].branches, branches);
+ t.deepEqual(generateNotes1.args[1][1].logger, t.context.logger);
+ t.deepEqual(generateNotes1.args[1][1].lastRelease, lastRelease);
+ t.deepEqual(generateNotes1.args[1][1].commits[0].hash, commits[0].hash);
+ t.deepEqual(generateNotes1.args[1][1].commits[0].message, commits[0].message);
+ t.deepEqual(generateNotes1.args[1][1].nextRelease, nextRelease);
+ t.deepEqual(generateNotes1.args[1][1].envCi, envCi);
+
+ t.deepEqual(generateNotes2.args[1][0], config);
+ t.deepEqual(generateNotes2.args[1][1].options, options);
+ t.deepEqual(generateNotes2.args[1][1].branch, branch);
+ t.deepEqual(generateNotes2.args[1][1].branches, branches);
+ t.deepEqual(generateNotes2.args[1][1].logger, t.context.logger);
+ t.deepEqual(generateNotes2.args[1][1].lastRelease, lastRelease);
+ t.deepEqual(generateNotes2.args[1][1].commits[0].hash, commits[0].hash);
+ t.deepEqual(generateNotes2.args[1][1].commits[0].message, commits[0].message);
+ t.deepEqual(generateNotes2.args[1][1].nextRelease, {...nextRelease, notes: notes1});
+ t.deepEqual(generateNotes2.args[1][1].envCi, envCi);
+
+ t.deepEqual(generateNotes3.args[1][0], config);
+ t.deepEqual(generateNotes3.args[1][1].options, options);
+ t.deepEqual(generateNotes3.args[1][1].branch, branch);
+ t.deepEqual(generateNotes3.args[1][1].branches, branches);
+ t.deepEqual(generateNotes3.args[1][1].logger, t.context.logger);
+ t.deepEqual(generateNotes3.args[1][1].lastRelease, lastRelease);
+ t.deepEqual(generateNotes3.args[1][1].commits[0].hash, commits[0].hash);
+ t.deepEqual(generateNotes3.args[1][1].commits[0].message, commits[0].message);
+ t.deepEqual(generateNotes3.args[1][1].nextRelease, {...nextRelease, notes: `${notes1}\n\n${notes2}`});
+ t.deepEqual(generateNotes3.args[1][1].envCi, envCi);
t.is(prepare.callCount, 1);
t.deepEqual(prepare.args[0][0], config);
t.deepEqual(prepare.args[0][1].options, options);
+ t.deepEqual(prepare.args[0][1].branch, branch);
+ t.deepEqual(prepare.args[0][1].branches, branches);
t.deepEqual(prepare.args[0][1].logger, t.context.logger);
t.deepEqual(prepare.args[0][1].lastRelease, lastRelease);
t.deepEqual(prepare.args[0][1].commits[0].hash, commits[0].hash);
@@ -159,43 +327,56 @@ test('Plugins are called with expected values', async t => {
t.deepEqual(prepare.args[0][1].nextRelease, {...nextRelease, notes: `${notes1}\n\n${notes2}\n\n${notes3}`});
t.deepEqual(prepare.args[0][1].envCi, envCi);
- t.is(publish1.callCount, 1);
- t.deepEqual(publish1.args[0][0], config);
- t.deepEqual(publish1.args[0][1].options, options);
- t.deepEqual(publish1.args[0][1].logger, t.context.logger);
- t.deepEqual(publish1.args[0][1].lastRelease, lastRelease);
- t.deepEqual(publish1.args[0][1].commits[0].hash, commits[0].hash);
- t.deepEqual(publish1.args[0][1].commits[0].message, commits[0].message);
- t.deepEqual(publish1.args[0][1].nextRelease, {...nextRelease, notes: `${notes1}\n\n${notes2}\n\n${notes3}`});
- t.deepEqual(publish1.args[0][1].envCi, envCi);
+ t.is(publish.callCount, 1);
+ t.deepEqual(publish.args[0][0], config);
+ t.deepEqual(publish.args[0][1].options, options);
+ t.deepEqual(publish.args[0][1].branch, branch);
+ t.deepEqual(publish.args[0][1].branches, branches);
+ t.deepEqual(publish.args[0][1].logger, t.context.logger);
+ t.deepEqual(publish.args[0][1].lastRelease, lastRelease);
+ t.deepEqual(publish.args[0][1].commits[0].hash, commits[0].hash);
+ t.deepEqual(publish.args[0][1].commits[0].message, commits[0].message);
+ t.deepEqual(publish.args[0][1].nextRelease, {...nextRelease, notes: `${notes1}\n\n${notes2}\n\n${notes3}`});
+ t.deepEqual(publish.args[0][1].envCi, envCi);
- t.is(success.callCount, 1);
+ t.is(success.callCount, 2);
t.deepEqual(success.args[0][0], config);
t.deepEqual(success.args[0][1].options, options);
+ t.deepEqual(success.args[0][1].branch, branch);
+ t.deepEqual(success.args[0][1].branches, branches);
t.deepEqual(success.args[0][1].logger, t.context.logger);
- t.deepEqual(success.args[0][1].lastRelease, lastRelease);
- t.deepEqual(success.args[0][1].commits[0].hash, commits[0].hash);
- t.deepEqual(success.args[0][1].commits[0].message, commits[0].message);
- t.deepEqual(success.args[0][1].nextRelease, {...nextRelease, notes: `${notes1}\n\n${notes2}\n\n${notes3}`});
- t.deepEqual(success.args[0][1].releases, [
- {...release1, ...nextRelease, notes: `${notes1}\n\n${notes2}\n\n${notes3}`, pluginName: '[Function: functionStub]'},
- {...nextRelease, notes: `${notes1}\n\n${notes2}\n\n${notes3}`, pluginName: pluginNoop},
- ]);
+ t.deepEqual(success.args[0][1].lastRelease, {});
+ t.deepEqual(success.args[0][1].commits[0].hash, commits[1].hash);
+ t.deepEqual(success.args[0][1].commits[0].message, commits[1].message);
+ t.deepEqual(success.args[0][1].nextRelease, {
+ ...omit(lastRelease, 'channels'),
+ type: 'major',
+ version: '1.0.0',
+ channel: null,
+ gitTag: 'v1.0.0',
+ name: 'v1.0.0',
+ notes: `${notes1}\n\n${notes2}\n\n${notes3}`,
+ });
+ t.deepEqual(success.args[0][1].releases, [releases[0]]);
t.deepEqual(success.args[0][1].envCi, envCi);
+ t.deepEqual(success.args[1][0], config);
+ t.deepEqual(success.args[1][1].options, options);
+ t.deepEqual(success.args[1][1].branch, branch);
+ t.deepEqual(success.args[1][1].branches, branches);
+ t.deepEqual(success.args[1][1].logger, t.context.logger);
+ t.deepEqual(success.args[1][1].lastRelease, lastRelease);
+ t.deepEqual(success.args[1][1].commits[0].hash, commits[0].hash);
+ t.deepEqual(success.args[1][1].commits[0].message, commits[0].message);
+ t.deepEqual(success.args[1][1].nextRelease, {...nextRelease, notes: `${notes1}\n\n${notes2}\n\n${notes3}`});
+ t.deepEqual(success.args[1][1].releases, [releases[1], releases[2]]);
+ t.deepEqual(success.args[1][1].envCi, envCi);
+
t.deepEqual(result, {
lastRelease,
- commits: [commits[0]],
+ commits: [{...commits[0], gitTags: '(HEAD -> master, next)'}],
nextRelease: {...nextRelease, notes: `${notes1}\n\n${notes2}\n\n${notes3}`},
- releases: [
- {
- ...release1,
- ...nextRelease,
- notes: `${notes1}\n\n${notes2}\n\n${notes3}`,
- pluginName: '[Function: functionStub]',
- },
- {...nextRelease, notes: `${notes1}\n\n${notes2}\n\n${notes3}`, pluginName: pluginNoop},
- ],
+ releases,
});
// Verify the tag has been created on the local and remote repo and reference the gitHead
@@ -216,15 +397,22 @@ test('Use custom tag format', async t => {
await gitCommits(['Second'], {cwd});
await gitPush(repositoryUrl, 'master', {cwd});
- const nextRelease = {type: 'major', version: '2.0.0', gitHead: await getGitHead({cwd}), gitTag: 'test-2.0.0'};
+ const nextRelease = {
+ name: 'test-2.0.0',
+ type: 'major',
+ version: '2.0.0',
+ gitHead: await getGitHead({cwd}),
+ gitTag: 'test-2.0.0',
+ };
const notes = 'Release notes';
- const config = {branch: 'master', repositoryUrl, globalOpt: 'global', tagFormat: `test-\${version}`};
+ const config = {branches: 'master', repositoryUrl, globalOpt: 'global', tagFormat: `test-\${version}`};
const options = {
...config,
verifyConditions: stub().resolves(),
analyzeCommits: stub().resolves(nextRelease.type),
verifyRelease: stub().resolves(),
generateNotes: stub().resolves(notes),
+ addChannel: stub().resolves(),
prepare: stub().resolves(),
publish: stub().resolves(),
success: stub().resolves(),
@@ -260,7 +448,14 @@ test('Use new gitHead, and recreate release notes if a prepare plugin create a c
commits = (await gitCommits(['Second'], {cwd})).concat(commits);
await gitPush(repositoryUrl, 'master', {cwd});
- const nextRelease = {type: 'major', version: '2.0.0', gitHead: await getGitHead({cwd}), gitTag: 'v2.0.0'};
+ const nextRelease = {
+ name: 'v2.0.0',
+ type: 'major',
+ version: '2.0.0',
+ gitHead: await getGitHead({cwd}),
+ gitTag: 'v2.0.0',
+ channel: null,
+ };
const notes = 'Release notes';
const generateNotes = stub().resolves(notes);
@@ -270,12 +465,13 @@ test('Use new gitHead, and recreate release notes if a prepare plugin create a c
const prepare2 = stub().resolves();
const publish = stub().resolves();
const options = {
- branch: 'master',
+ branches: ['master'],
repositoryUrl,
verifyConditions: stub().resolves(),
analyzeCommits: stub().resolves(nextRelease.type),
verifyRelease: stub().resolves(),
generateNotes,
+ addChannel: stub().resolves(),
prepare: [prepare1, prepare2],
publish,
success: stub().resolves(),
@@ -315,6 +511,345 @@ test('Use new gitHead, and recreate release notes if a prepare plugin create a c
t.is(await gitRemoteTagHead(repositoryUrl, nextRelease.gitTag, {cwd}), commits[0].hash);
});
+test('Make a new release when a commit is forward-ported to an upper branch', async t => {
+ const {cwd, repositoryUrl} = await gitRepo(true);
+ await gitCommits(['feat: initial release'], {cwd});
+ await gitTagVersion('v1.0.0', undefined, {cwd});
+ await gitAddNote(JSON.stringify({channels: [null, '1.0.x']}), 'v1.0.0', {cwd});
+ await gitCheckout('1.0.x', true, {cwd});
+ await gitCommits(['fix: fix on maintenance version 1.0.x'], {cwd});
+ await gitTagVersion('v1.0.1', undefined, {cwd});
+ await gitAddNote(JSON.stringify({channels: ['1.0.x']}), 'v1.0.1', {cwd});
+ await gitPush('origin', '1.0.x', {cwd});
+ await gitCheckout('master', false, {cwd});
+ await gitCommits(['feat: new feature on master'], {cwd});
+ await gitTagVersion('v1.1.0', undefined, {cwd});
+ await merge('1.0.x', {cwd});
+ await gitPush('origin', 'master', {cwd});
+
+ const verifyConditions = stub().resolves();
+ const verifyRelease = stub().resolves();
+ const addChannel = stub().resolves();
+ const prepare = stub().resolves();
+ const publish = stub().resolves();
+ const success = stub().resolves();
+
+ const config = {branches: [{name: '1.0.x'}, {name: 'master'}], repositoryUrl, tagFormat: `v\${version}`};
+ const options = {
+ ...config,
+ verifyConditions,
+ verifyRelease,
+ addChannel,
+ prepare,
+ publish,
+ success,
+ };
+
+ const semanticRelease = proxyquire('..', {
+ './lib/logger': t.context.logger,
+ 'env-ci': () => ({isCi: true, branch: 'master', isPr: false}),
+ });
+ t.truthy(await semanticRelease(options, {cwd, env: {}, stdout: {write: () => {}}, stderr: {write: () => {}}}));
+
+ t.is(addChannel.callCount, 0);
+ t.is(publish.callCount, 1);
+ // The release 1.1.1, triggered by the forward-port of "fix: fix on maintenance version 1.0.x" has been published from master
+ t.is(publish.args[0][1].nextRelease.version, '1.1.1');
+ t.is(success.callCount, 1);
+});
+
+test('Publish a pre-release version', async t => {
+ const {cwd, repositoryUrl} = await gitRepo(true);
+ await gitCommits(['feat: initial commit'], {cwd});
+ await gitTagVersion('v1.0.0', undefined, {cwd});
+ await gitPush(repositoryUrl, 'master', {cwd});
+ await gitCheckout('beta', true, {cwd});
+ await gitCommits(['feat: a feature'], {cwd});
+ await gitPush(repositoryUrl, 'beta', {cwd});
+
+ const config = {branches: ['master', {name: 'beta', prerelease: true}], repositoryUrl};
+ const options = {
+ ...config,
+ verifyConditions: stub().resolves(),
+ verifyRelease: stub().resolves(),
+ generateNotes: stub().resolves(''),
+ addChannel: false,
+ prepare: stub().resolves(),
+ publish: stub().resolves(),
+ success: stub().resolves(),
+ fail: stub().resolves(),
+ };
+
+ const semanticRelease = requireNoCache('..', {
+ './lib/get-logger': () => t.context.logger,
+ 'env-ci': () => ({isCi: true, branch: 'beta', isPr: false}),
+ });
+ let {releases} = await semanticRelease(options, {cwd, env: {}, stdout: {write: () => {}}, stderr: {write: () => {}}});
+
+ t.is(releases.length, 1);
+ t.is(releases[0].version, '1.1.0-beta.1');
+ t.is(releases[0].gitTag, 'v1.1.0-beta.1');
+ t.is(await gitGetNote('v1.1.0-beta.1', {cwd}), '{"channels":["beta"]}');
+
+ await gitCommits(['fix: a fix'], {cwd});
+ ({releases} = await semanticRelease(options, {
+ cwd,
+ env: {},
+ stdout: {write: () => {}},
+ stderr: {write: () => {}},
+ }));
+
+ t.is(releases.length, 1);
+ t.is(releases[0].version, '1.1.0-beta.2');
+ t.is(releases[0].gitTag, 'v1.1.0-beta.2');
+ t.is(await gitGetNote('v1.1.0-beta.2', {cwd}), '{"channels":["beta"]}');
+});
+
+test('Publish releases from different branch on the same channel', async t => {
+ const {cwd, repositoryUrl} = await gitRepo(true);
+ await gitCommits(['feat: initial commit'], {cwd});
+ await gitTagVersion('v1.0.0', undefined, {cwd});
+ await gitPush(repositoryUrl, 'master', {cwd});
+ await gitCheckout('next-major', true, {cwd});
+ await gitPush(repositoryUrl, 'next-major', {cwd});
+ await gitCheckout('next', true, {cwd});
+ await gitCommits(['feat: a feature'], {cwd});
+ await gitPush(repositoryUrl, 'next', {cwd});
+
+ const config = {
+ branches: ['master', {name: 'next', channel: false}, {name: 'next-major', channel: false}],
+ repositoryUrl,
+ };
+ const addChannel = stub().resolves({});
+ const options = {
+ ...config,
+ verifyConditions: stub().resolves(),
+ verifyRelease: stub().resolves(),
+ generateNotes: stub().resolves(''),
+ addChannel,
+ prepare: stub().resolves(),
+ publish: stub().resolves(),
+ success: stub().resolves(),
+ fail: stub().resolves(),
+ };
+
+ let semanticRelease = requireNoCache('..', {
+ './lib/get-logger': () => t.context.logger,
+ 'env-ci': () => ({isCi: true, branch: 'next', isPr: false}),
+ });
+ let {releases} = await semanticRelease(options, {cwd, env: {}, stdout: {write: () => {}}, stderr: {write: () => {}}});
+
+ t.is(releases.length, 1);
+ t.is(releases[0].version, '1.1.0');
+ t.is(releases[0].gitTag, 'v1.1.0');
+
+ await gitCommits(['fix: a fix'], {cwd});
+ ({releases} = await semanticRelease(options, {
+ cwd,
+ env: {},
+ stdout: {write: () => {}},
+ stderr: {write: () => {}},
+ }));
+
+ t.is(releases.length, 1);
+ t.is(releases[0].version, '1.1.1');
+ t.is(releases[0].gitTag, 'v1.1.1');
+
+ await gitCheckout('master', false, {cwd});
+ await merge('next', {cwd});
+ await gitPush('origin', 'master', {cwd});
+
+ semanticRelease = requireNoCache('..', {
+ './lib/get-logger': () => t.context.logger,
+ 'env-ci': () => ({isCi: true, branch: 'master', isPr: false}),
+ });
+
+ t.falsy(await semanticRelease(options, {cwd, env: {}, stdout: {write: () => {}}, stderr: {write: () => {}}}));
+ t.is(addChannel.callCount, 0);
+});
+
+test('Publish pre-releases the same channel as regular releases', async t => {
+ const {cwd, repositoryUrl} = await gitRepo(true);
+ await gitCommits(['feat: initial commit'], {cwd});
+ await gitTagVersion('v1.0.0', undefined, {cwd});
+ await gitPush(repositoryUrl, 'master', {cwd});
+ await gitCheckout('beta', true, {cwd});
+ await gitCommits(['feat: a feature'], {cwd});
+ await gitPush(repositoryUrl, 'beta', {cwd});
+
+ const config = {
+ branches: ['master', {name: 'beta', channel: false, prerelease: true}],
+ repositoryUrl,
+ };
+ const options = {
+ ...config,
+ verifyConditions: stub().resolves(),
+ verifyRelease: stub().resolves(),
+ generateNotes: stub().resolves(''),
+ addChannel: false,
+ prepare: stub().resolves(),
+ publish: stub().resolves(),
+ success: stub().resolves(),
+ fail: stub().resolves(),
+ };
+
+ const semanticRelease = requireNoCache('..', {
+ './lib/get-logger': () => t.context.logger,
+ 'env-ci': () => ({isCi: true, branch: 'beta', isPr: false}),
+ });
+ let {releases} = await semanticRelease(options, {cwd, env: {}, stdout: {write: () => {}}, stderr: {write: () => {}}});
+
+ t.is(releases.length, 1);
+ t.is(releases[0].version, '1.1.0-beta.1');
+ t.is(releases[0].gitTag, 'v1.1.0-beta.1');
+
+ await gitCommits(['fix: a fix'], {cwd});
+ ({releases} = await semanticRelease(options, {
+ cwd,
+ env: {},
+ stdout: {write: () => {}},
+ stderr: {write: () => {}},
+ }));
+
+ t.is(releases.length, 1);
+ t.is(releases[0].version, '1.1.0-beta.2');
+ t.is(releases[0].gitTag, 'v1.1.0-beta.2');
+});
+
+test('Do not add pre-releases to a different channel', async t => {
+ const {cwd, repositoryUrl} = await gitRepo(true);
+ await gitCommits(['feat: initial release'], {cwd});
+ await gitTagVersion('v1.0.0', undefined, {cwd});
+ await gitAddNote(JSON.stringify({channels: [null, 'beta']}), 'v1.0.0', {cwd});
+ await gitCheckout('beta', true, {cwd});
+ await gitCommits(['feat: breaking change/n/nBREAKING CHANGE: break something'], {cwd});
+ await gitTagVersion('v2.0.0-beta.1', undefined, {cwd});
+ await gitAddNote(JSON.stringify({channels: ['beta']}), 'v2.0.0-beta.1', {cwd});
+ await gitCommits(['fix: a fix'], {cwd});
+ await gitTagVersion('v2.0.0-beta.2', undefined, {cwd});
+ await gitAddNote(JSON.stringify({channels: ['beta']}), 'v2.0.0-beta.2', {cwd});
+ await gitPush('origin', 'beta', {cwd});
+ await gitCheckout('master', false, {cwd});
+ await merge('beta', {cwd});
+ await gitPush('origin', 'master', {cwd});
+
+ const verifyConditions = stub().resolves();
+ const verifyRelease = stub().resolves();
+ const generateNotes = stub().resolves('Release notes');
+ const release1 = {name: 'Release 1', url: 'https://release1.com'};
+ const addChannel = stub().resolves(release1);
+ const prepare = stub().resolves();
+ const publish = stub().resolves();
+ const success = stub().resolves();
+
+ const config = {
+ branches: [{name: 'master'}, {name: 'beta', prerelease: 'beta'}],
+ repositoryUrl,
+ tagFormat: `v\${version}`,
+ };
+
+ const options = {
+ ...config,
+ verifyConditions,
+ verifyRelease,
+ addChannel,
+ generateNotes,
+ prepare,
+ publish,
+ success,
+ };
+
+ const semanticRelease = proxyquire('..', {
+ './lib/logger': t.context.logger,
+ 'env-ci': () => ({isCi: true, branch: 'master', isPr: false}),
+ });
+ t.truthy(await semanticRelease(options, {cwd, env: {}, stdout: {write: () => {}}, stderr: {write: () => {}}}));
+
+ t.is(addChannel.callCount, 0);
+});
+
+async function addChannelMacro(t, mergeFunction) {
+ const {cwd, repositoryUrl} = await gitRepo(true);
+ const commits = await gitCommits(['feat: initial release'], {cwd});
+ await gitTagVersion('v1.0.0', undefined, {cwd});
+ await gitAddNote(JSON.stringify({channels: [null, 'next']}), 'v1.0.0', {cwd});
+ await gitCheckout('next', true, {cwd});
+ commits.push(...(await gitCommits(['feat: breaking change/n/nBREAKING CHANGE: break something'], {cwd})));
+ await gitTagVersion('v2.0.0', undefined, {cwd});
+ await gitAddNote(JSON.stringify({channels: ['next']}), 'v2.0.0', {cwd});
+
+ commits.push(...(await gitCommits(['fix: a fix'], {cwd})));
+ await gitTagVersion('v2.0.1', undefined, {cwd});
+ await gitAddNote(JSON.stringify({channels: ['next']}), 'v2.0.1', {cwd});
+ commits.push(...(await gitCommits(['feat: a feature'], {cwd})));
+ await gitTagVersion('v2.1.0', undefined, {cwd});
+ await gitAddNote(JSON.stringify({channels: ['next']}), 'v2.1.0', {cwd});
+ await gitPush('origin', 'next', {cwd});
+ await gitCheckout('master', false, {cwd});
+ // Merge all commits but last one from next to master
+ await mergeFunction('next~1', {cwd});
+ await gitPush('origin', 'master', {cwd});
+
+ const notes = 'Release notes';
+ const verifyConditions = stub().resolves();
+ const verifyRelease = stub().resolves();
+ const generateNotes = stub().resolves(notes);
+ const release1 = {name: 'Release 1', url: 'https://release1.com'};
+ const addChannel1 = stub().resolves(release1);
+ const addChannel2 = stub().resolves();
+ const prepare = stub().resolves();
+ const publish = stub().resolves();
+ const success = stub().resolves();
+
+ const config = {
+ branches: [
+ {name: 'master', channel: 'latest'},
+ {name: 'next', channel: 'next'},
+ ],
+ repositoryUrl,
+ tagFormat: `v\${version}`,
+ };
+ const options = {
+ ...config,
+ verifyConditions,
+ verifyRelease,
+ addChannel: [addChannel1, addChannel2],
+ generateNotes,
+ prepare,
+ publish,
+ success,
+ };
+ const nextRelease = {
+ name: 'v2.0.1',
+ type: 'patch',
+ version: '2.0.1',
+ channel: 'latest',
+ gitTag: 'v2.0.1',
+ gitHead: commits[2].hash,
+ };
+
+ const semanticRelease = proxyquire('..', {
+ './lib/logger': t.context.logger,
+ 'env-ci': () => ({isCi: true, branch: 'master', isPr: false}),
+ });
+ const result = await semanticRelease(options, {cwd, env: {}, stdout: {write: () => {}}, stderr: {write: () => {}}});
+
+ t.deepEqual(result.releases, [
+ {...nextRelease, ...release1, notes, pluginName: '[Function: functionStub]'},
+ {...nextRelease, notes, pluginName: '[Function: functionStub]'},
+ ]);
+
+ // Verify the tag has been created on the local and remote repo and reference
+ t.is(await gitTagHead(nextRelease.gitTag, {cwd}), nextRelease.gitHead);
+ t.is(await gitRemoteTagHead(repositoryUrl, nextRelease.gitTag, {cwd}), nextRelease.gitHead);
+}
+
+addChannelMacro.title = providedTitle => `Add version to a channel after a merge (${providedTitle})`;
+
+test('fast-forward', addChannelMacro, mergeFf);
+test('non fast-forward', addChannelMacro, merge);
+test('rebase', addChannelMacro, rebase);
+
test('Call all "success" plugins even if one errors out', async t => {
// Create a git repository, set the current working directory at the root of the repo
const {cwd, repositoryUrl} = await gitRepo(true);
@@ -326,7 +861,14 @@ test('Call all "success" plugins even if one errors out', async t => {
await gitCommits(['Second'], {cwd});
await gitPush(repositoryUrl, 'master', {cwd});
- const nextRelease = {type: 'major', version: '2.0.0', gitHead: await getGitHead({cwd}), gitTag: 'v2.0.0'};
+ const nextRelease = {
+ name: 'v2.0.0',
+ type: 'major',
+ version: '2.0.0',
+ gitHead: await getGitHead({cwd}),
+ gitTag: 'v2.0.0',
+ channel: null,
+ };
const notes = 'Release notes';
const verifyConditions1 = stub().resolves();
const verifyConditions2 = stub().resolves();
@@ -336,12 +878,18 @@ test('Call all "success" plugins even if one errors out', async t => {
const publish = stub().resolves(release);
const success1 = stub().rejects();
const success2 = stub().resolves();
- const config = {branch: 'master', repositoryUrl, globalOpt: 'global', tagFormat: `v\${version}`};
+ const config = {
+ branches: [{name: 'master'}],
+ repositoryUrl,
+ globalOpt: 'global',
+ tagFormat: `v\${version}`,
+ };
const options = {
...config,
verifyConditions: [verifyConditions1, verifyConditions2],
analyzeCommits,
generateNotes,
+ addChannel: stub().resolves(),
prepare: stub().resolves(),
publish,
success: [success1, success2],
@@ -357,13 +905,14 @@ test('Call all "success" plugins even if one errors out', async t => {
);
t.is(success1.callCount, 1);
+ t.deepEqual(success1.args[0][0], config);
t.deepEqual(success1.args[0][1].releases, [
- {...release, ...nextRelease, notes, pluginName: '[Function: functionStub]'},
+ {...nextRelease, ...release, notes, pluginName: '[Function: functionStub]'},
]);
t.is(success2.callCount, 1);
t.deepEqual(success2.args[0][1].releases, [
- {...release, ...nextRelease, notes, pluginName: '[Function: functionStub]'},
+ {...nextRelease, ...release, notes, pluginName: '[Function: functionStub]'},
]);
});
@@ -378,7 +927,7 @@ test('Log all "verifyConditions" errors', async t => {
const error2 = new SemanticReleaseError('error 2', 'ERR2');
const error3 = new SemanticReleaseError('error 3', 'ERR3');
const fail = stub().resolves();
- const config = {branch: 'master', repositoryUrl, tagFormat: `v\${version}`};
+ const config = {branches: [{name: 'master'}], repositoryUrl, tagFormat: `v\${version}`};
const options = {
...config,
plugins: false,
@@ -422,7 +971,7 @@ test('Log all "verifyRelease" errors', async t => {
const error1 = new SemanticReleaseError('error 1', 'ERR1');
const error2 = new SemanticReleaseError('error 2', 'ERR2');
const fail = stub().resolves();
- const config = {branch: 'master', repositoryUrl, tagFormat: `v\${version}`};
+ const config = {branches: [{name: 'master'}], repositoryUrl, tagFormat: `v\${version}`};
const options = {
...config,
verifyConditions: stub().resolves(),
@@ -449,36 +998,37 @@ test('Log all "verifyRelease" errors', async t => {
t.deepEqual(fail.args[0][1].errors, [error1, error2]);
});
-test('Dry-run skips prepare, publish and success', async t => {
- // Create a git repository, set the current working directory at the root of the repo
+test('Dry-run skips addChannel, prepare, publish and success', async t => {
const {cwd, repositoryUrl} = await gitRepo(true);
- // Add commits to the master branch
await gitCommits(['First'], {cwd});
- // Create the tag corresponding to version 1.0.0
await gitTagVersion('v1.0.0', undefined, {cwd});
- // Add new commits to the master branch
+ await gitAddNote(JSON.stringify({channels: [null, 'next']}), 'v1.0.0', {cwd});
await gitCommits(['Second'], {cwd});
- await gitPush(repositoryUrl, 'master', {cwd});
+ await gitTagVersion('v1.1.0', undefined, {cwd});
+ await gitAddNote(JSON.stringify({channels: ['next']}), 'v1.1.0', {cwd});
- const nextRelease = {type: 'major', version: '2.0.0', gitHead: await getGitHead({cwd}), gitTag: 'v2.0.0'};
- const notes = 'Release notes';
+ await gitPush(repositoryUrl, 'master', {cwd});
+ await gitCheckout('next', true, {cwd});
+ await gitPush('origin', 'next', {cwd});
const verifyConditions = stub().resolves();
- const analyzeCommits = stub().resolves(nextRelease.type);
+ const analyzeCommits = stub().resolves('minor');
const verifyRelease = stub().resolves();
- const generateNotes = stub().resolves(notes);
+ const generateNotes = stub().resolves();
+ const addChannel = stub().resolves();
const prepare = stub().resolves();
const publish = stub().resolves();
const success = stub().resolves();
const options = {
dryRun: true,
- branch: 'master',
+ branches: ['master', 'next'],
repositoryUrl,
verifyConditions,
analyzeCommits,
verifyRelease,
generateNotes,
+ addChannel,
prepare,
publish,
success,
@@ -501,7 +1051,11 @@ test('Dry-run skips prepare, publish and success', async t => {
t.is(verifyConditions.callCount, 1);
t.is(analyzeCommits.callCount, 1);
t.is(verifyRelease.callCount, 1);
- t.is(generateNotes.callCount, 1);
+ t.is(generateNotes.callCount, 2);
+ t.is(addChannel.callCount, 0);
+ t.true(
+ t.context.warn.calledWith(`Skip step "addChannel" of plugin "[Function: ${addChannel.name}]" in dry-run mode`)
+ );
t.is(prepare.callCount, 0);
t.true(t.context.warn.calledWith(`Skip step "prepare" of plugin "[Function: ${prepare.name}]" in dry-run mode`));
t.is(publish.callCount, 0);
@@ -527,7 +1081,7 @@ test('Dry-run skips fail', async t => {
const options = {
dryRun: true,
- branch: 'master',
+ branches: ['master'],
repositoryUrl,
verifyConditions: [stub().rejects(error1), stub().rejects(error2)],
fail,
@@ -561,7 +1115,14 @@ test('Force a dry-run if not on a CI and "noCi" is not explicitly set', async t
await gitCommits(['Second'], {cwd});
await gitPush(repositoryUrl, 'master', {cwd});
- const nextRelease = {type: 'major', version: '2.0.0', gitHead: await getGitHead({cwd}), gitTag: 'v2.0.0'};
+ const nextRelease = {
+ name: 'v2.0.0',
+ type: 'major',
+ version: '2.0.0',
+ gitHead: await getGitHead({cwd}),
+ gitTag: 'v2.0.0',
+ channel: undefined,
+ };
const notes = 'Release notes';
const verifyConditions = stub().resolves();
@@ -573,12 +1134,13 @@ test('Force a dry-run if not on a CI and "noCi" is not explicitly set', async t
const options = {
dryRun: false,
- branch: 'master',
+ branches: ['master'],
repositoryUrl,
verifyConditions,
analyzeCommits,
verifyRelease,
generateNotes,
+ addChannel: stub().resolves(),
prepare: stub().resolves(),
publish,
success,
@@ -624,7 +1186,7 @@ test('Dry-run does not print changelog if "generateNotes" return "undefined"', a
const options = {
dryRun: true,
- branch: 'master',
+ branches: ['master'],
repositoryUrl,
verifyConditions: false,
analyzeCommits,
@@ -662,7 +1224,14 @@ test('Allow local releases with "noCi" option', async t => {
await gitCommits(['Second'], {cwd});
await gitPush(repositoryUrl, 'master', {cwd});
- const nextRelease = {type: 'major', version: '2.0.0', gitHead: await getGitHead({cwd}), gitTag: 'v2.0.0'};
+ const nextRelease = {
+ name: 'v2.0.0',
+ type: 'major',
+ version: '2.0.0',
+ gitHead: await getGitHead({cwd}),
+ gitTag: 'v2.0.0',
+ channel: undefined,
+ };
const notes = 'Release notes';
const verifyConditions = stub().resolves();
@@ -674,12 +1243,13 @@ test('Allow local releases with "noCi" option', async t => {
const options = {
noCi: true,
- branch: 'master',
+ branches: ['master'],
repositoryUrl,
verifyConditions,
analyzeCommits,
verifyRelease,
generateNotes,
+ addChannel: stub().resolves(),
prepare: stub().resolves(),
publish,
success,
@@ -712,34 +1282,44 @@ test('Allow local releases with "noCi" option', async t => {
t.is(success.callCount, 1);
});
-test('Accept "undefined" value returned by "generateNotes" and "false" by "publish"', async t => {
- // Create a git repository, set the current working directory at the root of the repo
+test('Accept "undefined" value returned by "generateNotes" and "false" by "publish" and "addChannel"', async t => {
const {cwd, repositoryUrl} = await gitRepo(true);
- // Add commits to the master branch
- let commits = await gitCommits(['First'], {cwd});
- // Create the tag corresponding to version 1.0.0
+ await gitCommits(['First'], {cwd});
await gitTagVersion('v1.0.0', undefined, {cwd});
- // Add new commits to the master branch
- commits = (await gitCommits(['Second'], {cwd})).concat(commits);
+ await gitAddNote(JSON.stringify({channels: [null, 'next']}), 'v1.0.0', {cwd});
+ await gitCommits(['Second'], {cwd});
+ await gitTagVersion('v1.1.0', undefined, {cwd});
+ await gitAddNote(JSON.stringify({channels: ['next']}), 'v1.1.0', {cwd});
await gitPush(repositoryUrl, 'master', {cwd});
-
- const lastRelease = {version: '1.0.0', gitHead: commits[commits.length - 1].hash, gitTag: 'v1.0.0'};
- const nextRelease = {type: 'major', version: '2.0.0', gitHead: await getGitHead({cwd}), gitTag: 'v2.0.0'};
+ await gitCheckout('next', true, {cwd});
+ await gitPush('origin', 'next', {cwd});
+ await gitCheckout('master', false, {cwd});
+
+ const nextRelease = {
+ name: 'v1.2.0',
+ type: 'minor',
+ version: '1.2.0',
+ gitHead: await getGitHead({cwd}),
+ gitTag: 'v1.2.0',
+ channel: null,
+ };
const analyzeCommits = stub().resolves(nextRelease.type);
const verifyRelease = stub().resolves();
const generateNotes1 = stub().resolves();
const notes2 = 'Release notes 2';
const generateNotes2 = stub().resolves(notes2);
const publish = stub().resolves(false);
+ const addChannel = stub().resolves(false);
const success = stub().resolves();
const options = {
- branch: 'master',
+ branches: ['master', 'next'],
repositoryUrl,
verifyConditions: stub().resolves(),
analyzeCommits,
verifyRelease,
generateNotes: [generateNotes1, generateNotes2],
+ addChannel,
prepare: stub().resolves(),
publish,
success,
@@ -760,23 +1340,15 @@ test('Accept "undefined" value returned by "generateNotes" and "false" by "publi
);
t.is(analyzeCommits.callCount, 1);
- t.deepEqual(analyzeCommits.args[0][1].lastRelease, lastRelease);
-
t.is(verifyRelease.callCount, 1);
- t.deepEqual(verifyRelease.args[0][1].lastRelease, lastRelease);
-
- t.is(generateNotes1.callCount, 1);
- t.deepEqual(generateNotes1.args[0][1].lastRelease, lastRelease);
-
- t.is(generateNotes2.callCount, 1);
- t.deepEqual(generateNotes2.args[0][1].lastRelease, lastRelease);
-
+ t.is(generateNotes1.callCount, 2);
+ t.is(generateNotes2.callCount, 2);
+ t.is(addChannel.callCount, 1);
t.is(publish.callCount, 1);
- t.deepEqual(publish.args[0][1].lastRelease, lastRelease);
- t.is(publish.args[0][1].nextRelease.notes, notes2);
-
- t.is(success.callCount, 1);
+ t.is(success.callCount, 2);
+ t.deepEqual(publish.args[0][1].nextRelease, {...nextRelease, notes: notes2});
t.deepEqual(success.args[0][1].releases, [{pluginName: '[Function: functionStub]'}]);
+ t.deepEqual(success.args[1][1].releases, [{pluginName: '[Function: functionStub]'}]);
});
test('Returns false if triggered by a PR', async t => {
@@ -800,7 +1372,180 @@ test('Returns false if triggered by a PR', async t => {
);
});
-test('Returns false if triggered on an outdated clone', async t => {
+test('Throws "EINVALIDNEXTVERSION" if next release is out of range of the current maintenance branch', async t => {
+ const {cwd, repositoryUrl} = await gitRepo(true);
+ await gitCommits(['feat: initial commit'], {cwd});
+ await gitTagVersion('v1.0.0', undefined, {cwd});
+ await gitAddNote(JSON.stringify({channels: [null, '1.x']}), 'v1.0.0', {cwd});
+ await gitCheckout('1.x', true, {cwd});
+ await gitPush('origin', '1.x', {cwd});
+ await gitCheckout('master', false, {cwd});
+ await gitCommits(['feat: new feature on master'], {cwd});
+ await gitTagVersion('v1.1.0', undefined, {cwd});
+ await gitCheckout('1.x', false, {cwd});
+ await gitCommits(['feat: feature on maintenance version 1.x'], {cwd});
+ await gitPush('origin', 'master', {cwd});
+
+ const verifyConditions = stub().resolves();
+ const verifyRelease = stub().resolves();
+ const addChannel = stub().resolves();
+ const prepare = stub().resolves();
+ const publish = stub().resolves();
+ const success = stub().resolves();
+
+ const config = {
+ branches: [{name: '1.x'}, {name: 'master'}],
+ repositoryUrl,
+ tagFormat: `v\${version}`,
+ };
+ const options = {
+ ...config,
+ verifyConditions,
+ verifyRelease,
+ addChannel,
+ prepare,
+ publish,
+ success,
+ };
+
+ const semanticRelease = proxyquire('..', {
+ './lib/logger': t.context.logger,
+ 'env-ci': () => ({isCi: true, branch: '1.x', isPr: false}),
+ });
+
+ const error = await t.throwsAsync(
+ semanticRelease(options, {cwd, env: {}, stdout: {write: () => {}}, stderr: {write: () => {}}})
+ );
+
+ t.is(error.code, 'EINVALIDNEXTVERSION');
+ t.is(error.name, 'SemanticReleaseError');
+ t.is(error.message, 'The release `1.1.0` on branch `1.x` cannot be published as it is out of range.');
+ t.regex(error.details, /A valid branch could be `master`./);
+});
+
+test('Throws "EINVALIDNEXTVERSION" if next release is out of range of the current release branch', async t => {
+ const {cwd, repositoryUrl} = await gitRepo(true);
+ await gitCommits(['feat: initial commit'], {cwd});
+ await gitTagVersion('v1.0.0', undefined, {cwd});
+ await gitCheckout('next', true, {cwd});
+ await gitCommits(['feat: new feature on next'], {cwd});
+ await gitTagVersion('v1.1.0', undefined, {cwd});
+ await gitAddNote(JSON.stringify({channels: ['next']}), 'v1.1.0', {cwd});
+ await gitPush('origin', 'next', {cwd});
+ await gitCheckout('next-major', true, {cwd});
+ await gitPush('origin', 'next-major', {cwd});
+ await gitCheckout('master', false, {cwd});
+ await gitCommits(['feat: new feature on master', 'fix: new fix on master'], {cwd});
+ await gitPush('origin', 'master', {cwd});
+
+ const verifyConditions = stub().resolves();
+ const verifyRelease = stub().resolves();
+ const addChannel = stub().resolves();
+ const prepare = stub().resolves();
+ const publish = stub().resolves();
+ const success = stub().resolves();
+
+ const config = {
+ branches: [{name: 'master'}, {name: 'next'}, {name: 'next-major'}],
+ repositoryUrl,
+ tagFormat: `v\${version}`,
+ };
+ const options = {
+ ...config,
+ verifyConditions,
+ verifyRelease,
+ addChannel,
+ prepare,
+ publish,
+ success,
+ };
+
+ const semanticRelease = proxyquire('..', {
+ './lib/logger': t.context.logger,
+ 'env-ci': () => ({isCi: true, branch: 'master', isPr: false}),
+ });
+
+ const error = await t.throwsAsync(
+ semanticRelease(options, {cwd, env: {}, stdout: {write: () => {}}, stderr: {write: () => {}}})
+ );
+
+ t.is(error.code, 'EINVALIDNEXTVERSION');
+ t.is(error.name, 'SemanticReleaseError');
+ t.is(error.message, 'The release `1.1.0` on branch `master` cannot be published as it is out of range.');
+ t.regex(error.details, /A valid branch could be `next` or `next-major`./);
+});
+
+test('Throws "EINVALIDMAINTENANCEMERGE" if merge an out of range release in a maintenance branch', async t => {
+ const {cwd, repositoryUrl} = await gitRepo(true);
+ await gitCommits(['First'], {cwd});
+ await gitTagVersion('v1.0.0', undefined, {cwd});
+ await gitAddNote(JSON.stringify({channels: [null, '1.1.x']}), 'v1.0.0', {cwd});
+ await gitCommits(['Second'], {cwd});
+ await gitTagVersion('v1.1.0', undefined, {cwd});
+ await gitAddNote(JSON.stringify({channels: [null, '1.1.x']}), 'v1.1.0', {cwd});
+ await gitCheckout('1.1.x', 'master', {cwd});
+ await gitPush('origin', '1.1.x', {cwd});
+ await gitCheckout('master', false, {cwd});
+ await gitCommits(['Third'], {cwd});
+ await gitTagVersion('v1.1.1', undefined, {cwd});
+ await gitCommits(['Fourth'], {cwd});
+ await gitTagVersion('v1.2.0', undefined, {cwd});
+ await gitPush('origin', 'master', {cwd});
+ await gitCheckout('1.1.x', false, {cwd});
+ await merge('master', {cwd});
+ await gitPush('origin', '1.1.x', {cwd});
+
+ const notes = 'Release notes';
+ const verifyConditions = stub().resolves();
+ const analyzeCommits = stub().resolves();
+ const verifyRelease = stub().resolves();
+ const generateNotes = stub().resolves(notes);
+ const addChannel = stub().resolves();
+ const prepare = stub().resolves();
+ const publish = stub().resolves();
+ const success = stub().resolves();
+ const fail = stub().resolves();
+
+ const config = {branches: [{name: 'master'}, {name: '1.1.x'}], repositoryUrl, tagFormat: `v\${version}`};
+ const options = {
+ ...config,
+ verifyConditions,
+ analyzeCommits,
+ verifyRelease,
+ addChannel,
+ generateNotes,
+ prepare,
+ publish,
+ success,
+ fail,
+ };
+
+ const semanticRelease = proxyquire('..', {
+ './lib/logger': t.context.logger,
+ 'env-ci': () => ({isCi: true, branch: '1.1.x', isPr: false}),
+ });
+ const errors = [
+ ...(await t.throwsAsync(
+ semanticRelease(options, {cwd, env: {}, stdout: {write: () => {}}, stderr: {write: () => {}}})
+ )),
+ ];
+
+ t.is(addChannel.callCount, 0);
+
+ t.is(publish.callCount, 0);
+
+ t.is(success.callCount, 0);
+
+ t.is(fail.callCount, 1);
+ t.deepEqual(fail.args[0][1].errors, errors);
+
+ t.is(errors[0].code, 'EINVALIDMAINTENANCEMERGE');
+ t.is(errors[0].name, 'SemanticReleaseError');
+ t.truthy(errors[0].message);
+ t.truthy(errors[0].details);
+});
+
+test('Returns false value if triggered on an outdated clone', async t => {
// Create a git repository, set the current working directory at the root of the repo
let {cwd, repositoryUrl} = await gitRepo(true);
const repoDir = cwd;
@@ -832,12 +1577,13 @@ test('Returns false if not running from the configured branch', async t => {
// Create a git repository, set the current working directory at the root of the repo
const {cwd, repositoryUrl} = await gitRepo(true);
const options = {
- branch: 'master',
+ branches: ['master'],
repositoryUrl,
verifyConditions: stub().resolves(),
analyzeCommits: stub().resolves(),
verifyRelease: stub().resolves(),
generateNotes: stub().resolves(),
+ addChannel: stub().resolves(),
prepare: stub().resolves(),
publish: stub().resolves(),
success: stub().resolves(),
@@ -876,12 +1622,13 @@ test('Returns false if there is no relevant changes', async t => {
const publish = stub().resolves();
const options = {
- branch: 'master',
+ branches: ['master'],
repositoryUrl,
verifyConditions: [stub().resolves()],
analyzeCommits,
verifyRelease,
generateNotes,
+ addChannel: stub().resolves(),
prepare: stub().resolves(),
publish,
success: stub().resolves(),
@@ -930,13 +1677,14 @@ test('Exclude commits with [skip release] or [release skip] from analysis', asyn
);
await gitPush(repositoryUrl, 'master', {cwd});
const analyzeCommits = stub().resolves();
- const config = {branch: 'master', repositoryUrl, globalOpt: 'global'};
+ const config = {branches: ['master'], repositoryUrl, globalOpt: 'global'};
const options = {
...config,
verifyConditions: [stub().resolves(), stub().resolves()],
analyzeCommits,
verifyRelease: stub().resolves(),
generateNotes: stub().resolves(),
+ addChannel: stub().resolves(),
prepare: stub().resolves(),
publish: stub().resolves(),
success: stub().resolves(),
@@ -966,7 +1714,7 @@ test('Log both plugins errors and errors thrown by "fail" plugin', async t => {
const failError2 = new Error('Fail error 2');
const options = {
- branch: 'master',
+ branches: ['master'],
repositoryUrl,
verifyConditions: stub().rejects(pluginError),
fail: [stub().rejects(failError1), stub().rejects(failError2)],
@@ -991,7 +1739,7 @@ test('Call "fail" only if a plugin returns a SemanticReleaseError', async t => {
const fail = stub().resolves();
const options = {
- branch: 'master',
+ branches: ['master'],
repositoryUrl,
verifyConditions: stub().rejects(pluginError),
fail,
@@ -1026,6 +1774,8 @@ test('Throw SemanticReleaseError if repositoryUrl is not set and cannot be found
// Verify error code and type
t.is(errors[0].code, 'ENOREPOURL');
t.is(errors[0].name, 'SemanticReleaseError');
+ t.truthy(errors[0].message);
+ t.truthy(errors[0].details);
});
test('Throw an Error if plugin returns an unexpected value', async t => {
@@ -1043,7 +1793,7 @@ test('Throw an Error if plugin returns an unexpected value', async t => {
const analyzeCommits = stub().resolves('string');
const options = {
- branch: 'master',
+ branches: ['master'],
repositoryUrl,
verifyConditions: [verifyConditions],
analyzeCommits,
@@ -1122,6 +1872,7 @@ test('Hide sensitive information passed to "success" plugin', async t => {
name: `Name: Exposing token ${env.MY_TOKEN}`,
url: `URL: Exposing token ${env.MY_TOKEN}`,
}),
+ addChannel: false,
success,
fail: stub().resolves(),
};
@@ -1152,11 +1903,18 @@ test('Get all commits including the ones not in the shallow clone', async t => {
cwd = await gitShallowClone(repositoryUrl);
- const nextRelease = {type: 'major', version: '2.0.0', gitHead: await getGitHead({cwd}), gitTag: 'v2.0.0'};
+ const nextRelease = {
+ name: 'v2.0.0',
+ type: 'major',
+ version: '2.0.0',
+ gitHead: await getGitHead({cwd}),
+ gitTag: 'v2.0.0',
+ channel: undefined,
+ };
const notes = 'Release notes';
const analyzeCommits = stub().resolves(nextRelease.type);
- const config = {branch: 'master', repositoryUrl, globalOpt: 'global'};
+ const config = {branches: ['master'], repositoryUrl, globalOpt: 'global'};
const options = {
...config,
verifyConditions: stub().resolves(),
diff --git a/test/integration.test.js b/test/integration.test.js
index 2a0daab884..8840a1888e 100644
--- a/test/integration.test.js
+++ b/test/integration.test.js
@@ -5,8 +5,20 @@ import {escapeRegExp} from 'lodash';
import {writeJson, readJson} from 'fs-extra';
import execa from 'execa';
import {WritableStreamBuffer} from 'stream-buffers';
+import delay from 'delay';
import {SECRET_REPLACEMENT} from '../lib/definitions/constants';
-import {gitHead, gitTagHead, gitRepo, gitCommits, gitRemoteTagHead, gitPush} from './helpers/git-utils';
+import {
+ gitHead,
+ gitTagHead,
+ gitRepo,
+ gitCommits,
+ gitRemoteTagHead,
+ gitPush,
+ gitCheckout,
+ merge,
+ gitGetNote,
+} from './helpers/git-utils';
+import {npmView} from './helpers/npm-utils';
import gitbox from './helpers/gitbox';
import mockServer from './helpers/mockserver';
import npmRegistry from './helpers/npm-registry';
@@ -58,7 +70,7 @@ test('Release patch, minor and major versions', async t => {
version: '0.0.0-dev',
repository: {url: repositoryUrl},
publishConfig: {registry: npmRegistry.url},
- release: {success: false, fail: false},
+ release: {branches: ['master', 'next'], success: false, fail: false},
});
// Create a npm-shrinkwrap.json file
await execa('npm', ['shrinkwrap'], {env: testEnv, cwd});
@@ -86,7 +98,7 @@ test('Release patch, minor and major versions', async t => {
let createReleaseMock = await mockServer.mock(
`/repos/${owner}/${packageName}/releases`,
{
- body: {tag_name: `v${version}`, target_commitish: 'master', name: `v${version}`},
+ body: {tag_name: `v${version}`, name: `v${version}`},
headers: [{name: 'Authorization', values: [`token ${env.GH_TOKEN}`]}],
},
{body: {html_url: `release-url/${version}`}}
@@ -105,15 +117,14 @@ test('Release patch, minor and major versions', async t => {
t.is((await readJson(path.resolve(cwd, 'npm-shrinkwrap.json'))).version, version);
// Retrieve the published package from the registry and check version and gitHead
- let [, releasedVersion, releasedGitHead] = /^version = '(.+)'\s+gitHead = '(.+)'$/.exec(
- (await execa('npm', ['show', packageName, 'version', 'gitHead'], {env: testEnv, cwd})).stdout
- );
+ let {
+ 'dist-tags': {latest: releasedVersion},
+ } = await npmView(packageName, testEnv);
let head = await gitHead({cwd});
t.is(releasedVersion, version);
- t.is(releasedGitHead, head);
t.is(await gitTagHead(`v${version}`, {cwd}), head);
t.is(await gitRemoteTagHead(authUrl, `v${version}`, {cwd}), head);
- t.log(`+ released ${releasedVersion} with head ${releasedGitHead}`);
+ t.log(`+ released ${releasedVersion}`);
await mockServer.verify(verifyMock);
await mockServer.verify(createReleaseMock);
@@ -128,7 +139,7 @@ test('Release patch, minor and major versions', async t => {
createReleaseMock = await mockServer.mock(
`/repos/${owner}/${packageName}/releases`,
{
- body: {tag_name: `v${version}`, target_commitish: 'master', name: `v${version}`},
+ body: {tag_name: `v${version}`, name: `v${version}`},
headers: [{name: 'Authorization', values: [`token ${env.GH_TOKEN}`]}],
},
{body: {html_url: `release-url/${version}`}}
@@ -147,15 +158,14 @@ test('Release patch, minor and major versions', async t => {
t.is((await readJson(path.resolve(cwd, 'npm-shrinkwrap.json'))).version, version);
// Retrieve the published package from the registry and check version and gitHead
- [, releasedVersion, releasedGitHead] = /^version = '(.+)'\s+gitHead = '(.+)'$/.exec(
- (await execa('npm', ['show', packageName, 'version', 'gitHead'], {env: testEnv, cwd})).stdout
- );
+ ({
+ 'dist-tags': {latest: releasedVersion},
+ } = await npmView(packageName, testEnv));
head = await gitHead({cwd});
t.is(releasedVersion, version);
- t.is(releasedGitHead, head);
t.is(await gitTagHead(`v${version}`, {cwd}), head);
t.is(await gitRemoteTagHead(authUrl, `v${version}`, {cwd}), head);
- t.log(`+ released ${releasedVersion} with head ${releasedGitHead}`);
+ t.log(`+ released ${releasedVersion}`);
await mockServer.verify(verifyMock);
await mockServer.verify(createReleaseMock);
@@ -170,7 +180,7 @@ test('Release patch, minor and major versions', async t => {
createReleaseMock = await mockServer.mock(
`/repos/${owner}/${packageName}/releases`,
{
- body: {tag_name: `v${version}`, target_commitish: 'master', name: `v${version}`},
+ body: {tag_name: `v${version}`, name: `v${version}`},
headers: [{name: 'Authorization', values: [`token ${env.GH_TOKEN}`]}],
},
{body: {html_url: `release-url/${version}`}}
@@ -189,20 +199,19 @@ test('Release patch, minor and major versions', async t => {
t.is((await readJson(path.resolve(cwd, 'npm-shrinkwrap.json'))).version, version);
// Retrieve the published package from the registry and check version and gitHead
- [, releasedVersion, releasedGitHead] = /^version = '(.+)'\s+gitHead = '(.+)'$/.exec(
- (await execa('npm', ['show', packageName, 'version', 'gitHead'], {env: testEnv, cwd})).stdout
- );
+ ({
+ 'dist-tags': {latest: releasedVersion},
+ } = await npmView(packageName, testEnv));
head = await gitHead({cwd});
t.is(releasedVersion, version);
- t.is(releasedGitHead, head);
t.is(await gitTagHead(`v${version}`, {cwd}), head);
t.is(await gitRemoteTagHead(authUrl, `v${version}`, {cwd}), head);
- t.log(`+ released ${releasedVersion} with head ${releasedGitHead}`);
+ t.log(`+ released ${releasedVersion}`);
await mockServer.verify(verifyMock);
await mockServer.verify(createReleaseMock);
- /* Major release */
+ /* Major release on next */
version = '2.0.0';
verifyMock = await mockServer.mock(
`/repos/${owner}/${packageName}`,
@@ -212,16 +221,18 @@ test('Release patch, minor and major versions', async t => {
createReleaseMock = await mockServer.mock(
`/repos/${owner}/${packageName}/releases`,
{
- body: {tag_name: `v${version}`, target_commitish: 'master', name: `v${version}`},
+ body: {tag_name: `v${version}`, name: `v${version}`},
headers: [{name: 'Authorization', values: [`token ${env.GH_TOKEN}`]}],
},
{body: {html_url: `release-url/${version}`}}
);
- t.log('Commit a breaking change');
+ t.log('Commit a breaking change on next');
+ await gitCheckout('next', true, {cwd});
+ await gitPush('origin', 'next', {cwd});
await gitCommits(['feat: foo\n\n BREAKING CHANGE: bar'], {cwd});
t.log('$ semantic-release');
- ({stdout, exitCode} = await execa(cli, [], {env, cwd}));
+ ({stdout, exitCode} = await execa(cli, [], {env: {...env, TRAVIS_BRANCH: 'next'}, cwd}));
t.regex(stdout, new RegExp(`Published GitHub release: release-url/${version}`));
t.regex(stdout, new RegExp(`Publishing version ${version} to npm registry`));
t.is(exitCode, 0);
@@ -231,18 +242,66 @@ test('Release patch, minor and major versions', async t => {
t.is((await readJson(path.resolve(cwd, 'npm-shrinkwrap.json'))).version, version);
// Retrieve the published package from the registry and check version and gitHead
- [, releasedVersion, releasedGitHead] = /^version = '(.+)'\s+gitHead = '(.+)'$/.exec(
- (await execa('npm', ['show', packageName, 'version', 'gitHead'], {env: testEnv, cwd})).stdout
- );
+ ({
+ 'dist-tags': {next: releasedVersion},
+ } = await npmView(packageName, testEnv));
head = await gitHead({cwd});
t.is(releasedVersion, version);
- t.is(releasedGitHead, head);
+ t.is(await gitGetNote(`v${version}`, {cwd}), '{"channels":["next"]}');
t.is(await gitTagHead(`v${version}`, {cwd}), head);
t.is(await gitRemoteTagHead(authUrl, `v${version}`, {cwd}), head);
- t.log(`+ released ${releasedVersion} with head ${releasedGitHead}`);
+ t.log(`+ released ${releasedVersion} on @next`);
await mockServer.verify(verifyMock);
await mockServer.verify(createReleaseMock);
+
+ /* Merge next into master */
+ version = '2.0.0';
+ const releaseId = 1;
+ verifyMock = await mockServer.mock(
+ `/repos/${owner}/${packageName}`,
+ {headers: [{name: 'Authorization', values: [`token ${env.GH_TOKEN}`]}]},
+ {body: {permissions: {push: true}}, method: 'GET'}
+ );
+ const getReleaseMock = await mockServer.mock(
+ `/repos/${owner}/${packageName}/releases/tags/v2.0.0`,
+ {headers: [{name: 'Authorization', values: [`token ${env.GH_TOKEN}`]}]},
+ {body: {id: releaseId}, method: 'GET'}
+ );
+ const updateReleaseMock = await mockServer.mock(
+ `/repos/${owner}/${packageName}/releases/${releaseId}`,
+ {
+ body: {name: `v${version}`, prerelease: false},
+ headers: [{name: 'Authorization', values: [`token ${env.GH_TOKEN}`]}],
+ },
+ {body: {html_url: `release-url/${version}`}, method: 'PATCH'}
+ );
+
+ t.log('Merge next into master');
+ await gitCheckout('master', false, {cwd});
+ await merge('next', {cwd});
+ await gitPush('origin', 'master', {cwd});
+ t.log('$ semantic-release');
+ ({stdout, exitCode} = await execa(cli, [], {env, cwd}));
+ t.regex(stdout, new RegExp(`Updated GitHub release: release-url/${version}`));
+ t.regex(stdout, new RegExp(`Adding version ${version} to npm registry on dist-tag latest`));
+ t.is(exitCode, 0);
+
+ // Wait for 3s as the change of dist-tag takes time to be reflected in the registry
+ await delay(3000);
+ // Retrieve the published package from the registry and check version and gitHead
+ ({
+ 'dist-tags': {latest: releasedVersion},
+ } = await npmView(packageName, testEnv));
+ t.is(releasedVersion, version);
+ t.is(await gitGetNote(`v${version}`, {cwd}), '{"channels":["next",null]}');
+ t.is(await gitTagHead(`v${version}`, {cwd}), await gitTagHead(`v${version}`, {cwd}));
+ t.is(await gitRemoteTagHead(authUrl, `v${version}`, {cwd}), await gitRemoteTagHead(authUrl, `v${version}`, {cwd}));
+ t.log(`+ added ${releasedVersion}`);
+
+ await mockServer.verify(verifyMock);
+ await mockServer.verify(getReleaseMock);
+ await mockServer.verify(updateReleaseMock);
});
test('Exit with 1 if a plugin is not found', async t => {
@@ -366,7 +425,7 @@ test('Allow local releases with "noCi" option', async t => {
const createReleaseMock = await mockServer.mock(
`/repos/${owner}/${packageName}/releases`,
{
- body: {tag_name: `v${version}`, target_commitish: 'master', name: `v${version}`},
+ body: {tag_name: `v${version}`, name: `v${version}`},
headers: [{name: 'Authorization', values: [`token ${env.GH_TOKEN}`]}],
},
{body: {html_url: `release-url/${version}`}}
@@ -384,9 +443,7 @@ test('Allow local releases with "noCi" option', async t => {
t.is((await readJson(path.resolve(cwd, 'package.json'))).version, version);
// Retrieve the published package from the registry and check version and gitHead
- const [, releasedVersion, releasedGitHead] = /^version = '(.+)'\s+gitHead = '(.+)'$/.exec(
- (await execa('npm', ['show', packageName, 'version', 'gitHead'], {env: testEnv, cwd})).stdout
- );
+ const {version: releasedVersion, gitHead: releasedGitHead} = await npmView(packageName, testEnv);
const head = await gitHead({cwd});
t.is(releasedVersion, version);
@@ -439,9 +496,7 @@ test('Pass options via CLI arguments', async t => {
t.is((await readJson(path.resolve(cwd, 'package.json'))).version, version);
// Retrieve the published package from the registry and check version and gitHead
- const [, releasedVersion, releasedGitHead] = /^version = '(.+)'\s+gitHead = '(.+)'$/.exec(
- (await execa('npm', ['show', packageName, 'version', 'gitHead'], {env: testEnv, cwd})).stdout
- );
+ const {version: releasedVersion, gitHead: releasedGitHead} = await npmView(packageName, testEnv);
const head = await gitHead({cwd});
t.is(releasedVersion, version);
t.is(releasedGitHead, head);
@@ -482,7 +537,7 @@ test('Run via JS API', async t => {
const createReleaseMock = await mockServer.mock(
`/repos/${owner}/${packageName}/releases`,
{
- body: {tag_name: `v${version}`, target_commitish: 'master', name: `v${version}`},
+ body: {tag_name: `v${version}`, name: `v${version}`},
headers: [{name: 'Authorization', values: [`token ${env.GH_TOKEN}`]}],
},
{body: {html_url: `release-url/${version}`}}
@@ -497,9 +552,7 @@ test('Run via JS API', async t => {
t.is((await readJson(path.resolve(cwd, 'package.json'))).version, version);
// Retrieve the published package from the registry and check version and gitHead
- const [, releasedVersion, releasedGitHead] = /^version = '(.+)'\s+gitHead = '(.+)'$/.exec(
- (await execa('npm', ['show', packageName, 'version', 'gitHead'], {env: testEnv, cwd})).stdout
- );
+ const {version: releasedVersion, gitHead: releasedGitHead} = await npmView(packageName, testEnv);
const head = await gitHead({cwd});
t.is(releasedVersion, version);
t.is(releasedGitHead, head);
diff --git a/test/plugins/normalize.test.js b/test/plugins/normalize.test.js
index 97ebbcddbb..dd93467ed5 100644
--- a/test/plugins/normalize.test.js
+++ b/test/plugins/normalize.test.js
@@ -152,6 +152,24 @@ test('Wrap "publish" plugin in a function that validate the output of the plugin
t.regex(error.details, /2/);
});
+test('Wrap "addChannel" plugin in a function that validate the output of the plugin', async t => {
+ const addChannel = stub().resolves(2);
+ const plugin = normalize(
+ {cwd, options: {}, stderr: t.context.stderr, logger: t.context.logger},
+ 'addChannel',
+ addChannel,
+ {}
+ );
+
+ const error = await t.throwsAsync(plugin({options: {}}));
+
+ t.is(error.code, 'EADDCHANNELOUTPUT');
+ t.is(error.name, 'SemanticReleaseError');
+ t.truthy(error.message);
+ t.truthy(error.details);
+ t.regex(error.details, /2/);
+});
+
test('Plugin is called with "pluginConfig" (with object definition) and input', async t => {
const pluginFunction = stub().resolves();
const pluginConf = {path: pluginFunction, conf: 'confValue'};
diff --git a/test/utils.test.js b/test/utils.test.js
new file mode 100644
index 0000000000..dd05a04907
--- /dev/null
+++ b/test/utils.test.js
@@ -0,0 +1,186 @@
+import test from 'ava';
+import AggregateError from 'aggregate-error';
+import {
+ extractErrors,
+ tagsToVersions,
+ isMajorRange,
+ isMaintenanceRange,
+ getUpperBound,
+ getLowerBound,
+ highest,
+ lowest,
+ getLatestVersion,
+ getEarliestVersion,
+ getFirstVersion,
+ getRange,
+ makeTag,
+ isSameChannel,
+} from '../lib/utils';
+
+test('extractErrors', t => {
+ const errors = [new Error('Error 1'), new Error('Error 2')];
+
+ t.deepEqual(extractErrors(new AggregateError(errors)), errors);
+ t.deepEqual(extractErrors(errors[0]), [errors[0]]);
+});
+
+test('tagsToVersions', t => {
+ t.deepEqual(tagsToVersions([{version: '1.0.0'}, {version: '1.1.0'}, {version: '1.2.0'}]), [
+ '1.0.0',
+ '1.1.0',
+ '1.2.0',
+ ]);
+});
+
+test('isMajorRange', t => {
+ t.false(isMajorRange('1.1.x'));
+ t.false(isMajorRange('1.11.x'));
+ t.false(isMajorRange('11.1.x'));
+ t.false(isMajorRange('11.11.x'));
+ t.false(isMajorRange('1.1.X'));
+ t.false(isMajorRange('1.1.0'));
+
+ t.true(isMajorRange('1.x.x'));
+ t.true(isMajorRange('11.x.x'));
+ t.true(isMajorRange('1.X.X'));
+ t.true(isMajorRange('1.x'));
+ t.true(isMajorRange('11.x'));
+ t.true(isMajorRange('1.X'));
+});
+
+test('isMaintenanceRange', t => {
+ t.true(isMaintenanceRange('1.1.x'));
+ t.true(isMaintenanceRange('11.1.x'));
+ t.true(isMaintenanceRange('11.11.x'));
+ t.true(isMaintenanceRange('1.11.x'));
+ t.true(isMaintenanceRange('1.x.x'));
+ t.true(isMaintenanceRange('11.x.x'));
+ t.true(isMaintenanceRange('1.x'));
+ t.true(isMaintenanceRange('11.x'));
+ t.true(isMaintenanceRange('1.1.X'));
+ t.true(isMaintenanceRange('1.X.X'));
+ t.true(isMaintenanceRange('1.X'));
+
+ t.false(isMaintenanceRange('1.1.0'));
+ t.false(isMaintenanceRange('11.1.0'));
+ t.false(isMaintenanceRange('1.11.0'));
+ t.false(isMaintenanceRange('11.11.0'));
+ t.false(isMaintenanceRange('~1.0.0'));
+ t.false(isMaintenanceRange('^1.0.0'));
+});
+
+test('getUpperBound', t => {
+ t.is(getUpperBound('1.x.x'), '2.0.0');
+ t.is(getUpperBound('1.X.X'), '2.0.0');
+ t.is(getUpperBound('10.x.x'), '11.0.0');
+ t.is(getUpperBound('1.x'), '2.0.0');
+ t.is(getUpperBound('10.x'), '11.0.0');
+ t.is(getUpperBound('1.0.x'), '1.1.0');
+ t.is(getUpperBound('10.0.x'), '10.1.0');
+ t.is(getUpperBound('10.10.x'), '10.11.0');
+ t.is(getUpperBound('1.0.0'), '1.0.0');
+ t.is(getUpperBound('10.0.0'), '10.0.0');
+
+ t.is(getUpperBound('foo'), undefined);
+});
+
+test('getLowerBound', t => {
+ t.is(getLowerBound('1.x.x'), '1.0.0');
+ t.is(getLowerBound('1.X.X'), '1.0.0');
+ t.is(getLowerBound('10.x.x'), '10.0.0');
+ t.is(getLowerBound('1.x'), '1.0.0');
+ t.is(getLowerBound('10.x'), '10.0.0');
+ t.is(getLowerBound('1.0.x'), '1.0.0');
+ t.is(getLowerBound('10.0.x'), '10.0.0');
+ t.is(getLowerBound('1.10.x'), '1.10.0');
+ t.is(getLowerBound('1.0.0'), '1.0.0');
+ t.is(getLowerBound('10.0.0'), '10.0.0');
+
+ t.is(getLowerBound('foo'), undefined);
+});
+
+test('highest', t => {
+ t.is(highest('1.0.0', '2.0.0'), '2.0.0');
+ t.is(highest('1.1.1', '1.1.0'), '1.1.1');
+ t.is(highest(null, '1.0.0'), '1.0.0');
+ t.is(highest('1.0.0'), '1.0.0');
+ t.is(highest(), undefined);
+});
+
+test('lowest', t => {
+ t.is(lowest('1.0.0', '2.0.0'), '1.0.0');
+ t.is(lowest('1.1.1', '1.1.0'), '1.1.0');
+ t.is(lowest(null, '1.0.0'), '1.0.0');
+ t.is(lowest(), undefined);
+});
+
+test.serial('getLatestVersion', t => {
+ t.is(getLatestVersion(['1.2.3-alpha.3', '1.2.0', '1.0.1', '1.0.0-alpha.1']), '1.2.0');
+ t.is(getLatestVersion(['1.2.3-alpha.3', '1.2.3-alpha.2']), undefined);
+
+ t.is(getLatestVersion(['1.2.3-alpha.3', '1.2.0', '1.0.1', '1.0.0-alpha.1']), '1.2.0');
+ t.is(getLatestVersion(['1.2.3-alpha.3', '1.2.3-alpha.2']), undefined);
+
+ t.is(getLatestVersion(['1.2.3-alpha.3', '1.2.0', '1.0.1', '1.0.0-alpha.1'], {withPrerelease: true}), '1.2.3-alpha.3');
+ t.is(getLatestVersion(['1.2.3-alpha.3', '1.2.3-alpha.2'], {withPrerelease: true}), '1.2.3-alpha.3');
+
+ t.is(getLatestVersion([]), undefined);
+});
+
+test.serial('getEarliestVersion', t => {
+ t.is(getEarliestVersion(['1.2.3-alpha.3', '1.2.0', '1.0.0', '1.0.1-alpha.1']), '1.0.0');
+ t.is(getEarliestVersion(['1.2.3-alpha.3', '1.2.3-alpha.2']), undefined);
+
+ t.is(getEarliestVersion(['1.2.3-alpha.3', '1.2.0', '1.0.0', '1.0.1-alpha.1']), '1.0.0');
+ t.is(getEarliestVersion(['1.2.3-alpha.3', '1.2.3-alpha.2']), undefined);
+
+ t.is(
+ getEarliestVersion(['1.2.3-alpha.3', '1.2.0', '1.0.1', '1.0.0-alpha.1'], {withPrerelease: true}),
+ '1.0.0-alpha.1'
+ );
+ t.is(getEarliestVersion(['1.2.3-alpha.3', '1.2.3-alpha.2'], {withPrerelease: true}), '1.2.3-alpha.2');
+
+ t.is(getEarliestVersion([]), undefined);
+});
+
+test('getFirstVersion', t => {
+ t.is(getFirstVersion(['1.2.0', '1.0.0', '1.3.0', '1.1.0', '1.4.0'], []), '1.0.0');
+ t.is(
+ getFirstVersion(
+ ['1.2.0', '1.0.0', '1.3.0', '1.1.0', '1.4.0'],
+ [
+ {name: 'master', tags: [{version: '1.0.0'}, {version: '1.1.0'}]},
+ {name: 'next', tags: [{version: '1.0.0'}, {version: '1.1.0'}, {version: '1.2.0'}]},
+ ]
+ ),
+ '1.3.0'
+ );
+ t.is(
+ getFirstVersion(
+ ['1.2.0', '1.0.0', '1.1.0'],
+ [
+ {name: 'master', tags: [{version: '1.0.0'}, {version: '1.1.0'}]},
+ {name: 'next', tags: [{version: '1.0.0'}, {version: '1.1.0'}, {version: '1.2.0'}]},
+ ]
+ ),
+ undefined
+ );
+});
+
+test('getRange', t => {
+ t.is(getRange('1.0.0', '1.1.0'), '>=1.0.0 <1.1.0');
+ t.is(getRange('1.0.0'), '>=1.0.0');
+});
+
+test('makeTag', t => {
+ t.is(makeTag(`v\${version}`, '1.0.0'), 'v1.0.0');
+});
+
+test('isSameChannel', t => {
+ t.true(isSameChannel('next', 'next'));
+ t.true(isSameChannel(null, undefined));
+ t.true(isSameChannel(false, undefined));
+ t.true(isSameChannel('', false));
+
+ t.false(isSameChannel('next', false));
+});
diff --git a/test/verify.test.js b/test/verify.test.js
index 034252d23a..09d882850d 100644
--- a/test/verify.test.js
+++ b/test/verify.test.js
@@ -5,7 +5,7 @@ import {gitRepo} from './helpers/git-utils';
test('Throw a AggregateError', async t => {
const {cwd} = await gitRepo();
- const options = {};
+ const options = {branches: [{name: 'master'}, {name: ''}]};
const errors = [...(await t.throwsAsync(verify({cwd, options})))];
@@ -21,11 +21,15 @@ test('Throw a AggregateError', async t => {
t.is(errors[2].code, 'ETAGNOVERSION');
t.truthy(errors[2].message);
t.truthy(errors[2].details);
+ t.is(errors[3].name, 'SemanticReleaseError');
+ t.is(errors[3].code, 'EINVALIDBRANCH');
+ t.truthy(errors[3].message);
+ t.truthy(errors[3].details);
});
test('Throw a SemanticReleaseError if does not run on a git repository', async t => {
const cwd = tempy.directory();
- const options = {};
+ const options = {branches: []};
const errors = [...(await t.throwsAsync(verify({cwd, options})))];
@@ -37,7 +41,7 @@ test('Throw a SemanticReleaseError if does not run on a git repository', async t
test('Throw a SemanticReleaseError if the "tagFormat" is not valid', async t => {
const {cwd, repositoryUrl} = await gitRepo(true);
- const options = {repositoryUrl, tagFormat: `?\${version}`};
+ const options = {repositoryUrl, tagFormat: `?\${version}`, branches: []};
const errors = [...(await t.throwsAsync(verify({cwd, options})))];
@@ -49,7 +53,7 @@ test('Throw a SemanticReleaseError if the "tagFormat" is not valid', async t =>
test('Throw a SemanticReleaseError if the "tagFormat" does not contains the "version" variable', async t => {
const {cwd, repositoryUrl} = await gitRepo(true);
- const options = {repositoryUrl, tagFormat: 'test'};
+ const options = {repositoryUrl, tagFormat: 'test', branches: []};
const errors = [...(await t.throwsAsync(verify({cwd, options})))];
@@ -61,7 +65,7 @@ test('Throw a SemanticReleaseError if the "tagFormat" does not contains the "ver
test('Throw a SemanticReleaseError if the "tagFormat" contains multiple "version" variables', async t => {
const {cwd, repositoryUrl} = await gitRepo(true);
- const options = {repositoryUrl, tagFormat: `\${version}v\${version}`};
+ const options = {repositoryUrl, tagFormat: `\${version}v\${version}`, branches: []};
const errors = [...(await t.throwsAsync(verify({cwd, options})))];
@@ -71,9 +75,43 @@ test('Throw a SemanticReleaseError if the "tagFormat" contains multiple "version
t.truthy(errors[0].details);
});
+test('Throw a SemanticReleaseError for each invalid branch', async t => {
+ const {cwd, repositoryUrl} = await gitRepo(true);
+ const options = {
+ repositoryUrl,
+ tagFormat: `v\${version}`,
+ branches: [{name: ''}, {name: ' '}, {name: 1}, {}, {name: ''}, 1, 'master'],
+ };
+
+ const errors = [...(await t.throwsAsync(verify({cwd, options})))];
+
+ t.is(errors[0].name, 'SemanticReleaseError');
+ t.is(errors[0].code, 'EINVALIDBRANCH');
+ t.truthy(errors[0].message);
+ t.truthy(errors[0].details);
+ t.is(errors[1].name, 'SemanticReleaseError');
+ t.is(errors[1].code, 'EINVALIDBRANCH');
+ t.truthy(errors[1].message);
+ t.truthy(errors[1].details);
+ t.is(errors[2].name, 'SemanticReleaseError');
+ t.is(errors[2].code, 'EINVALIDBRANCH');
+ t.truthy(errors[2].message);
+ t.truthy(errors[2].details);
+ t.is(errors[3].name, 'SemanticReleaseError');
+ t.is(errors[3].code, 'EINVALIDBRANCH');
+ t.truthy(errors[3].message);
+ t.truthy(errors[3].details);
+ t.is(errors[4].code, 'EINVALIDBRANCH');
+ t.truthy(errors[4].message);
+ t.truthy(errors[4].details);
+ t.is(errors[5].code, 'EINVALIDBRANCH');
+ t.truthy(errors[5].message);
+ t.truthy(errors[5].details);
+});
+
test('Return "true" if all verification pass', async t => {
const {cwd, repositoryUrl} = await gitRepo(true);
- const options = {repositoryUrl, tagFormat: `v\${version}`};
+ const options = {repositoryUrl, tagFormat: `v\${version}`, branches: [{name: 'master'}]};
await t.notThrowsAsync(verify({cwd, options}));
});
+
**semantic-release** automates the whole package release workflow including: determining the next version number, generating the release notes and publishing the package.
@@ -39,6 +42,7 @@ This removes the immediate connection between human emotions and version numbers
- 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
+- Publish on different distribution channels (such as [npm dist-tags](https://docs.npmjs.com/cli/dist-tag)) based on git merges
- 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)
@@ -68,11 +72,12 @@ Here is an example of the release type that will be done based on a commit messa
### 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.
+For each new commits added to one of the release branches (for example `master`, `next`, `beta`), 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.
+**semantic-release** offers various ways to control the timing, the content and the audience of published releases. See example workflows in the following recipes:
+- [Using distribution channels](docs/recipes/distribution-channels.md#publishing-on-distribution-channels)
+- [Maintenance releases](docs/recipes/maintenance-releases.md#publishing-maintenance-releases)
+- [Pre-releases](docs/recipes/pre-releases.md#publishing-pre-releases)
### Release steps
@@ -90,6 +95,14 @@ After running the tests, the command `semantic-release` will execute the followi
| Publish | Publish the release. |
| Notify | Notify of new releases or errors. |
+## Requirements
+
+In order to use **semantic-release** you need:
+- To host your code in a [Git repository](https://git-scm.com)
+- Use a Continuous Integration service that allows you to [securely set up credentials](docs/usage/ci-configuration.md#authentication)
+- Git CLI version [2.7.1 or higher](docs/support/FAQ.md#why-does-semantic-release-require-git-version--271) installed in your Continuous Integration environment
+- [Node.js](https://nodejs.org) version [8.16.0 or higher](docs/support/FAQ.md#why-does-semantic-release-require-node-version--816) installed in your Continuous Integration environment
+
## Documentation
- Usage
@@ -98,14 +111,16 @@ After running the tests, the command `semantic-release` will execute the followi
- [CI Configuration](docs/usage/ci-configuration.md#ci-configuration)
- [Configuration](docs/usage/configuration.md#configuration)
- [Plugins](docs/usage/plugins.md)
+ - [Workflow configuration](docs/usage/workflow-configuration.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#ci-configurations)
- - [Git hosted services](docs/recipes/README.md#git-hosted-services)
- - [Package managers and languages](docs/recipes/README.md#package-managers-and-languages)
+ - [CI configurations](docs/recipes/README.md)
+ - [Git hosted services](docs/recipes/README.md)
+ - [Release workflow](docs/recipes/README.md)
+ - [Package managers and languages](docs/recipes/README.md)
- Developer guide
- [JavaScript API](docs/developer-guide/js-api.md)
- [Plugins development](docs/developer-guide/plugin.md)
diff --git a/SUMMARY.md b/SUMMARY.md
index e6ce15b072..a28efb45a1 100644
--- a/SUMMARY.md
+++ b/SUMMARY.md
@@ -6,6 +6,7 @@
- [CI Configuration](docs/usage/ci-configuration.md#ci-configuration)
- [Configuration](docs/usage/configuration.md#configuration)
- [Plugins](docs/usage/plugins.md)
+- [Workflow configuration](docs/usage/workflow-configuration.md)
- [Shareable configurations](docs/usage/shareable-configurations.md)
## Extending
diff --git a/bin/semantic-release.js b/bin/semantic-release.js
index 12dd2b56b6..8cfbaadaa0 100755
--- a/bin/semantic-release.js
+++ b/bin/semantic-release.js
@@ -10,7 +10,7 @@ var execa = require('execa');
var findVersions = require('find-versions');
var pkg = require('../package.json');
-var MIN_GIT_VERSION = '2.0.0';
+var MIN_GIT_VERSION = '2.7.1';
if (!semver.satisfies(process.version, pkg.engines.node)) {
console.error(
@@ -35,7 +35,7 @@ execa('git', ['--version'])
process.exit(1);
});
-// Node 8+ from this point on
+// Node 10+ from this point on
require('../cli')()
.then(exitCode => {
process.exitCode = exitCode;
diff --git a/cli.js b/cli.js
index d8780d7fbf..58c14bc4d1 100755
--- a/cli.js
+++ b/cli.js
@@ -19,7 +19,7 @@ module.exports = async () => {
Usage:
semantic-release [options] [plugins]`);
})
- .option('b', {alias: 'branch', describe: 'Git branch to release from', type: 'string', group: 'Options'})
+ .option('b', {alias: 'branches', describe: 'Git branches to release from', ...stringList, 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'})
diff --git a/docs/developer-guide/js-api.md b/docs/developer-guide/js-api.md
index 33b041759d..ed4a261a42 100644
--- a/docs/developer-guide/js-api.md
+++ b/docs/developer-guide/js-api.md
@@ -12,7 +12,14 @@ const stderrBuffer = WritableStreamBuffer();
try {
const result = await semanticRelease({
// Core options
- branch: 'master',
+ branches: [
+ '+([0-9])?(.{+([0-9]),x}).x',
+ 'master',
+ 'next',
+ 'next-major',
+ {name: 'beta', prerelease: true},
+ {name: 'alpha', prerelease: true}
+ ],
repositoryUrl: 'https://github.com/me/my-package.git',
// Shareable config
extends: 'my-shareable-config',
@@ -123,11 +130,12 @@ 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. |
+| 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. |
+| channel | `String` | The distribution channel on which the last release was initially made available (`undefined` for the default distribution channel). |
**Notes**: If no previous release is found, `lastRelease` will be an empty `Object`.
@@ -137,6 +145,7 @@ Example:
gitHead: 'da39a3ee5e6b4b0d3255bfef95601890afd80709',
version: '1.0.0',
gitTag: 'v1.0.0',
+ channel: 'next'
}
```
@@ -206,13 +215,14 @@ 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. |
+| 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. |
+| channel | `String` | The distribution channel on which the next release will be made available (`undefined` for the default distribution channel). |
Example:
```js
@@ -222,6 +232,7 @@ Example:
version: '1.1.0',
gitTag: 'v1.1.0',
notes: 'Release notes for version 1.1.0...',
+ channel : 'next'
}
```
@@ -229,19 +240,20 @@ Example:
Type: `Array