Compare commits

..
5 Commits
Author SHA1 Message Date
Gregor Martynus e72d201afe wip esm adapt lodash 2021-07-30 13:57:35 -07:00
Gregor Martynus ab7a428102 WIP esm - adapt sinon 2021-07-30 13:57:35 -07:00
Gregor Martynus ce263c5f4a WIP convert CJS to ESM using https://github.com/homer0/cjs2esm 2021-07-30 13:57:35 -07:00
Matt Travi d9605a5e45 docs(node-version): updated documentation to reference the new minimum 2021-07-30 15:47:49 -05:00
Matt Travi e1c00e2531 feat(node-version): raised the minimum required version to v14.17
for #2055

BREAKING CHANGE: the minimum required version of node is now v14.17
2021-07-30 15:18:22 -05:00
105 changed files with 8225 additions and 20596 deletions
+21
View File
@@ -0,0 +1,21 @@
---
name: Bug report
about: Something not working as expected
---
## Current behavior
<!-- Describe how the issue manifests. -->
## Expected behavior
<!-- Describe what the desired behavior would be. -->
## Environment
- **semantic-release** version: <!-- Version set in package.json devDpendencies -->
- CI environment: <!-- CI service name -->
- Plugins used: <!-- List semantic-release plugin used if any -->
- **semantic-release** configuration: <!-- link to your repository or relevant part of the semantic-release config -->
- CI logs: <!-- link to your CI logs or semantic-release logs -->
-51
View File
@@ -1,51 +0,0 @@
name: Bug Report
description: Something not working as expected
body:
- type: textarea
attributes:
label: Current behavior
description: Describe how the issue manifests.
validations:
required: true
- type: textarea
attributes:
label: Expected behavior
description: Describe what the desired behavior would be.
validations:
required: true
- type: input
attributes:
label: "`semantic-release` version"
description: Version set in `package.json` `devDpendencies`.
validations:
required: true
- type: input
attributes:
label: CI environment
description: CI service name.
validations:
required: true
- type: textarea
attributes:
label: Plugins used
description: List `semantic-release` plugin used, if any.
validations:
required: false
- type: textarea
attributes:
label: "`semantic-release` configuration"
description: Link to your repository or relevant part of the `semantic-release` config.
validations:
required: true
- type: textarea
attributes:
label: CI logs
description: Link to your CI logs or `semantic-release` logs.
validations:
required: true
@@ -0,0 +1,17 @@
---
name: Feature request
about: Wouldnt it be nice if semantic-release could ...
---
## New feature motivation
<!-- Describe the context, the use-case and the advantages of the feature request. -->
## New feature description
<!-- Describe the functional changes that would have to be made in semantic-release or its plugins. -->
## New feature implementation
<!-- Optionally describe the technical changes to be made in semantic-release or its plugins. -->
@@ -1,23 +0,0 @@
name: Feature request
description: Wouldn't it be nice if `semantic-release` could ...
body:
- type: textarea
attributes:
label: New feature motivation
description: Describe the context, the use-case and the advantages of the feature request.
validations:
required: true
- type: textarea
attributes:
label: New feature description
description: Describe the functional changes that would have to be made in `semantic-release` or its plugins.
validations:
required: true
- type: textarea
attributes:
label: New feature implementation
description: Optionally describe the technical changes to be made in `semantic-release` or its plugins.
validations:
required: false
@@ -0,0 +1,13 @@
---
name: New plugin suggestion
about: Integrate with a new platform, etc
---
## New plugin motivation
<!-- Describe the reasons to create a new plugin and why it's not covered by the existing ones. -->
## Third-party documentation
<!-- Provide explanation and documentation links for the platform to integrate with. -->
@@ -1,16 +0,0 @@
name: New plugin suggestion
description: Integrate with a new platform, etc
body:
- type: textarea
attributes:
label: New plugin motivation
description: Describe the reasons to create a new plugin and why it's not covered by the existing ones.
validations:
required: true
- type: textarea
attributes:
label: Third-party documentation
description: Provide explanation and documentation links for the platform to integrate with.
validations:
required: true
+3 -3
View File
@@ -1,11 +1,12 @@
name: Release
"on":
on:
push:
branches:
- master
- next
- beta
- "*.x"
- "*.x" # maintenance releases branches
jobs:
release:
name: release
@@ -15,7 +16,6 @@ jobs:
- uses: actions/setup-node@v2
with:
cache: npm
node-version: 16
- run: npm ci
- run: npx semantic-release
env:
+3 -5
View File
@@ -18,8 +18,7 @@ jobs:
matrix:
node-version:
- 14.17
- 16.0.0
- 17
- 16
runs-on: ubuntu-latest
@@ -32,6 +31,8 @@ jobs:
with:
node-version: ${{ matrix.node-version }}
cache: npm
- name: Ensure dependencies are compatible with the version of node
run: echo 'engine-strict=true' >> .npmrc
- run: npm ci
- run: npm run test:ci
@@ -44,9 +45,6 @@ jobs:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
with:
node-version: 16
cache: npm
- run: npm ci
- name: Ensure dependencies are compatible with the version of node
run: npx ls-engines@0.4
- run: npm run lint
+16 -32
View File
@@ -20,55 +20,45 @@ Help us keep **semantic-release** open and inclusive. Please read and follow our
### Improve documentation
As a **semantic-release** user, you are the perfect candidate to help us improve our documentation: typo corrections, clarifications, more examples, new [recipes](docs/recipes), etc. Take a look at the [documentation issues that need help](https://github.com/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+user%3Asemantic-release+archived%3Afalse+label%3A%22help+wanted%22+label%3Adocs+).
As a **semantic-release** user, you are the perfect candidate to help us improve our documentation: typo corrections, clarifications, more examples, new [recipes](docs/recipes/README.md), etc. Take a look at the [documentation issues that need help](https://github.com/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+user%3Asemantic-release+archived%3Afalse+label%3A%22help+wanted%22+label%3Adocs+).
Please follow the [Documentation guidelines](#documentation).
### Give feedback on issues
Some issues are created without information requested in the [Bug report guideline](#bug-report).
Help make them easier to resolve by adding any relevant information.
Some issues are created without information requested in the [Bug report guideline](#bug-report). Help make them easier to resolve by adding any relevant information.
Issues with the [design label](https://github.com/issues?q=is%3Aopen+is%3Aissue+user%3Asemantic-release+archived%3Afalse+label%3Adesign) are meant to discuss the implementation of new features.
Participating in the discussion is a good opportunity to get involved and influence the future direction of **semantic-release**.
Issues with the [design label](https://github.com/issues?q=is%3Aopen+is%3Aissue+user%3Asemantic-release+archived%3Afalse+label%3Adesign) are meant to discuss the implementation of new features. Participating in the discussion is a good opportunity to get involved and influence the future direction of **semantic-release**.
### Fix bugs and implement features
Confirmed bugs and ready-to-implement features are marked with the [help wanted label](https://github.com/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+user%3Asemantic-release+archived%3Afalse+label%3A%22help+wanted%22).
Post a comment on an issue to indicate you would like to work on it and to request help from the [@semantic-release/maintainers](https://github.com/orgs/semantic-release/teams/contributors) and the community.
Confirmed bugs and ready-to-implement features are marked with the [help wanted label](https://github.com/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+user%3Asemantic-release+archived%3Afalse+label%3A%22help+wanted%22). Post a comment on an issue to indicate you would like to work on it and to request help from the [@semantic-release/maintainers](https://github.com/orgs/semantic-release/teams/contributors) and the community.
## Using the issue tracker
The issue tracker is the channel for [bug reports](#bug-report), [features requests](#feature-request) and [submitting pull requests](#submitting-a-pull-request) only.
Please use the [Support](docs/support/README.md) and [Get help](README.md#get-help) sections for support, troubleshooting and questions.
The issue tracker is the channel for [bug reports](#bug-report), [features requests](#feature-request) and [submitting pull requests](#submitting-a-pull-request) only. Please use the [Support](docs/support/README.md) and [Get help](README.md#get-help) sections for support, troubleshooting and questions.
Before opening an issue or a Pull Request, please use the [GitHub issue search](https://github.com/issues?utf8=%E2%9C%93&q=user%3Asemantic-release) to make sure the bug or feature request hasn't been already reported or fixed.
### Bug report
A good bug report shouldn't leave others needing to chase you for more information.
Please try to be as detailed as possible in your report and fill the information requested in the [bug report template](https://github.com/semantic-release/semantic-release/issues/new?template=01_bug_report.md).
A good bug report shouldn't leave others needing to chase you for more information. Please try to be as detailed as possible in your report and fill the information requested in the [Bug report template](https://github.com/semantic-release/semantic-release/issues/new?template=bug-report.md).
### Feature request
Feature requests are welcome, but take a moment to find out whether your idea fits with the scope and aims of the project.
It's up to you to make a strong case to convince the project's developers of the merits of this feature.
Please provide as much detail and context as possible and fill the information requested in the [feature request template](https://github.com/semantic-release/semantic-release/issues/new?template=02_feature_request.md).
Feature requests are welcome, but take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible and fill the information requested in the [Feature request template](https://github.com/semantic-release/semantic-release/issues/new?template=feature-request.md).
### New plugin request
[Plugins](docs/usage/plugins.md) are a great way to extend **semantic-release** capabilities, integrate with other systems and support new project type.
Please provide as much detail and context as possible and fill the information requested in the [plugin suggestion template](https://github.com/semantic-release/semantic-release/issues/new?template=03_plugin_suggestion.md).
[Plugins](docs/usage/plugins.md) are a great way to extend **semantic-release** capabilities, integrate with other systems and support new project type. Please provide as much detail and context as possible and fill the information requested in the [New plugin request template](https://github.com/semantic-release/semantic-release/issues/new?template=plugin-request.md).
## Submitting a Pull Request
Good pull requests, whether patches, improvements, or new features, are a fantastic help.
They should remain focused in scope and avoid containing unrelated commits.
Good pull requests, whether patches, improvements, or new features, are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.
**Please ask first** before embarking on any significant pull requests (e.g. implementing features, refactoring code), otherwise you risk spending a lot of time working on something that the project's maintainers might not want to merge into the project.
**Please ask first** before embarking on any significant pull requests (e.g. implementing features, refactoring code), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.
If you have never created a pull request before, welcome 🎉 😄.
[Here is a great tutorial](https://opensource.guide/how-to-contribute/#opening-a-pull-request) on how to send one :)
If you have never created a pull request before, welcome 🎉 😄. [Here is a great tutorial](https://opensource.guide/how-to-contribute/#opening-a-pull-request) on how to send one :)
Here is a summary of the steps to follow:
@@ -93,9 +83,7 @@ $ git push origin <topic-branch-name>
**Tips**:
- For ambitious tasks, open a Pull Request as soon as possible with the `[WIP]` prefix in the title, in order to get feedback and help from the community.
- [Allow semantic-release maintainers to make changes to your Pull Request branch](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork).
This way, we can rebase it and make some minor changes if necessary.
All changes we make will be done in new commit, and we'll ask for your approval before merging them.
- [Allow semantic-release maintainers to make changes to your Pull Request branch](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork). This way, we can rebase it and make some minor changes if necessary. All changes we make will be done in new commit and we'll ask for your approval before merging them.
## Coding rules
@@ -141,8 +129,7 @@ A complex feature can be broken down into multiple commits as long as each one m
#### Commit message format
Each commit message consists of a **header**, a **body** and a **footer**.
The header has a special format that includes a **type**, a **scope** and a **subject**:
Each commit message consists of a **header**, a **body** and a **footer**. The header has a special format that includes a **type**, a **scope** and a **subject**:
```commit
<type>(<scope>): <subject>
@@ -158,8 +145,7 @@ The **footer** can contain a [closing reference to an issue](https://help.github
#### Revert
If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit.
In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
#### Type
@@ -192,8 +178,7 @@ The body should include the motivation for the change and contrast this with pre
#### Footer
The footer should contain any information about **Breaking Changes** and is also the place to reference GitHub issues that this commit **Closes**.
**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines.
The rest of the commit message is then used for this.
**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.
#### Examples
@@ -234,8 +219,7 @@ $ npm install
### Lint
All the [semantic-release](https://github.com/semantic-release) repositories use [XO](https://github.com/sindresorhus/xo) for linting and [Prettier](https://prettier.io) for formatting.
Prettier formatting will be automatically verified and fixed by XO.
All the [semantic-release](https://github.com/semantic-release) repositories use [XO](https://github.com/sindresorhus/xo) for linting and [Prettier](https://prettier.io) for formatting. Prettier formatting will be automatically verified and fixed by XO.
Before pushing your code changes make sure there are no linting errors with `npm run lint`.
+25 -29
View File
@@ -8,7 +8,7 @@
<img alt="Build states" src="https://github.com/semantic-release/semantic-release/workflows/Test/badge.svg">
</a>
<a href="#badge">
<img alt="semantic-release: angular" src="https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release">
<img alt="semantic-release" src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg">
</a>
</p>
<p align="center">
@@ -23,9 +23,9 @@
</a>
</p>
**semantic-release** automates the whole package release workflow including: determining the next version number, generating the release notes, and publishing the package.
**semantic-release** automates the whole package release workflow including: determining the next version number, generating the release notes and publishing the package.
This removes the immediate connection between human emotions and version numbers, strictly following the [Semantic Versioning](http://semver.org) specification and communicating the **impact** of changes to consumers.
This removes the immediate connection between human emotions and version numbers, strictly following the [Semantic Versioning](http://semver.org) specification.
> Trust us, this will change your workflow for the better. [egghead.io](https://egghead.io/lessons/javascript-how-to-write-a-javascript-library-automating-releases-with-semantic-release)
@@ -37,20 +37,18 @@ This removes the immediate connection between human emotions and version numbers
- 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/release-workflow/README.md#ci-configurations)
- 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/release-workflow/README.md#package-managers-and-languages) via [plugins](docs/usage/plugins.md)
- Support any [package managers and languages](docs/recipes/README.md#package-managers-and-languages) via [plugins](docs/usage/plugins.md)
- Simple and reusable configuration via [shareable configurations](docs/usage/shareable-configurations.md)
## How does it work?
### Commit message format
**semantic-release** uses the commit messages to determine the consumer impact of changes in the codebase.
Following formalized conventions for commit messages, **semantic-release** automatically determines the next [semantic version](https://semver.org) number, generates a changelog and publishes the release.
**semantic-release** uses the commit messages to determine the type of changes in the codebase. Following formalized conventions for commit messages, **semantic-release** automatically determines the next [semantic version](https://semver.org) number, generates a changelog and publishes the release.
By default, **semantic-release** uses [Angular Commit Message Conventions](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-format).
The commit message format can be changed with the [`preset` or `config` options](docs/usage/configuration.md#options) of the [@semantic-release/commit-analyzer](https://github.com/semantic-release/commit-analyzer#options) and [@semantic-release/release-notes-generator](https://github.com/semantic-release/release-notes-generator#options) plugins.
By default **semantic-release** uses [Angular Commit Message Conventions](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-format). The commit message format can be changed with the [`preset` or `config` options](docs/usage/configuration.md#options) of the [@semantic-release/commit-analyzer](https://github.com/semantic-release/commit-analyzer#options) and [@semantic-release/release-notes-generator](https://github.com/semantic-release/release-notes-generator#options) plugins.
Tools such as [commitizen](https://github.com/commitizen/cz-cli) or [commitlint](https://github.com/conventional-changelog/commitlint) can be used to help contributors and enforce valid commit messages.
@@ -58,25 +56,23 @@ The table below shows which commit message gets you which release type when `sem
| Commit message | Release type |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------- |
| `fix(pencil): stop graphite breaking when too much pressure applied` | ~~Patch~~ Fix Release |
| `fix(pencil): stop graphite breaking when too much pressure applied` | Patch Release |
| `feat(pencil): add 'graphiteWidth' option` | ~~Minor~~ Feature Release |
| `perf(pencil): remove graphiteWidth option`<br><br>`BREAKING CHANGE: The graphiteWidth option has been removed.`<br>`The default graphite width of 10mm is always used for performance reasons.` | ~~Major~~ Breaking Release <br /> (Note that the `BREAKING CHANGE: ` token must be in the footer of the commit) |
| `perf(pencil): remove graphiteWidth option`<br><br>`BREAKING CHANGE: The graphiteWidth option has been removed.`<br>`The default graphite width of 10mm is always used for performance reasons.` | ~~Major~~ Breaking Release |
### Automation with CI
**semantic-release** is meant to be executed on the CI environment after every successful build on the release branch.
This way no human is directly involved in the release process and the releases are guaranteed to be [unromantic and unsentimental](http://sentimentalversioning.org).
**semantic-release** is meant to be executed on the CI environment after every successful build on the release branch. This way no human is directly involved in the release process and the releases are guaranteed to be [unromantic and unsentimental](http://sentimentalversioning.org).
### Triggering a release
For each new commit 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.
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.
**semantic-release** offers various ways to control the timing, the content and the audience of published releases.
See example workflows in the following recipes:
**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/release-workflow/distribution-channels.md#publishing-on-distribution-channels)
- [Maintenance releases](docs/recipes/release-workflow/maintenance-releases.md#publishing-maintenance-releases)
- [Pre-releases](docs/recipes/release-workflow/pre-releases.md#publishing-pre-releases)
- [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
@@ -100,8 +96,8 @@ 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)
- A Git CLI version that meets [our version requirement](docs/support/git-version.md) installed in your Continuous Integration environment
- A [Node.js](https://nodejs.org) version that meets [our version requirement](docs/support/node-version.md) installed in your Continuous Integration environment
- 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 [14.17 or higher](docs/support/FAQ.md#why-does-semantic-release-require-node-version--1417) installed in your Continuous Integration environment
## Documentation
@@ -117,9 +113,10 @@ In order to use **semantic-release** you need:
- [Plugins](docs/extending/plugins-list.md)
- [Shareable configuration](docs/extending/shareable-configurations-list.md)
- Recipes
- [CI configurations](docs/recipes/ci-configurations/README.md)
- [Git hosted services](docs/recipes/git-hosted-services/README.md)
- [Release workflow](docs/recipes/release-workflow/README.md)
- [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)
@@ -133,19 +130,18 @@ In order to use **semantic-release** you need:
## Get help
- [GitHub Discussions](https://github.com/semantic-release/semantic-release/discussions)
- [Stack Overflow](https://stackoverflow.com/questions/tagged/semantic-release)
- [GitHub Discussions](https://github.com/semantic-release/semantic-release/discussions)
- [Twitter](https://twitter.com/SemanticRelease)
## Badge
Let people know that your package is published using **semantic-release** and which [commit-convention](#commit-message-format) is followed by including this badge in your readme.
Let people know that your package is published using **semantic-release** by including this badge in your readme.
[![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
```md
[![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
```
## Team
+7 -13
View File
@@ -14,18 +14,13 @@
- [Shareable configuration](docs/extending/shareable-configurations-list.md)
## Recipes
- [CI configurations](docs/recipes/ci-configurations/README.md)
- [CircleCI 2.0](docs/recipes/ci-configurations/circleci-workflows.md)
- [Travis CI](docs/recipes/ci-configurations/travis.md)
- [GitLab CI](docs/recipes/ci-configurations/gitlab-ci.md)
- [GitHub Actions](docs/recipes/ci-configurations/github-actions.md)
- [Jenkins CI](docs/recipes/ci-configurations/jenkins-ci.md)
- [Git hosted services](docs/recipes/git-hosted-services/README.md)
- [Git authentication with SSH keys](docs/recipes/git-hosted-services/git-auth-ssh-keys.md)
- [Release Workflow](docs/recipes/release-workflow/README.md)
- [Publishing on distribution channels](docs/recipes/release-workflow/distribution-channels.md)
- [Publishing maintenance releases](docs/recipes/release-workflow/maintenance-releases.md)
- [Publishing pre-releases](docs/recipes/release-workflow/pre-releases.md)
- [CI configurations](docs/recipes/README.md#ci-configurations)
- [CircleCI 2.0](docs/recipes/circleci-workflows.md)
- [Travis CI](docs/recipes/travis.md)
- [GitLab CI](docs/recipes/gitlab-ci.md)
- [Git hosted services](docs/recipes/README.md#git-hosted-services)
- [Git authentication with SSH keys](docs/recipes/git-auth-ssh-keys.md)
- [Package managers and languages](docs/recipes/README.md#package-managers-and-languages)
## Developer guide
- [JavaScript API](docs/developer-guide/js-api.md)
@@ -38,4 +33,3 @@
- [Troubleshooting](docs/support/troubleshooting.md)
- [Node version requirement](docs/support/node-version.md)
- [Node Support Policy](docs/support/node-support-policy.md)
- [Git version requirement](docs/support/git-version.md)
+7 -12
View File
@@ -1,16 +1,11 @@
#!/usr/bin/env node
#!/usr/bin/env node// Bad news: We have to write plain ES5 in this file
import semver from 'semver';
// Bad news: We have to write plain ES5 in this file
// Good news: It's the only file of the entire project
import execa from 'execa';
import findVersions from 'find-versions';
import pkg from '../package.json';
/* eslint-disable no-var */
var semver = require('semver');
var execa = require('execa');
var findVersions = require('find-versions');
var pkg = require('../package.json');
var MIN_GIT_VERSION = '2.7.1';
const MIN_GIT_VERSION = '2.7.1';
if (!semver.satisfies(process.version, pkg.engines.node)) {
console.error(
@@ -23,7 +18,7 @@ See https://github.com/semantic-release/semantic-release/blob/master/docs/suppor
execa('git', ['--version'])
.then(({stdout}) => {
var gitVersion = findVersions(stdout)[0];
const gitVersion = findVersions(stdout)[0];
if (semver.lt(gitVersion, MIN_GIT_VERSION)) {
console.error(`[semantic-release]: Git version ${MIN_GIT_VERSION} is required. Found ${gitVersion}.`);
process.exit(1);
+12 -9
View File
@@ -1,6 +1,9 @@
const {argv, env, stderr} = require('process'); // eslint-disable-line node/prefer-global/process
const util = require('util');
const hideSensitive = require('./lib/hide-sensitive');
import util from 'util';
import hideSensitive from './lib/hide-sensitive';
import yargs from 'yargs';
import debug from 'debug';
import run from '.';
const stringList = {
type: 'string',
@@ -11,8 +14,8 @@ const stringList = {
: values.reduce((values, value) => values.concat(value.split(',').map((value) => value.trim())), []),
};
module.exports = async () => {
const cli = require('yargs')
export default async () => {
const cli = yargs
.command('$0', 'Run automated package publishing', (yargs) => {
yargs.demandCommand(0, 0).usage(`Run automated package publishing
@@ -41,7 +44,7 @@ Usage:
.exitProcess(false);
try {
const {help, version, ...options} = cli.parse(argv.slice(2));
const {help, version, ...options} = cli.parse(process.argv.slice(2));
if (Boolean(help) || Boolean(version)) {
return 0;
@@ -49,14 +52,14 @@ Usage:
if (options.debug) {
// Debug must be enabled before other requires in order to work
require('debug').enable('semantic-release:*');
debug.enable('semantic-release:*');
}
await require('.')(options);
await run(options);
return 0;
} catch (error) {
if (error.name !== 'YError') {
stderr.write(hideSensitive(env)(util.inspect(error, {colors: true})));
process.stderr.write(hideSensitive(process.env)(util.inspect(error, {colors: true})));
}
return 1;
+1 -1
View File
@@ -2,6 +2,6 @@
- [Usage](usage/README.md) - **semantic-release** installation and configuration
- [Extending](extending/README.md) - Extending **semantic-release** with plugins and shareable configurations
- [Recipes](recipes/release-workflow/README.md) - Community written recipes for common **semantic-release** use-cases
- [Recipes](recipes/README.md) - Community written recipes for common **semantic-release** use-cases
- [Developer Guide](developer-guide/README.md) - The essentials of writing a **semantic-release** plugin or shareable configurations
- [Support](support/README.md) - FAQ and troubleshooting
+6 -20
View File
@@ -12,9 +12,9 @@ To create a plugin for `semantic-release`, you need to decide which parts of the
- `success`
- `fail`
`semantic-release` will require the plugin via `node` and look through the required object for methods named like the lifecycles stated above. For example, if your plugin only had a `verifyConditions` and `success` step, the `main` file for your object would need to `export` an object with `verifyConditions` and `success` functions.
`semantic-release` will require the plugin via `node` and look through the required object for methods named like the lifecyles stated above. For example, if your plugin only had a `verifyConditions` and `success` step, the `main` file for your object would need to `export` an object with `verifyConditions` and `success` functions.
In addition to the lifecycle methods, each lifecycle is passed two objects:
In addition to the lifecycle methods, each lifecyle is passed two objects:
1. `pluginConfig` - an object containing the options that a user may pass in via their `release.config.js` file (or similar)
2. `context` - provided by `semantic-release` for access to things like `env` variables set on the running process.
@@ -34,7 +34,7 @@ We recommend you setup a linting system to ensure good javascript practices are
In your `index.js` file, you can start by writing the following code
```javascript
const verify = require('./src/verify');
const verifyConditions = require('./src/verify');
let verified;
@@ -43,12 +43,12 @@ let verified;
* @param {*} pluginConfig The semantic-release plugin config
* @param {*} context The context provided by semantic-release
*/
async function verifyConditions(pluginConfig, context) {
await verify(pluginConfig, context);
async function verify(pluginConfig, context) {
await verifyConditions(pluginConfig, context);
verified = true;
}
module.exports = { verifyConditions };
module.exports = { verify };
```
Then, in your `src` folder, create a file called `verify.js` and add the following
@@ -237,20 +237,6 @@ if (env.GITHUB_TOKEN) {
//...
}
```
## Logger
Use `context.logger` to provide debug logging in the plugin.
```js
const { logger } = context;
logger.log('Some message from plugin.').
```
The above usage yields the following where `PLUGIN_PACKAGE_NAME` is automatically inferred.
```
[3:24:04 PM] [semantic-release] [PLUGIN_PACKAGE_NAME] Some message from plugin.
```
## Execution order
+3 -29
View File
@@ -54,13 +54,12 @@
- `publish`: Tag the image specified by `name` with the new version, push it to Docker Hub and update the latest tag
- [@semantic-release-plus/docker](https://github.com/semantic-release-plus/semantic-release-plus/tree/master/packages/plugins/docker)
- `verifyConditions`: Verify that all needed configuration is present and login to the configured docker registry.
- `publish`: Tag the image specified by `name` with the new version and channel and push it to the configured docker registry.
- `addChannel`: Updates a release published on one channel with the destinations channel tag and pushes to the registry i.e.: next to latest.
- `publish`: Tag the image specified by `name` with the new version, push it to the configured docker registry and update the `latest`, `major`, `minor` tags based on the configuration settings.
- [semantic-release-gcr](https://github.com/carlos-cubas/semantic-release-gcr)
- `verifyConditions`: Verify that all needed configuration is present and login to the Docker registry
- `publish`: Tag the image specified by `name` with the new version, push it to Docker Hub and update the latest tag
- [semantic-release-vsce](https://github.com/raix/semantic-release-vsce)
- `verifyConditions`: Verify the presence and the validity of the "VS Code extension" authentication and release configuration
- `verifyConditions`: Verify the presence and the validity of the vsce authentication and release configuration
- `prepare`: Create a `.vsix` for distribution
- `publish`: Publish the package to the Visual Studio Code marketplace
- [semantic-release-verify-deps](https://github.com/piercus/semantic-release-verify-deps)
@@ -84,7 +83,7 @@
- `prepare`: Changes the version number in the `pom.xml` (or all `pom.xml` files in maven projects with multiple `pom.xml` files) and optionally creates a commit with this version number and pushes it to `master`
- `publish`: Runs `mvn deploy` to deploy to maven central and optionally will update to next snapshot version and merge changes to development branch
- [semantic-release-ado](https://github.com/lluchmk/semantic-release-ado)
- `prepare`: Stores the version number as an Azure DevOps pipeline variable available to downstream steps on the job
- `prepare`: Stores the version number as an Azure DevOps pipeline variable availabe to downstream steps on the job
- [gradle-semantic-release](https://github.com/KengoTODA/gradle-semantic-release-plugin)
- `verifyConditions`: Verify that project has a Gradle wrapper script, and `build.gradle` contains a task to publish artifacts.
- `prepare`: Changes the version number in the `gradle.properties`
@@ -141,28 +140,3 @@
- `verifyConditions`: Validate configuration and verify ```HEROKU_API_KEY```
- `prepare`: Update the package.json version and create release tarball
- `publish`: Publish version to heroku
- [semantic-release-mattermost](https://github.com/ttrobisch/semantic-release-mattermost)
- `verifyConditions`: Verify that the webhook is setup and release-notes-generator is present.
- `success`: Send a message about the new release and its notes to a [mattermost](https://mattermost.com/) webhook.
- [semantic-release-github-milestones](https://github.com/nitzano/semantic-release-github-milestones)
- `verifyConditions`: Verify github tokens are present and valid.
- `verifyRelease`: Display information regarding the matching github milestone.
- [semantic-release-telegram-bot](https://github.com/skoropadas/semantic-release-telegram-bot)
- `verifyConditions`: Validate configuration and verify `TELEGRAM_BOT_TOKEN` and package name
- `success`: Publish a success message to certain telegram chats
- `fail`: Publish a fail message to certain telegram chats
- [semantic-release-npm-deprecate](https://github.com/jpoehnelt/semantic-release-npm-deprecate)
- `publish`: Automatically mark old versions as deprecated.
- [@eshepelyuk/semantic-release-helm-oci](https://github.com/eshepelyuk/semantic-release-helm-oci)
- `verifyConditions`: Verify plugin configuration and login to Helm registry
- `prepare`: Package Helm chart to local folder
- `publish`: Publish Helm chart to OCI registry
- [semantic-release-space](https://github.com/123FLO321/semantic-release-space)
- `verifyConditions` Verifies that all required options are set.
- `prepare` Creates a JetBrains Space Deployment Target if it does not yet exist.
- `publish` Starts a JetBrains Space Deployment.
- `success` Marks the JetBrains Space Deployment as completed.
- `fail` Marks the JetBrains Space Deployment as failed.
- [semantic-release-react-native](https://github.com/alexandermendes/semantic-release-react-native)
- `verifyConditions` Validate configuration.
- `prepare` Version native iOS and Android files.
@@ -6,7 +6,7 @@
## Community configurations
- [@jedmao/semantic-release-npm-github-config](https://github.com/jedmao/semantic-release-npm-github-config)
- Provides an informative [Git](https://github.com/semantic-release/git) commit message for the release commit that does not trigger continuous integration and conforms to the [conventional commits specification](https://www.conventionalcommits.org/) (e.g., `chore(release): 1.2.3 [skip ci]\n\nnotes`).
- Provides an informative [git](https://github.com/semantic-release/git) commit message for the release commit that does not trigger continuous integration and conforms to the [conventional commits specification](https://www.conventionalcommits.org/) (e.g., "chore(release): 1.2.3 [skip ci]\n\nnotes").
- Creates a tarball that gets uploaded with each [GitHub release](https://github.com/semantic-release/github).
- Publishes the same tarball to [npm](https://github.com/semantic-release/npm).
- Commits the version change in `package.json`.
@@ -18,3 +18,4 @@
- Updates GitHub release with release-notes.
- Bumps a version in package.json.
- Publishes the new version to [NPM](https://npmjs.org).
+18
View File
@@ -0,0 +1,18 @@
# Recipes
## CI configurations
- [CircleCI 2.0 workflows](circleci-workflows.md)
- [Travis CI](travis.md)
- [GitLab CI](gitlab-ci.md)
- [GitHub Actions](github-actions.md)
- [Jenkins CI](jenkins-ci.md)
## Git hosted services
- [Git authentication with SSH keys](git-auth-ssh-keys.md)
## Release workflow
- [Publishing on distribution channels](distribution-channels.md)
- [Publishing maintenance releases](maintenance-releases.md)
- [Publishing pre-releases](pre-releases.md)
## Package managers and languages
-6
View File
@@ -1,6 +0,0 @@
# CI configurations
- [CircleCI 2.0 workflows](circleci-workflows.md)
- [Travis CI](travis.md)
- [GitLab CI](gitlab-ci.md)
- [GitHub Actions](github-actions.md)
- [Jenkins CI](jenkins-ci.md)
@@ -2,27 +2,24 @@
## Environment variables
The [Authentication](../../usage/ci-configuration.md#authentication) environment variables can be configured in [CircleCi Project Settings](https://circleci.com/docs/2.0/env-vars/#adding-environment-variables-in-the-app)..
The [Authentication](../usage/ci-configuration.md#authentication) environment variables can be configured in [CircleCi Project Settings](https://circleci.com/docs/2.0/env-vars/#adding-environment-variables-in-the-app)..
Alternatively, the default `NPM_TOKEN` and `GH_TOKEN` can be easily [setup with semantic-release-cli](../../usage/getting-started.md#getting-started).
Alternatively, the default `NPM_TOKEN` and `GH_TOKEN` can be easily [setup with semantic-release-cli](../usage/getting-started.md#getting-started).
## Multiple Node jobs configuration
### `.circleci/config.yml` configuration for multiple Node jobs
This example is a minimal configuration for **semantic-release** with tests running against Node 16 and 14.
See [CircleCI documentation](https://circleci.com/docs/2.0) for additional configuration options.
This example is a minimal configuration for **semantic-release** with tests running against Node 16 and 14. See [CircleCI documentation](https://circleci.com/docs/2.0) for additional configuration options.
In this example, the [`circleci/node`](https://circleci.com/developer/orbs/orb/circleci/node) orb is imported (Which makes some node operations easier), then a `release` job is defined which will run `semantic-release`.
To run our `release` job, we have created a workflow named `test_and_release` which will run two jobs, `node/test`, which comes from the node orb and will test our application, and our release job.
Here, we are actually making use of [matrix jobs](https://circleci.com/blog/circleci-matrix-jobs/) so that our single `node/test` job will actually be executed twice, once for Node version 16, and once for version 14.
Finally, we call our release job with a `requires` parameter so that `release` will run against the latest LTS version of node, only after `node/test` has successfully tested against v14 and v16.
To run our `release` job, we have created a workflow named `test_and_release` which will run two jobs, `node/test`, which comes from the node orb and will test our application, and our release job. Here, we are actually making use of [matrix jobs](https://circleci.com/blog/circleci-matrix-jobs/) so that our single `node/test` job will actually be executed twice, once for Node version 16, and once for version 14. Finally, we call our release job with a `requires` parameter so that `release` will only run after `node/test` has successfully tested against v14 and v16.
```yaml
version: 2.1
orbs:
node: circleci/node@5.0.0
node: circleci/node@4.5
jobs:
release:
executor: node/default
@@ -47,3 +44,15 @@ workflows:
requires:
- node/test
```
### `package.json` configuration for multiple Node jobs
A `package.json` is required only for [local](../usage/installation.md#local-installation) **semantic-release** installation.
```json
{
"devDependencies": {
"semantic-release": "^18.0.0"
}
}
```
@@ -1,10 +1,10 @@
# Publishing on distribution channels
This recipe will walk you through a simple example that uses distribution channels to make releases available only to a subset of users, in order to collect feedback before distributing the release to all users.
This recipe will walk you through a simple example that uses distribution channels to make releases available only to a subset of users, in order to collect feedbacks before distributing the release to all users.
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']`
- [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
@@ -1,6 +1,6 @@
# Git authentication with SSH keys
When using [environment variables](../../usage/ci-configuration.md#authentication) to set up the Git authentication, the remote Git repository will automatically be accessed via [https](https://git-scm.com/book/en/v2/Git-on-the-Server-The-Protocols#_the_http_protocols), independently of the [`repositoryUrl`](../../usage/configuration.md#repositoryurl) format configured in the **semantic-release** [Configuration](../../usage/configuration.md#configuration) (the format will be automatically converted as needed).
When using [environment variables](../usage/ci-configuration.md#authentication) to set up the Git authentication, the remote Git repository will automatically be accessed via [https](https://git-scm.com/book/en/v2/Git-on-the-Server-The-Protocols#_the_http_protocols), independently of the [`repositoryUrl`](../usage/configuration.md#repositoryurl) format configured in the **semantic-release** [Configuration](../usage/configuration.md#configuration) (the format will be automatically converted as needed).
Alternatively the Git repository can be accessed via [SSH](https://git-scm.com/book/en/v2/Git-on-the-Server-The-Protocols#_the_ssh_protocol) by creating SSH keys, adding the public one to your Git hosted account and making the private one available on the CI environment.
@@ -1,2 +0,0 @@
# Git hosted services
- [Git authentication with SSH keys](git-auth-ssh-keys.md)
@@ -2,7 +2,7 @@
## Environment variables
The [Authentication](../../usage/ci-configuration.md#authentication) environment variables can be configured with [Secret Variables](https://docs.github.com/en/actions/reference/encrypted-secrets).
The [Authentication](../usage/ci-configuration.md#authentication) environment variables can be configured with [Secret Variables](https://help.github.com/en/articles/virtual-environments-for-github-actions#creating-and-using-secrets-encrypted-variables).
In this example a publish type [`NPM_TOKEN`](https://docs.npmjs.com/creating-and-viewing-authentication-tokens) is required to publish a package to the npm registry. GitHub Actions [automatically populate](https://help.github.com/en/articles/virtual-environments-for-github-actions#github_token-secret) a [`GITHUB_TOKEN`](https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line) environment variable which can be used in Workflows.
@@ -10,11 +10,11 @@ In this example a publish type [`NPM_TOKEN`](https://docs.npmjs.com/creating-and
[GitHub Actions](https://github.com/features/actions) support [Workflows](https://help.github.com/en/articles/configuring-workflows), allowing to run tests on multiple Node versions and publish a release only when all test pass.
**Note**: The publish pipeline must run on a [Node version that meets our version requirement](../../support/node-version.md).
**Note**: The publish pipeline must run on [Node version >= 14.17](../support/FAQ.md#why-does-semantic-release-require-node-version--1417).
### `.github/workflows/release.yml` configuration for Node projects
The following is a minimal configuration for [`semantic-release`](https://github.com/semantic-release/semantic-release) with a build running on the latest LTS version of Node when a new commit is pushed to a `master` branch.
The following is a minimal configuration for [`semantic-release`](https://github.com/semantic-release/semantic-release) with a build running on Node 14.17 when a new commit is pushed to a `master` branch.
See [Configuring a Workflow](https://help.github.com/en/articles/configuring-a-workflow) for additional configuration options.
```yaml
@@ -33,9 +33,9 @@ jobs:
with:
fetch-depth: 0
- name: Setup Node.js
uses: actions/setup-node@v2
uses: actions/setup-node@v1
with:
node-version: 'lts/*'
node-version: '14.17'
- name: Install dependencies
run: npm ci
- name: Release
@@ -2,7 +2,7 @@
## Environment variables
The [Authentication](../../usage/ci-configuration.md#authentication) environment variables can be configured with [Protected variables](https://docs.gitlab.com/ce/ci/variables/README.html#protected-environment-variables).
The [Authentication](../usage/ci-configuration.md#authentication) environment variables can be configured with [Protected variables](https://docs.gitlab.com/ce/ci/variables/README.html#protected-environment-variables).
**Note**: Make sure to configure your release branch as [protected](https://docs.gitlab.com/ce/user/project/protected_branches.html) in order for the CI/CD build to access the protected variables.
@@ -10,13 +10,13 @@ The [Authentication](../../usage/ci-configuration.md#authentication) environment
GitLab CI supports [Pipelines](https://docs.gitlab.com/ee/ci/pipelines.html) allowing to test on multiple Node versions and publishing a release only when all test pass.
**Note**: The publish pipeline must run a [Node version that meets our version requirement](../../support/node-version.md).
**Note**: The publish pipeline must run a [Node >= 14.17 version](../support/FAQ.md#why-does-semantic-release-require-node-version--1417).
### `.gitlab-ci.yml` configuration for Node projects
This example is a minimal configuration for **semantic-release** with a build running Node 10 and 12. See [GitLab CI - Configuration of your jobs with `.gitlab-ci.yml`](https://docs.gitlab.com/ee/ci/yaml/README.html) for additional configuration options.
This example is a minimal configuration for **semantic-release** with a build running Node 10 and 12. See [GitLab CI - Configuration of your jobs with .gitlab-ci.yml](https://docs.gitlab.com/ee/ci/yaml/README.html) for additional configuration options.
**Note**: The`semantic-release` execution command varies depending on whether you are using a [local](../../usage/installation.md#local-installation) or [global](../../usage/installation.md#global-installation) **semantic-release** installation.
**Note**: The`semantic-release` execution command varies depending if you are using a [local](../usage/installation.md#local-installation) or [global](../usage/installation.md#global-installation) **semantic-release** installation.
```yaml
# The release pipeline will run only if all jobs in the test pipeline are successful
@@ -48,9 +48,9 @@ publish:
### `.gitlab-ci.yml` configuration for all projects
This example is a minimal configuration for **semantic-release** with a build running Node 10 and 12. See [GitLab CI - Configuration of your jobs with `.gitlab-ci.yml`](https://docs.gitlab.com/ee/ci/yaml/README.html) for additional configuration options.
This example is a minimal configuration for **semantic-release** with a build running Node 10 and 12. See [GitLab CI - Configuration of your jobs with .gitlab-ci.yml](https://docs.gitlab.com/ee/ci/yaml/README.html) for additional configuration options.
**Note**: The`semantic-release` execution command varies depending if you are using a [local](../../usage/installation.md#local-installation) or [global](../../usage/installation.md#global-installation) **semantic-release** installation.
**Note**: The`semantic-release` execution command varies depending if you are using a [local](../usage/installation.md#local-installation) or [global](../usage/installation.md#global-installation) **semantic-release** installation.
```yaml
@@ -66,8 +66,8 @@ release:
- npm install -g semantic-release @semantic-release/gitlab
script:
- semantic-release
rules:
- if: $CI_COMMIT_BRANCH == "master"
only:
- master
release:
image: node:12-buster-slim
@@ -77,13 +77,13 @@ release:
- npm install -g semantic-release @semantic-release/gitlab
script:
- semantic-release
rules:
- if: $CI_COMMIT_BRANCH == "master"
only:
- master
```
### `package.json` configuration
A `package.json` is required only for [local](../../usage/installation.md#local-installation) **semantic-release** installation.
A `package.json` is required only for [local](../usage/installation.md#local-installation) **semantic-release** installation.
```json
{
@@ -2,19 +2,19 @@
## Environment variables
The [Authentication](../../usage/ci-configuration.md#authentication) environment variables can be configured in [Jenkins Project Settings](https://www.jenkins.io/doc/pipeline/tour/environment/)..
The [Authentication](../usage/ci-configuration.md#authentication) environment variables can be configured in [Jenkins Project Settings](https://www.jenkins.io/doc/pipeline/tour/environment/)..
Alternatively, the default `NPM_TOKEN` and `GH_TOKEN` can be easily [setup with semantic-release-cli](../../usage/getting-started.md#getting-started).
Alternatively, the default `NPM_TOKEN` and `GH_TOKEN` can be easily [setup with semantic-release-cli](../usage/getting-started.md#getting-started).
## Node.js project configuration
### `Jenkinsfile (Declarative Pipeline)` configuration for a Node.js job
**Note**: The publish pipeline must run a Node version that [meets our requirement](../../support/node-version.md).
**Note**: The publish pipeline must run a [Node >= 14.17 version](../support/FAQ.md#why-does-semantic-release-require-node-version--1417).
This example is a minimal configuration for **semantic-release** with a build running a version of Node labelled as "node LTS".
Since versions of Node are manually downloaded and labelled, we recommend keeping the version used for the release steps up-to-date with the latest LTS version.
See the [Jenkins documentation](https://www.jenkins.io/doc/) for additional configuration options.
This example is a minimal configuration for **semantic-release** with a build running Node 14.17. See [Jenkins documentation](https://www.jenkins.io/doc/) for additional configuration options.
The`semantic-release` execution command varies depending if you are using a [local](../usage/installation.md#local-installation) or [global](../usage/installation.md#global-installation) **semantic-release** installation.
```yaml
// The release stage in the pipeline will run only if the test stage in the pipeline is successful
@@ -31,11 +31,11 @@ pipeline {
npm install
npm test
'''
}
}
}
stage('Release') {
tools {
nodejs "node LTS"
nodejs "node 14.17"
}
steps {
sh '''
@@ -50,7 +50,7 @@ pipeline {
### `package.json` configuration for a Node job
A `package.json` is required only for [local](../../usage/installation.md#local-installation) **semantic-release** installation.
A `package.json` is required only for [local](../usage/installation.md#local-installation) **semantic-release** installation.
```json
{
@@ -3,8 +3,8 @@
This recipe will walk you through a simple example that uses Git branches and distribution channels to publish fixes and features for old versions of a package.
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']`
- [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
@@ -18,7 +18,7 @@ The Git history of the repository is:
## Releasing a breaking change
We now decide to drop Node.js 6 support for our package, and require Node.js 8 or higher, which is a breaking change.
We now decide to drop Node.js 6 support for our package, and require Node.js 8 or higher, which is a breaking change.
We commit that change with the message `feat: drop Node.js 6 support \n\n BREAKING CHANGE: Node.js >= 8 required` to `master`. When pushing that commit, **semantic-release** will release the version `2.0.0` on the dist-tag `@latest`.
@@ -3,8 +3,8 @@
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']`
- [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
-4
View File
@@ -1,4 +0,0 @@
# Release workflow
- [Publishing on distribution channels](distribution-channels.md)
- [Publishing maintenance releases](maintenance-releases.md)
- [Publishing pre-releases](pre-releases.md)
@@ -2,9 +2,9 @@
## Environment variables
The [Authentication](../../usage/ci-configuration.md#authentication) environment variables can be configured in [Travis Repository Settings](https://docs.travis-ci.com/user/environment-variables/#defining-variables-in-repository-Settings) or with the [travis env set CLI](https://github.com/travis-ci/travis.rb#env).
The [Authentication](../usage/ci-configuration.md#authentication) environment variables can be configured in [Travis Repository Settings](https://docs.travis-ci.com/user/environment-variables/#defining-variables-in-repository-Settings) or with the [travis env set CLI](https://github.com/travis-ci/travis.rb#env).
Alternatively, the default `NPM_TOKEN` and `GH_TOKEN` can be easily [setup with semantic-release-cli](../../usage/getting-started.md#getting-started).
Alternatively, the default `NPM_TOKEN` and `GH_TOKEN` can be easily [setup with semantic-release-cli](../usage/getting-started.md#getting-started).
## Node.js projects configuration
@@ -12,7 +12,7 @@ Alternatively, the default `NPM_TOKEN` and `GH_TOKEN` can be easily [setup with
This example is a minimal configuration for **semantic-release** with a build running Node 14 and 16. See [Travis - Customizing the Build](https://docs.travis-ci.com/user/customizing-the-build) for additional configuration options.
This example creates a `release` [build stage](https://docs.travis-ci.com/user/build-stages) that [runs `semantic-release` only after all test jobs are successful](../../usage/ci-configuration.md#run-semantic-release-only-after-all-tests-succeeded).
This example creates a `release` [build stage](https://docs.travis-ci.com/user/build-stages) that [runs `semantic-release` only after all test jobs are successful](../usage/ci-configuration.md#run-semantic-release-only-after-all-tests-succeeded).
It's recommended to run the `semantic-release` command in the [Travis `deploy` step](https://docs.travis-ci.com/user/customizing-the-build/#The-Build-Lifecycle) so if an error occurs the build will fail and Travis will send a notification.
@@ -43,7 +43,7 @@ jobs:
### `package.json` configuration for multiple Node jobs
A `package.json` is required only for [local](../../usage/installation.md#local-installation) **semantic-release** installation.
A `package.json` is required only for [local](../usage/installation.md#local-installation) **semantic-release** installation.
```json
{
@@ -57,13 +57,13 @@ A `package.json` is required only for [local](../../usage/installation.md#local-
For projects that require to be tested with one or multiple version of a Non-JavaScript [language](https://docs.travis-ci.com/user/languages), optionally on multiple [Operating Systems](https://docs.travis-ci.com/user/multi-os).
This recipe cover the Travis specifics only. See [Non JavaScript projects recipe](../../support/FAQ.md#can-i-use-semantic-release-to-publish-non-javascript-packages) for more information on the **semantic-release** configuration.
This recipe cover the Travis specifics only. See [Non JavaScript projects recipe](../support/FAQ.md#can-i-use-semantic-release-to-publish-non-javascript-packages) for more information on the **semantic-release** configuration.
### `.travis.yml` configuration for non-JavaScript projects
This example is a minimal configuration for **semantic-release** with a build running [Go 1.6 and 1.7](https://docs.travis-ci.com/user/languages/go). See [Travis - Customizing the Build](https://docs.travis-ci.com/user/customizing-the-build) for additional configuration options.
This example creates a `release` [build stage](https://docs.travis-ci.com/user/build-stages) that [runs `semantic-release` only after all test jobs are successful](../../usage/ci-configuration.md#run-semantic-release-only-after-all-tests-succeeded).
This example creates a `release` [build stage](https://docs.travis-ci.com/user/build-stages) that [runs `semantic-release` only after all test jobs are successful](../usage/ci-configuration.md#run-semantic-release-only-after-all-tests-succeeded).
It's recommended to run the `semantic-release` command in the [Travis `deploy` step](https://docs.travis-ci.com/user/customizing-the-build/#The-Build-Lifecycle) so if an error occurs the build will fail and Travis will send a notification.
+21 -11
View File
@@ -44,12 +44,12 @@ Yes, **semantic-release** is a Node CLI application, but it can be used to publi
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 a version of Node that [meets our version requirement](./node-version.md) to execute the `semantic-release` command
- 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 >= 14.17](#why-does-semantic-release-require-node-version--1417) to execute the `semantic-release` command
See the [CI configuration recipes](../recipes/release-workflow/README.md#ci-configurations) for more details on specific CI environments.
See the [CI configuration recipes](../recipes/README.md#ci-configurations) for more details on specific CI environments.
In addition, you will need to configure the **semantic-release** [plugins](../usage/plugins.md#plugins) to disable the [`@semantic-release/npm`](https://github.com/semantic-release/npm) plugin which is used by default and use a plugin for your project type.
In addition you will need to configure the **semantic-release** [plugins](../usage/plugins.md#plugins) to disable the [`@semantic-release/npm`](https://github.com/semantic-release/npm) plugin which is used by default and use a plugin for your project type.
If there is no specific plugin for your project type you can use the [`@semantic-release/exec`](https://github.com/semantic-release/exec) plugin to publish the release with a shell command.
@@ -71,7 +71,7 @@ Here is a basic example to create [GitHub releases](https://help.github.com/arti
**Note**: This is a theoretical example where the command `set-version` update the project version with the value passed as its first argument and `publish-package` publishes the package to a registry.
See the [package managers and languages recipes](../recipes/release-workflow/README.md#package-managers-and-languages) for more details on specific project types.
See the [package managers and languages recipes](../recipes/README.md#package-managers-and-languages) for more details on specific project types.
## Can I use semantic-release with any CI service?
@@ -79,7 +79,7 @@ Yes, **semantic-release** can be used with any CI service, as long as it provide
- A way to set [authentication](../usage/ci-configuration.md#authentication) via environment variables
- A way to guarantee that the `semantic-release` command is [executed only after all the tests of all the jobs in the CI build pass](../usage/ci-configuration.md#run-semantic-release-only-after-all-tests-succeeded)
See the [CI configuration recipes](../recipes/release-workflow/README.md#ci-configurations) for more details on specific CI environments.
See the [CI configuration recipes](../recipes/README.md#ci-configurations) for more details on specific CI environments.
## Can I run semantic-release on my local machine rather than on a CI server?
@@ -95,7 +95,7 @@ However this is not the recommended approach, as running unit and integration te
Yes, with the [`@semantic-release/gitlab-config`](https://github.com/semantic-release/gitlab-config) shareable configuration.
See the [GitLab CI recipes](../recipes/ci-configurations/gitlab-ci.md#using-semantic-release-with-gitlab-ci) for the CI configuration.
See the [GitLab CI recipes](../recipes/gitlab-ci.md#using-semantic-release-with-gitlab-ci) for the CI configuration.
## Can I use semantic-release with any Git hosted environment?
@@ -153,7 +153,7 @@ Any npm compatible registry is supported with the [`@semantic-release/npm`](http
See [npm registry authentication](https://github.com/semantic-release/npm#npm-registry-authentication) for more details.
See [Artifactory - npm Registry](https://www.jfrog.com/confluence/display/RTF/Npm+Registry#NpmRegistry-AuthenticatingthenpmClient) documentation for Artifactory configuration.
See [Artifactory - npm Registry](https://www.jfrog.com/confluence/display/RTF/Npm+Registry#NpmRegistry-AuthenticatingthenpmClient) documentation for Artifactiry configuration.
## Can I manually trigger the release of a specific version?
@@ -194,15 +194,25 @@ 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.
If your project is under heavy development, with frequent breaking changes, and is not production ready yet we recommend [publishing pre-releases](../recipes/release-workflow/pre-releases.md#publishing-pre-releases).
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`.
## Can I trust semantic-release with my releases?
**semantic-release** has a full unit and integration test suite that tests `npm` publishes against the [verdaccio](https://www.npmjs.com/package/verdaccio).
**semantic-release** has a full unit and integration test suite that tests `npm` publishes against the [npm-registry-couchapp](https://github.com/npm/npm-registry-couchapp).
In addition, the [verify conditions step](../../README.md#release-steps) verifies that all necessary conditions for proceeding with a release are met, and a new release will be performed [only if all your tests pass](../usage/ci-configuration.md#run-semantic-release-only-after-all-tests-succeeded).
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 >= 14.17?
**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 14.17 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?
-4
View File
@@ -1,4 +0,0 @@
# Git version requirement
**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.
+5 -13
View File
@@ -1,21 +1,13 @@
# Node Support Policy
We will always support at least the latest [Long-Term Support](https://github.com/nodejs/Release) version of Node, but provide no promise of support for older versions.
The supported range will always be defined in the `engines.node` property of the `package.json` of our packages.
We only support [Long-Term Support](https://github.com/nodejs/Release) versions of Node starting with [Node 14.17.0 (LTS)](https://nodejs.org/en/blog/release/v14.17.0).
We specifically limit our support to LTS versions of Node, not because this package won't work on other versions, but because we have a limited amount of time, and supporting LTS offers the greatest return on that investment.
It's possible this package will work correctly on newer versions of Node.
It may even be possible to use this package on older versions of Node, though that's more unlikely as we'll make every effort to take advantage of features available in the oldest LTS version we support.
It's possible this package will work correctly on newer versions of Node. It may even be possible to use this package on older versions of Node, though that's more unlikely as we'll make every effort to take advantage of features available in the oldest LTS version we support.
As new Node LTS versions become available we may remove previous versions from the `engines.node` property of our package's `package.json` file.
Removing a Node version is considered a breaking change and will entail the publishing of a new major version of this package.
We will not accept any requests to support an end-of-life version of Node.
Any merge requests or issues supporting an end-of-life version of Node will be closed.
As each Node LTS version reaches its end-of-life we will remove that version from the node engines property of our package's package.json file. Removing a Node version is considered a breaking change and will entail the publishing of a new major version of this package. We will not accept any requests to support an end-of-life version of Node. Any merge requests or issues supporting an end-of-life version of Node will be closed.
We will accept code that allows this package to run on newer, non-LTS, versions of Node.
Furthermore, we will attempt to ensure our own changes work on the latest version of Node.
To help in that commitment, our continuous integration setup runs against all LTS versions of Node in addition the most recent Node release; called current.
We will accept code that allows this package to run on newer, non-LTS, versions of Node. Furthermore, we will attempt to ensure our own changes work on the latest version of Node. To help in that commitment, our continuous integration setup runs against all LTS versions of Node in addition the most recent Node release; called current.
JavaScript package managers should allow you to install this package with any version of Node, with, at most, a warning if your version of Node does not fall within the range specified by our node engines property.
If you encounter issues installing this package, please report the issue to your package manager.
JavaScript package managers should allow you to install this package with any version of Node, with, at most, a warning if your version of Node does not fall within the range specified by our node engines property. If you encounter issues installing this package, please report the issue to your package manager.
+12 -13
View File
@@ -1,38 +1,37 @@
# 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 Node version 14.17 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 14.17 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 version of Node that meets our version requirement.
**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 14.17 or higher.
See our [Node Support Policy](node-support-policy.md) for our long-term promise regarding Node version support.
## Recommended solution
### Run at least one CI job with a version of Node that meets our version requirement
### Run at least one CI job with Node >= 14.17
The recommended approach is to run the `semantic-release` command from a CI job running on the latest available LTS version of node.
This can either be a job used by your project to test on the latest Node LTS version 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 14.17 or higher.
This can either be a job used by your project to test on Node >= 14.17 or a dedicated job for the release steps.
See [CI configuration](../usage/ci-configuration.md) and [CI configuration recipes](../recipes/release-workflow/README.md#ci-configurations) for more details.
See [CI configuration](../usage/ci-configuration.md) and [CI configuration recipes](../recipes/README.md#ci-configurations) for more details.
## Alternative solutions
### Use `npx` to execute in the latest LTS version of Node
### Use `npx`
`npx` is included with npm >= 5.2 and can be used to download the latest [Node LTS package published on npm](https://www.npmjs.com/package/node).
`npx` is included with npm >= 5.2 and can be used to download the latest [Node 14 package published on npm](https://www.npmjs.com/package/node).
Use it to execute the `semantic-release` command.
```bash
$ npx -p node@lts -c "npx semantic-release"
$ npx -p node@14 -c "npx semantic-release"
```
**Note**: See [What is npx](./FAQ.md#what-is-npx) for more details.
**Note:**: See [What is npx](./FAQ.md#what-is-npx) for more details.
### Use `nvm`
If your CI environment provides [nvm](https://github.com/creationix/nvm) you can use it to switch to the latest LTS version of Node before running the `semantic-release` command.
If your CI environment provides [nvm](https://github.com/creationix/nvm) you can use it to switch to Node 14.17 before running the `semantic-release` command.
```bash
$ nvm install 'lts/*' && npx semantic-release
$ nvm install 14.17 && npx semantic-release
```
+1 -1
View File
@@ -65,5 +65,5 @@ To recover from that situation, do the following:
1. Delete the tag(s) for the release(s) that have been lost from the git history. You can delete each tag from remote using `git push origin :[TAG NAME]`, e.g. `git push origin :v2.0.0-beta.1`. You can delete tags locally using `git tag -d [TAG NAME]`, e.g. `git tag -d v2.0.0-beta.1`.
2. Re-create the tags locally: `git tag [TAG NAME] [COMMIT HASH]`, where `[COMMIT HASH]` is the new commit that created the release for the lost tag. E.g. `git tag v2.0.0-beta.1 abcdef0`
3. Re-create the git notes for each release tag, e.g. `git notes --ref semantic-release add -f -m '{"channels":["beta"]}' v2.0.0-beta.1`. If the release was also published in the default channel (usually `master`), then set the first channel to `null`, e.g. `git notes --ref semantic-release add -f -m '{"channels":[null, "beta"]}'`
3. Re-create the git notes for each release tag, e.g. `git notes --ref semantic-release add -f -m '{"channels":["beta"]}' v2.0.0-beta.1`. If the release was also published in the default channel (usually `master`), then set the first channel to `null`, e.g. `git notes --ref semantic-release add -f -m '{"channels":[null, "beta"]}'
4. Push the local notes: `git push --force origin refs/notes/semantic-release`. The `--force` is needed after the rebase. Be careful.
+4 -4
View File
@@ -13,7 +13,7 @@ Here is a few example of the CI services that can be used to achieve this:
- [Wercker Workflows](http://devcenter.wercker.com/docs/workflows)
- [GoCD Pipelines](https://docs.gocd.org/current/introduction/concepts_in_go.html#pipeline).
See [CI configuration recipes](../recipes/ci-configurations#ci-configurations) for more details.
See [CI configuration recipes](../recipes/README.md#ci-configurations) for more details.
## Authentication
@@ -26,10 +26,10 @@ See [CI configuration recipes](../recipes/ci-configurations#ci-configurations) f
| `GH_TOKEN` or `GITHUB_TOKEN` | A GitHub [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line). |
| `GL_TOKEN` or `GITLAB_TOKEN` | A GitLab [personal access token](https://docs.gitlab.com/ce/user/profile/personal_access_tokens.html). |
| `BB_TOKEN` or `BITBUCKET_TOKEN` | A Bitbucket [personal access token](https://confluence.atlassian.com/bitbucketserver/personal-access-tokens-939515499.html). |
| `BB_TOKEN_BASIC_AUTH` or `BITBUCKET_TOKEN_BASIC_AUTH` | A Bitbucket [personal access token](https://confluence.atlassian.com/bitbucketserver/personal-access-tokens-939515499.html) with basic auth support. For clarification `user:token` has to be the value of this env. |
| `BB_TOKEN_BASIC_AUTH` or `BITBUCKET_TOKEN_BASIC_AUTH` | A Bitbucket [personal access token](https://confluence.atlassian.com/bitbucketserver/personal-access-tokens-939515499.html) with basic auth support. For clearification `user:token` has to be the value of this env. |
| `GIT_CREDENTIALS` | [URL encoded](https://en.wikipedia.org/wiki/Percent-encoding) Git username and password in the format `<username>:<password>`. The username and password must each be individually URL encoded, not the `:` separating them. |
Alternatively the Git authentication can be set up via [SSH keys](../recipes/git-hosted-services/git-auth-ssh-keys.md).
Alternatively the Git authentication can be set up via [SSH keys](../recipes/git-auth-ssh-keys.md).
### Authentication for plugins
@@ -44,6 +44,6 @@ See each plugin's documentation for the environment variables required.
The authentication token/credentials have to be made available in the CI service via environment variables.
See [CI configuration recipes](../recipes/ci-configurations#ci-configurations) for more details on how to configure environment variables in your CI service.
See [CI configuration recipes](../recipes/README.md#ci-configurations) for more details on how to configure environment variables in your CI service.
**Note**: The environment variables `GH_TOKEN`, `GITHUB_TOKEN`, `GL_TOKEN` and `GITLAB_TOKEN` can be used for both the Git authentication and the API authentication required by [@semantic-release/github](https://github.com/semantic-release/github) and [@semantic-release/gitlab](https://github.com/semantic-release/gitlab).
+3 -3
View File
@@ -69,8 +69,8 @@ The branches on which releases should happen. By default **semantic-release** wi
- regular releases to a distribution channel matching the branch name from any existing branch with a name matching a maintenance release range (`N.N.x` or `N.x.x` or `N.x` with `N` being a number)
- regular releases to the `next` distribution channel from the branch `next` if it exists
- regular releases to the `next-major` distribution channel from the branch `next-major` if it exists
- pre-releases to the `beta` distribution channel from the branch `beta` if it exists
- pre-releases to the `alpha` distribution channel from the branch `alpha` if it exists
- prereleases to the `beta` distribution channel from the branch `beta` if it exists
- prereleases to the `alpha` distribution channel from the branch `alpha` if it exists
**Note**: If your repository does not have a release branch, then **semantic-release** will fail with an `ERELEASEBRANCHES` error message. If you are using the default configuration, you can fix this error by pushing a `master` branch.
@@ -116,7 +116,7 @@ Type: `Boolean`<br>
Default: `false` if running in a CI environment, `true` otherwise<br>
CLI arguments: `-d`, `--dry-run`
The objective of the dry-run mode is to get a preview of the pending release. Dry-run mode skips the following steps: prepare, publish, addChannel, success and fail. In addition to this it prints the next version and release notes to the console.
The objective of the dry-run mode is to get a preview of the pending release. Dry-run mode skips the following steps: prepare, publish, success and fail. In addition to this it prints the next version and release notes to the console.
**Note**: The Dry-run mode verifies the repository push permission, even though nothing will be pushed. The verification is done to help user to figure out potential configuration issues.
+3 -5
View File
@@ -24,9 +24,7 @@ For other type of projects we recommend installing **semantic-release** directly
$ npx semantic-release
```
**Note**: For a global installation, it's recommended to specify the major **semantic-release** version to install (for example with `npx semantic-release@18`).
This way your build will not automatically use the next major **semantic-release** release that could possibly break your build.
You will have to upgrade manually when a new major version is released.
**Note**: For a global installation, it's recommended to specify the major **semantic-release** version to install (for example with with `npx semantic-release@18`).
This way your build will not automatically use the next major **semantic-release** release that could possibly break your build. You will have to upgrade manually when a new major version is released.
**Note**: `npx` is a tool bundled with `npm@>=5.2.0`. It is used to conveniently install the semantic-release binary and to execute it.
See [What is npx](../support/FAQ.md#what-is-npx) for more details.
**Note**: `npx` is a tool bundled with `npm@>=5.2.0`. It is used to conveniently install the semantic-release binary and to execute it. See [What is npx](../support/FAQ.md#what-is-npx) for more details.
+6 -6
View File
@@ -1,12 +1,12 @@
# Workflow configuration
**semantic-release** allow to manage and automate complex release workflow, based on multiple Git branches and distribution channels. This allow to:
- Distribute certain releases to a particular group of users via distribution channels
- Distributes certain releases to a particular group of users via distribution channels
- Manage the availability of releases on distribution channels via branches merge
- Maintain multiple lines of releases in parallel
- Work on large future releases outside the normal flow of one version increment per Git push
See [Release workflow recipes](../recipes/release-workflow/README.md#release-workflow) for detailed examples.
See [Release workflow recipes](../recipes/README.md#release-workflow) for detailed examples.
The release workflow is configured via the [branches option](./configuration.md#branches) which accepts a single or an array of branch definitions.
Each branch can be defined either as a string, a [glob](https://github.com/micromatch/micromatch#matching-features) or an object. For string and glob definitions each [property](#branches-properties) will be defaulted.
@@ -91,7 +91,7 @@ For example the configuration `['master', {name: 'pre/rc', prerelease: '${name.r
branches: [
{name: 'master'},
{name: 'pre/rc', channel: 'pre/rc', prerelease: 'rc'}, // `prerelease` is built with the template `${name.replace(/^pre\\//g, "")}`
{name: 'beta', channel: 'beta', prerelease: true}, // `prerelease` is set to `beta` as it is the value of `name`
{name: 'beta', channel: 'beta', prerelease: 'beta'}, // `prerelease` is set to `beta` as it is the value of `name`
]
}
```
@@ -108,7 +108,7 @@ A project must define a minimum of 1 release branch and can have a maximum of 3.
**Note:** With **semantic-release** as with most package managers, a release version must be unique, independently of the distribution channel on which it is available.
See [publishing on distribution channels recipe](../recipes/release-workflow/distribution-channels.md) for a detailed example.
See [publishing on distribution channels recipe](../recipes/distribution-channels.md) for a detailed example.
#### Pushing to a release branch
@@ -142,7 +142,7 @@ Maintenance branches are always considered lower than [release branches](#releas
**semantic-release** will automatically add releases to the corresponding distribution channel when code is [merged from a release or maintenance branch to another maintenance branch](#merging-into-a-maintenance-branch), however only versions within the branch `range` can be merged. If a merged version is outside the maintenance branch `range`, **semantic-release** will not add to the corresponding channel and will throw an `EINVALIDMAINTENANCEMERGE` error.
See [publishing maintenance releases recipe](../recipes/release-workflow/maintenance-releases.md) for a detailed example.
See [publishing maintenance releases recipe](../recipes/maintenance-releases.md) for a detailed example.
#### Pushing to a maintenance branch
@@ -171,7 +171,7 @@ A pre-release branch is characterized by the `prerelease` property that defines
When merging commits associated with an existing release, **semantic-release** will treat them as [pushed commits](#pushing-to-a-pre-release-branch) and publish a new release if necessary, but it will never add those releases to the distribution channel corresponding to the pre-release branch.
See [publishing pre-releases recipe](../recipes/release-workflow/pre-releases.md) for a detailed example.
See [publishing pre-releases recipe](../recipes/pre-releases.md) for a detailed example.
#### Pushing to a pre-release branch
+32 -38
View File
@@ -1,35 +1,30 @@
const {pick} = require('lodash');
const marked = require('marked');
const envCi = require('env-ci');
const hookStd = require('hook-std');
const semver = require('semver');
const AggregateError = require('aggregate-error');
const pkg = require('./package.json');
const hideSensitive = require('./lib/hide-sensitive');
const getConfig = require('./lib/get-config');
const verify = require('./lib/verify');
const getNextVersion = require('./lib/get-next-version');
const getCommits = require('./lib/get-commits');
const getLastRelease = require('./lib/get-last-release');
const getReleaseToAdd = require('./lib/get-release-to-add');
const {extractErrors, makeTag} = require('./lib/utils');
const getGitAuthUrl = require('./lib/get-git-auth-url');
const getBranches = require('./lib/branches');
const getLogger = require('./lib/get-logger');
const {verifyAuth, isBranchUpToDate, getGitHead, tag, push, pushNotes, getTagHead, addNote} = require('./lib/git');
const getError = require('./lib/get-error');
const {COMMIT_NAME, COMMIT_EMAIL} = require('./lib/definitions/constants');
import lodash from 'lodash'
const {pick} = lodash
import marked from 'marked';
import TerminalRenderer from 'marked-terminal';
import envCi from 'env-ci';
import hookStd from 'hook-std';
import semver from 'semver';
import AggregateError from 'aggregate-error';
import pkg from './package.json';
import hideSensitive from './lib/hide-sensitive';
import getConfig from './lib/get-config';
import verify from './lib/verify';
import getNextVersion from './lib/get-next-version';
import getCommits from './lib/get-commits';
import getLastRelease from './lib/get-last-release';
import getReleaseToAdd from './lib/get-release-to-add';
import {extractErrors, makeTag} from './lib/utils';
import getGitAuthUrl from './lib/get-git-auth-url';
import getBranches from './lib/branches';
import getLogger from './lib/get-logger';
let markedOptionsSet = false;
async function terminalOutput(text) {
if (!markedOptionsSet) {
const {default: TerminalRenderer} = await import('marked-terminal'); // eslint-disable-line node/no-unsupported-features/es-syntax
marked.setOptions({renderer: new TerminalRenderer()});
markedOptionsSet = true;
}
import {verifyAuth, isBranchUpToDate, getGitHead, tag, push, pushNotes, getTagHead, addNote} from './lib/git';
return marked.parse(text);
}
import getError from './lib/get-error';
import {COMMIT_NAME, COMMIT_EMAIL} from './lib/definitions/constants';
marked.setOptions({renderer: new TerminalRenderer()});
/* eslint complexity: off */
async function run(context, plugins) {
@@ -75,7 +70,7 @@ async function run(context, plugins) {
}
logger[options.dryRun ? 'warn' : 'success'](
`Run automated release from branch ${ciBranch} on repository ${options.originalRepositoryURL}${
`Run automated release from branch ${ciBranch} on repository ${options.repositoryUrl}${
options.dryRun ? ' in dry-run mode' : ''
}`
);
@@ -215,20 +210,20 @@ async function run(context, plugins) {
if (options.dryRun) {
logger.log(`Release note for version ${nextRelease.version}:`);
if (nextRelease.notes) {
context.stdout.write(await terminalOutput(nextRelease.notes));
context.stdout.write(marked(nextRelease.notes));
}
}
return pick(context, ['lastRelease', 'commits', 'nextRelease', 'releases']);
}
async function logErrors({logger, stderr}, err) {
function logErrors({logger, stderr}, err) {
const errors = extractErrors(err).sort((error) => (error.semanticRelease ? -1 : 0));
for (const error of errors) {
if (error.semanticRelease) {
logger.error(`${error.code} ${error.message}`);
if (error.details) {
stderr.write(await terminalOutput(error.details)); // eslint-disable-line no-await-in-loop
stderr.write(marked(error.details));
}
} else {
logger.error('An error occurred while running semantic-release: %O', error);
@@ -242,12 +237,12 @@ async function callFail(context, plugins, err) {
try {
await plugins.fail({...context, errors});
} catch (error) {
await logErrors(context, error);
logErrors(context, error);
}
}
}
module.exports = async (cliOptions = {}, {cwd = process.cwd(), env = process.env, stdout, stderr} = {}) => {
export default async (cliOptions = {}, {cwd = process.cwd(), env = process.env, stdout, stderr} = {}) => {
const {unhook} = hookStd(
{silent: false, streams: [process.stdout, process.stderr, stdout, stderr].filter(Boolean)},
hideSensitive(env)
@@ -263,7 +258,6 @@ module.exports = async (cliOptions = {}, {cwd = process.cwd(), env = process.env
context.logger.log(`Running ${pkg.name} version ${pkg.version}`);
try {
const {plugins, options} = await getConfig(context, cliOptions);
options.originalRepositoryURL = options.repositoryUrl;
context.options = options;
try {
const result = await run(context, plugins);
@@ -274,7 +268,7 @@ module.exports = async (cliOptions = {}, {cwd = process.cwd(), env = process.env
throw error;
}
} catch (error) {
await logErrors(context, error);
logErrors(context, error);
unhook();
throw error;
}
+5 -4
View File
@@ -1,8 +1,9 @@
const {isString, remove, omit, mapValues, template} = require('lodash');
const micromatch = require('micromatch');
const {getBranches} = require('../git');
import lodash from 'lodash'
const {isString, remove, omit, mapValues, template} = lodash
import micromatch from 'micromatch';
import {getBranches} from '../git.js';
module.exports = async (repositoryUrl, {cwd}, branches) => {
export default async (repositoryUrl, {cwd}, branches) => {
const gitBranches = await getBranches(repositoryUrl, {cwd});
return branches.reduce(
+8 -6
View File
@@ -1,10 +1,12 @@
const {template, escapeRegExp} = require('lodash');
const semver = require('semver');
const pReduce = require('p-reduce');
const debug = require('debug')('semantic-release:get-tags');
const {getTags, getNote} = require('../../lib/git');
import lodash from 'lodash'
const {template, escapeRegExp} = lodash
import semver from 'semver';
import pReduce from 'p-reduce';
import debugFactory from 'debug';
const debug = debugFactory('semantic-release:get-tags');
import {getTags, getNote} from '../../lib/git.js';
module.exports = async ({cwd, env, options: {tagFormat}}, branches) => {
export default async ({cwd, env, options: {tagFormat}}, branches) => {
// 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,
+11 -11
View File
@@ -1,14 +1,15 @@
const {isString, isRegExp} = require('lodash');
const AggregateError = require('aggregate-error');
const pEachSeries = require('p-each-series');
const DEFINITIONS = require('../definitions/branches');
const getError = require('../get-error');
const {fetch, fetchNotes, verifyBranchName} = require('../git');
const expand = require('./expand');
const getTags = require('./get-tags');
const normalize = require('./normalize');
import lodash from 'lodash'
const {isString, isRegExp} = lodash
import AggregateError from 'aggregate-error';
import pEachSeries from 'p-each-series';
import DEFINITIONS from '../definitions/branches.js';
import getError from '../get-error.js';
import {fetch, fetchNotes, verifyBranchName} from '../git.js';
import expand from './expand.js';
import getTags from './get-tags.js';
import normalize from './normalize.js';
module.exports = async (repositoryUrl, ciBranch, context) => {
export default async (repositoryUrl, ciBranch, context) => {
const {cwd, env} = context;
const remoteBranches = await expand(
@@ -27,7 +28,6 @@ module.exports = async (repositoryUrl, ciBranch, context) => {
const errors = [];
const branchesByType = Object.entries(DEFINITIONS).reduce(
// eslint-disable-next-line unicorn/no-fn-reference-in-iterator
(branchesByType, [type, {filter}]) => ({[type]: branches.filter(filter), ...branchesByType}),
{}
);
+15 -6
View File
@@ -1,7 +1,9 @@
const {sortBy, isNil} = require('lodash');
const semverDiff = require('semver-diff');
const {FIRST_RELEASE, RELEASE_TYPE} = require('../definitions/constants');
const {
import lodash from 'lodash'
const {sortBy, isNil} = lodash
import semverDiff from 'semver-diff';
import {FIRST_RELEASE, RELEASE_TYPE} from '../definitions/constants.js';
import {
tagsToVersions,
isMajorRange,
getUpperBound,
@@ -11,7 +13,7 @@ const {
getLatestVersion,
getFirstVersion,
getRange,
} = require('../utils');
} from '../utils.js';
function maintenance({maintenance, release}) {
return sortBy(
@@ -103,4 +105,11 @@ function prerelease({prerelease}) {
});
}
module.exports = {maintenance, release, prerelease};
const exported = {
maintenance,
release,
prerelease,
};
export default exported;
export {maintenance, release, prerelease};
+12 -5
View File
@@ -1,6 +1,7 @@
const {isNil, uniqBy} = require('lodash');
const semver = require('semver');
const {isMaintenanceRange} = require('../utils');
import lodash from 'lodash'
const {isNil, uniqBy} = lodash
import semver from 'semver';
import {isMaintenanceRange} from '../utils.js';
const maintenance = {
filter: ({name, range}) => (!isNil(range) && range !== false) || isMaintenanceRange(name),
@@ -16,9 +17,15 @@ const prerelease = {
};
const release = {
// eslint-disable-next-line unicorn/no-fn-reference-in-iterator
filter: (branch) => !maintenance.filter(branch) && !prerelease.filter(branch),
branchesValidator: (branches) => branches.length <= 3 && branches.length > 0,
};
module.exports = {maintenance, prerelease, release};
const exported = {
maintenance,
prerelease,
release,
};
export default exported;
export {maintenance, prerelease, release};
+14 -1
View File
@@ -16,7 +16,20 @@ const SECRET_MIN_SIZE = 5;
const GIT_NOTE_REF = 'semantic-release';
module.exports = {
const exported = {
RELEASE_TYPE,
FIRST_RELEASE,
FIRSTPRERELEASE,
COMMIT_NAME,
COMMIT_EMAIL,
RELEASE_NOTES_SEPARATOR,
SECRET_REPLACEMENT,
SECRET_MIN_SIZE,
GIT_NOTE_REF,
};
export default exported;
export {
RELEASE_TYPE,
FIRST_RELEASE,
FIRSTPRERELEASE,
+54 -5
View File
@@ -1,7 +1,8 @@
const {inspect} = require('util');
const {toLower, isString, trim} = require('lodash');
const pkg = require('../../package.json');
const {RELEASE_TYPE} = require('./constants');
import {inspect} from 'util';
import lodash from 'lodash'
const {toLower, isString, trim} = lodash
import pkg from '../../package.json';
import {RELEASE_TYPE} from './constants.js';
const [homepage] = pkg.homepage.split('#');
const stringify = (object) =>
@@ -10,7 +11,7 @@ const linkify = (file) => `${homepage}/blob/master/${file}`;
const wordsList = (words) =>
`${words.slice(0, -1).join(', ')}${words.length > 1 ? ` or ${words[words.length - 1]}` : trim(words[0])}`;
module.exports = {
const exported = {
ENOGITREPO: ({cwd}) => ({
message: 'Not running from a git repository.',
details: `The \`semantic-release\` command must be executed from a Git repository.
@@ -19,6 +20,7 @@ The current working directory is \`${cwd}\`.
Please verify your CI configuration to make sure the \`semantic-release\` command is executed from the root of the cloned repository.`,
}),
ENOREPOURL: () => ({
message: 'The `repositoryUrl` option is required.',
details: `The [repositoryUrl option](${linkify(
@@ -29,6 +31,7 @@ Please make sure to add the \`repositoryUrl\` to the [semantic-release configura
'docs/usage/configuration.md'
)}).`,
}),
EGITNOPERMISSION: ({options: {repositoryUrl}, branch: {name}}) => ({
message: 'Cannot push to the Git repository.',
details: `**semantic-release** cannot push the version tag to the branch \`${name}\` on the remote Git repository with URL \`${repositoryUrl}\`.
@@ -40,6 +43,7 @@ This can be caused by:
'docs/usage/ci-configuration.md#authentication'
)})`,
}),
EINVALIDTAGFORMAT: ({options: {tagFormat}}) => ({
message: 'Invalid `tagFormat` option.',
details: `The [tagFormat](${linkify(
@@ -48,6 +52,7 @@ This can be caused by:
Your configuration for the \`tagFormat\` option is \`${stringify(tagFormat)}\`.`,
}),
ETAGNOVERSION: ({options: {tagFormat}}) => ({
message: 'Invalid `tagFormat` option.',
details: `The [tagFormat](${linkify(
@@ -56,6 +61,7 @@ Your configuration for the \`tagFormat\` option is \`${stringify(tagFormat)}\`.`
Your configuration for the \`tagFormat\` option is \`${stringify(tagFormat)}\`.`,
}),
EPLUGINCONF: ({type, required, pluginConf}) => ({
message: `The \`${type}\` plugin configuration is invalid.`,
details: `The [${type} plugin configuration](${linkify(`docs/usage/plugins.md#${toLower(type)}-plugin`)}) ${
@@ -64,6 +70,7 @@ Your configuration for the \`tagFormat\` option is \`${stringify(tagFormat)}\`.`
Your configuration for the \`${type}\` plugin is \`${stringify(pluginConf)}\`.`,
}),
EPLUGINSCONF: ({plugin}) => ({
message: 'The `plugins` configuration is invalid.',
details: `The [plugins](${linkify(
@@ -72,6 +79,7 @@ Your configuration for the \`${type}\` plugin is \`${stringify(pluginConf)}\`.`,
The invalid configuration is \`${stringify(plugin)}\`.`,
}),
EPLUGIN: ({pluginName, type}) => ({
message: `A plugin configured in the step ${type} is not a valid semantic-release plugin.`,
details: `A valid \`${type}\` **semantic-release** plugin must be a function or an object with a function in the property \`${type}\`.
@@ -82,6 +90,7 @@ Please refer to the \`${pluginName}\` and [semantic-release plugins configuratio
'docs/usage/plugins.md'
)}) documentation for more details.`,
}),
EANALYZECOMMITSOUTPUT: ({result, pluginName}) => ({
message: 'The `analyzeCommits` plugin returned an invalid value. It must return a valid semver release type.',
details: `The \`analyzeCommits\` plugin must return a valid [semver](https://semver.org) release type. The valid values are: ${RELEASE_TYPE.map(
@@ -98,6 +107,7 @@ We recommend to report the issue to the \`${pluginName}\` authors, providing the
'docs/developer-guide/plugin.md'
)})`,
}),
EGENERATENOTESOUTPUT: ({result, pluginName}) => ({
message: 'The `generateNotes` plugin returned an invalid value. It must return a `String`.',
details: `The \`generateNotes\` plugin must return a \`String\`.
@@ -112,6 +122,7 @@ We recommend to report the issue to the \`${pluginName}\` authors, providing the
'docs/developer-guide/plugin.md'
)})`,
}),
EPUBLISHOUTPUT: ({result, pluginName}) => ({
message: 'A `publish` plugin returned an invalid value. It must return an `Object`.',
details: `The \`publish\` plugins must return an \`Object\`.
@@ -126,6 +137,7 @@ We recommend to report the issue to the \`${pluginName}\` authors, providing the
'docs/developer-guide/plugin.md'
)})`,
}),
EADDCHANNELOUTPUT: ({result, pluginName}) => ({
message: 'A `addChannel` plugin returned an invalid value. It must return an `Object`.',
details: `The \`addChannel\` plugins must return an \`Object\`.
@@ -140,6 +152,7 @@ We recommend to report the issue to the \`${pluginName}\` authors, providing the
'docs/developer-guide/plugin.md'
)})`,
}),
EINVALIDBRANCH: ({branch}) => ({
message: 'A branch is invalid in the `branches` configuration.',
details: `Each branch in the [branches configuration](${linkify(
@@ -148,6 +161,7 @@ We recommend to report the issue to the \`${pluginName}\` authors, providing the
Your configuration for the problematic branch is \`${stringify(branch)}\`.`,
}),
EINVALIDBRANCHNAME: ({branch}) => ({
message: 'A branch name is invalid in the `branches` configuration.',
details: `Each branch in the [branches configuration](${linkify(
@@ -156,6 +170,7 @@ Your configuration for the problematic branch is \`${stringify(branch)}\`.`,
Your configuration for the problematic branch is \`${stringify(branch)}\`.`,
}),
EDUPLICATEBRANCHES: ({duplicates}) => ({
message: 'The `branches` configuration has duplicate branches.',
details: `Each branch in the [branches configuration](${linkify(
@@ -164,6 +179,7 @@ Your configuration for the problematic branch is \`${stringify(branch)}\`.`,
Your configuration contains duplicates for the following branch names: \`${stringify(duplicates)}\`.`,
}),
EMAINTENANCEBRANCH: ({branch}) => ({
message: 'A maintenance branch is invalid in the `branches` configuration.',
details: `Each maintenance branch in the [branches configuration](${linkify(
@@ -172,6 +188,7 @@ Your configuration contains duplicates for the following branch names: \`${strin
Your configuration for the problematic branch is \`${stringify(branch)}\`.`,
}),
EMAINTENANCEBRANCHES: ({branches}) => ({
message: 'The maintenance branches are invalid in the `branches` configuration.',
details: `Each maintenance branch in the [branches configuration](${linkify(
@@ -180,6 +197,7 @@ Your configuration for the problematic branch is \`${stringify(branch)}\`.`,
Your configuration for the problematic branches is \`${stringify(branches)}\`.`,
}),
ERELEASEBRANCHES: ({branches}) => ({
message: 'The release branches are invalid in the `branches` configuration.',
details: `A minimum of 1 and a maximum of 3 release branches are required in the [branches configuration](${linkify(
@@ -190,6 +208,7 @@ This may occur if your repository does not have a release branch, such as \`mast
Your configuration for the problematic branches is \`${stringify(branches)}\`.`,
}),
EPRERELEASEBRANCH: ({branch}) => ({
message: 'A pre-release branch configuration is invalid in the `branches` configuration.',
details: `Each pre-release branch in the [branches configuration](${linkify(
@@ -198,6 +217,7 @@ Your configuration for the problematic branches is \`${stringify(branches)}\`.`,
Your configuration for the problematic branch is \`${stringify(branch)}\`.`,
}),
EPRERELEASEBRANCHES: ({branches}) => ({
message: 'The pre-release branches are invalid in the `branches` configuration.',
details: `Each pre-release branch in the [branches configuration](${linkify(
@@ -206,6 +226,7 @@ Your configuration for the problematic branch is \`${stringify(branch)}\`.`,
Your configuration for the problematic branches is \`${stringify(branches)}\`.`,
}),
EINVALIDNEXTVERSION: ({nextRelease: {version}, branch: {name, range}, commits, validBranches}) => ({
message: `The release \`${version}\` on branch \`${name}\` cannot be published as it is out of range.`,
details: `Based on the releases published on other branches, only versions within the range \`${range}\` can be published from branch \`${name}\`.
@@ -221,6 +242,7 @@ A valid branch could be ${wordsList(validBranches.map(({name}) => `\`${name}\``)
See the [workflow configuration documentation](${linkify('docs/usage/workflow-configuration.md')}) for more details.`,
}),
EINVALIDMAINTENANCEMERGE: ({nextRelease: {channel, gitTag, version}, branch: {mergeRange, name}}) => ({
message: `The release \`${version}\` on branch \`${name}\` cannot be published as it is out of range.`,
details: `Only releases within the range \`${mergeRange}\` can be merged into the maintenance branch \`${name}\` and published to the \`${channel}\` distribution channel.
@@ -230,3 +252,30 @@ The branch \`${name}\` head should be [reset](https://git-scm.com/docs/git-reset
See the [workflow configuration documentation](${linkify('docs/usage/workflow-configuration.md')}) for more details.`,
}),
};
export default exported;
export const {
ENOGITREPO,
ENOREPOURL,
EGITNOPERMISSION,
EINVALIDTAGFORMAT,
ETAGNOVERSION,
EPLUGINCONF,
EPLUGINSCONF,
EPLUGIN,
EANALYZECOMMITSOUTPUT,
EGENERATENOTESOUTPUT,
EPUBLISHOUTPUT,
EADDCHANNELOUTPUT,
EINVALIDBRANCH,
EINVALIDBRANCHNAME,
EDUPLICATEBRANCHES,
EMAINTENANCEBRANCH,
EMAINTENANCEBRANCHES,
ERELEASEBRANCHES,
EPRERELEASEBRANCH,
EPRERELEASEBRANCHES,
EINVALIDNEXTVERSION,
EINVALIDMAINTENANCEMERGE,
} = exported;
+29 -7
View File
@@ -1,17 +1,18 @@
/* eslint require-atomic-updates: off */
import lodash from 'lodash'
const {isString, isPlainObject} = lodash
const {isString, isPlainObject} = require('lodash');
const {getGitHead} = require('../git');
const hideSensitive = require('../hide-sensitive');
const {hideSensitiveValues} = require('../utils');
const {RELEASE_TYPE, RELEASE_NOTES_SEPARATOR} = require('./constants');
import {getGitHead} from '../git.js';
import hideSensitive from '../hide-sensitive.js';
import {hideSensitiveValues} from '../utils.js';
import {RELEASE_TYPE, RELEASE_NOTES_SEPARATOR} from './constants.js';
module.exports = {
const exported = {
verifyConditions: {
required: false,
dryRun: true,
pipelineConfig: () => ({settleAll: true}),
},
analyzeCommits: {
default: ['@semantic-release/commit-analyzer'],
required: true,
@@ -29,11 +30,13 @@ module.exports = {
}, -1)
],
},
verifyRelease: {
required: false,
dryRun: true,
pipelineConfig: () => ({settleAll: true}),
},
generateNotes: {
required: false,
dryRun: true,
@@ -49,6 +52,7 @@ module.exports = {
}),
postprocess: (results, {env}) => hideSensitive(env)(results.filter(Boolean).join(RELEASE_NOTES_SEPARATOR)),
},
prepare: {
required: false,
dryRun: false,
@@ -67,6 +71,7 @@ module.exports = {
},
}),
},
publish: {
required: false,
dryRun: false,
@@ -80,6 +85,7 @@ module.exports = {
}),
}),
},
addChannel: {
required: false,
dryRun: false,
@@ -93,12 +99,14 @@ module.exports = {
}),
}),
},
success: {
required: false,
dryRun: false,
pipelineConfig: () => ({settleAll: true}),
preprocess: ({releases, env, ...inputs}) => ({...inputs, env, releases: hideSensitiveValues(env, releases)}),
},
fail: {
required: false,
dryRun: false,
@@ -106,3 +114,17 @@ module.exports = {
preprocess: ({errors, env, ...inputs}) => ({...inputs, env, errors: hideSensitiveValues(env, errors)}),
},
};
export default exported;
export const {
verifyConditions,
analyzeCommits,
verifyRelease,
generateNotes,
prepare,
publish,
addChannel,
success,
fail,
} = exported;
+4 -3
View File
@@ -1,5 +1,6 @@
const debug = require('debug')('semantic-release:get-commits');
const {getCommits} = require('./git');
import debugFactory from 'debug';
const debug = debugFactory('semantic-release:get-commits');
import {getCommits} from './git.js';
/**
* Retrieve the list of commits on the current branch since the commit sha associated with the last release, or all the commits of the current branch if there is no last released version.
@@ -8,7 +9,7 @@ const {getCommits} = require('./git');
*
* @return {Promise<Array<Object>>} The list of commits on the branch `branch` since the last release.
*/
module.exports = async ({cwd, env, lastRelease: {gitHead: from}, nextRelease: {gitHead: to = 'HEAD'} = {}, logger}) => {
export default async ({cwd, env, lastRelease: {gitHead: from}, nextRelease: {gitHead: to = 'HEAD'} = {}, logger}) => {
if (from) {
debug('Use from: %s', from);
} else {
+12 -10
View File
@@ -1,16 +1,18 @@
const {castArray, pickBy, isNil, isString, isPlainObject} = require('lodash');
const readPkgUp = require('read-pkg-up');
const {cosmiconfig} = require('cosmiconfig');
const resolveFrom = require('resolve-from');
const debug = require('debug')('semantic-release:config');
const {repoUrl} = require('./git');
const PLUGINS_DEFINITIONS = require('./definitions/plugins');
const plugins = require('./plugins');
const {validatePlugin, parseConfig} = require('./plugins/utils');
import lodash from 'lodash'
const {castArray, pickBy, isNil, isString, isPlainObject} = lodash
import readPkgUp from 'read-pkg-up';
import {cosmiconfig} from 'cosmiconfig';
import resolveFrom from 'resolve-from';
import debugFactory from 'debug';
const debug = debugFactory('semantic-release:config');
import {repoUrl} from './git.js';
import PLUGINS_DEFINITIONS from './definitions/plugins.js';
import plugins from './plugins';
import {validatePlugin, parseConfig} from './plugins/utils.js';
const CONFIG_NAME = 'release';
module.exports = async (context, cliOptions) => {
export default async (context, cliOptions) => {
const {cwd, env} = context;
const {config, filepath} = (await cosmiconfig(CONFIG_NAME).search(cwd)) || {};
+3 -3
View File
@@ -1,7 +1,7 @@
const SemanticReleaseError = require('@semantic-release/error');
const ERROR_DEFINITIONS = require('./definitions/errors');
import SemanticReleaseError from '@semantic-release/error';
import ERROR_DEFINITIONS from './definitions/errors.js';
module.exports = (code, ctx = {}) => {
export default (code, ctx = {}) => {
const {message, details} = ERROR_DEFINITIONS[code](ctx);
return new SemanticReleaseError(message, code, details);
};
+11 -9
View File
@@ -1,8 +1,10 @@
const {parse, format} = require('url'); // eslint-disable-line node/no-deprecated-api
const {isNil} = require('lodash');
const hostedGitInfo = require('hosted-git-info');
const {verifyAuth} = require('./git');
const debug = require('debug')('semantic-release:get-git-auth-url');
import {format} from 'url';
import lodash from 'lodash'
const {isNil} = lodash
import hostedGitInfo from 'hosted-git-info';
import {verifyAuth} from './git.js';
import debugFactory from 'debug';
const debug = debugFactory('semantic-release:get-git-auth-url');
/**
* Machinery to format a repository URL with the given credentials
@@ -16,7 +18,7 @@ const debug = require('debug')('semantic-release:get-git-auth-url');
function formatAuthUrl(protocol, repositoryUrl, gitCredentials) {
const [match, auth, host, basePort, path] =
/^(?!.+:\/\/)(?:(?<auth>.*)@)?(?<host>.*?):(?<port>\d+)?:?\/?(?<path>.*)$/.exec(repositoryUrl) || [];
const {port, hostname, ...parsed} = parse(
const {port, hostname, ...parsed} = new URL(
match ? `ssh://${auth ? `${auth}@` : ''}${host}${basePort ? `:${basePort}` : ''}/${path}` : repositoryUrl
);
@@ -57,7 +59,7 @@ async function ensureValidAuthUrl({cwd, env, branch}, authUrl) {
*
* @return {String} The formatted Git repository URL.
*/
module.exports = async (context) => {
export default async (context) => {
const {cwd, env, branch} = context;
const GIT_TOKENS = {
GIT_CREDENTIALS: undefined,
@@ -75,7 +77,7 @@ module.exports = async (context) => {
let {repositoryUrl} = context.options;
const info = hostedGitInfo.fromUrl(repositoryUrl, {noGitPlus: true});
const {protocol, ...parsed} = parse(repositoryUrl);
const {protocol, ...parsed} = new URL(repositoryUrl);
if (info && info.getDefaultRepresentation() === 'shortcut') {
// Expand shorthand URLs (such as `owner/repo` or `gitlab:owner/repo`)
@@ -89,7 +91,7 @@ module.exports = async (context) => {
try {
debug('Verifying ssh auth by attempting to push to %s', repositoryUrl);
await verifyAuth(repositoryUrl, branch.name, {cwd, env});
} catch {
} catch (_) {
debug('SSH key auth failed, falling back to https.');
const envVars = Object.keys(GIT_TOKENS).filter((envVar) => !isNil(env[envVar]));
+5 -4
View File
@@ -1,6 +1,7 @@
const {isUndefined} = require('lodash');
const semver = require('semver');
const {makeTag, isSameChannel} = require('./utils');
import lodash from 'lodash'
const {isUndefined} = lodash
import semver from 'semver';
import {makeTag, isSameChannel} from './utils.js';
/**
* Last release.
@@ -26,7 +27,7 @@ const {makeTag, isSameChannel} = require('./utils');
*
* @return {LastRelease} The last tagged release or empty object if none is found.
*/
module.exports = ({branch, options: {tagFormat}}, {before} = {}) => {
export default ({branch, options: {tagFormat}}, {before} = {}) => {
const [{version, gitTag, channels} = {}] = branch.tags
.filter(
(tag) =>
+3 -3
View File
@@ -1,7 +1,7 @@
const {Signale} = require('signale');
const figures = require('figures');
import {Signale} from 'signale';
import figures from 'figures';
module.exports = ({stdout, stderr}) =>
export default ({stdout, stderr}) =>
new Signale({
config: {displayTimestamp: true, underlineMessage: false, displayLabel: false},
disabled: false,
+4 -4
View File
@@ -1,8 +1,8 @@
const semver = require('semver');
const {FIRST_RELEASE, FIRSTPRERELEASE} = require('./definitions/constants');
const {isSameChannel, getLatestVersion, tagsToVersions, highest} = require('./utils');
import semver from 'semver';
import {FIRST_RELEASE, FIRSTPRERELEASE} from './definitions/constants.js';
import {isSameChannel, getLatestVersion, tagsToVersions, highest} from './utils.js';
module.exports = ({branch, nextRelease: {type, channel}, lastRelease, logger}) => {
export default ({branch, nextRelease: {type, channel}, lastRelease, logger}) => {
let version;
if (lastRelease.version) {
const {major, minor, patch} = semver.parse(lastRelease.version);
+7 -6
View File
@@ -1,8 +1,9 @@
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');
import lodash from 'lodash'
const {uniqBy, intersection} = lodash
import semver from 'semver';
import semverDiff from 'semver-diff';
import getLastRelease from './get-last-release.js';
import {makeTag, getLowerBound} from './utils.js';
/**
* Find releases that have been merged from from a higher branch but not added on the channel of the current branch.
@@ -11,7 +12,7 @@ const {makeTag, getLowerBound} = require('./utils');
*
* @return {Array<Object>} Last release and next release to be added on the channel of the current branch.
*/
module.exports = (context) => {
export default (context) => {
const {
branch,
branches,
+32 -8
View File
@@ -1,8 +1,9 @@
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');
import gitLogParser from 'git-log-parser';
import getStream from 'get-stream';
import execa from 'execa';
import debugFactory from 'debug';
const debug = debugFactory('semantic-release:git');
import {GIT_NOTE_REF} from './definitions/constants.js';
Object.assign(gitLogParser.fields, {hash: 'H', message: 'B', gitTags: 'd', committerDate: {key: 'ci', type: Date}});
@@ -116,7 +117,7 @@ async function fetch(repositoryUrl, branch, ciBranch, execaOptions) {
],
execaOptions
);
} catch {
} catch (_) {
await execa(
'git',
[
@@ -144,7 +145,7 @@ async function fetchNotes(repositoryUrl, execaOptions) {
['fetch', '--unshallow', repositoryUrl, `+refs/notes/${GIT_NOTE_REF}:refs/notes/${GIT_NOTE_REF}`],
execaOptions
);
} catch {
} catch (_) {
await execa('git', ['fetch', repositoryUrl, `+refs/notes/${GIT_NOTE_REF}:refs/notes/${GIT_NOTE_REF}`], {
...execaOptions,
reject: false,
@@ -328,7 +329,30 @@ async function addNote(note, ref, execaOptions) {
await execa('git', ['notes', '--ref', GIT_NOTE_REF, 'add', '-f', '-m', JSON.stringify(note), ref], execaOptions);
}
module.exports = {
const exported = {
getTagHead,
getTags,
getCommits,
getBranches,
isRefExists,
fetch,
fetchNotes,
getGitHead,
repoUrl,
isGitRepo,
verifyAuth,
tag,
push,
pushNotes,
verifyTagName,
isBranchUpToDate,
verifyBranchName,
getNote,
addNote,
};
export default exported;
export {
getTagHead,
getTags,
getCommits,
+4 -3
View File
@@ -1,7 +1,8 @@
const {escapeRegExp, size, isString} = require('lodash');
const {SECRET_REPLACEMENT, SECRET_MIN_SIZE} = require('./definitions/constants');
import lodash from 'lodash'
const {escapeRegExp, size, isString} = lodash
import {SECRET_REPLACEMENT, SECRET_MIN_SIZE} from './definitions/constants.js';
module.exports = (env) => {
export default (env) => {
const toReplace = Object.keys(env).filter((envVar) => {
// https://github.com/semantic-release/semantic-release/issues/1558
if (envVar === 'GOPRIVATE') {
+9 -8
View File
@@ -1,12 +1,13 @@
const {identity, isPlainObject, omit, castArray, isNil, isString} = require('lodash');
const AggregateError = require('aggregate-error');
const getError = require('../get-error');
const PLUGINS_DEFINITIONS = require('../definitions/plugins');
const {validatePlugin, validateStep, loadPlugin, parseConfig} = require('./utils');
const pipeline = require('./pipeline');
const normalize = require('./normalize');
import lodash from 'lodash'
const {identity, isPlainObject, omit, castArray, isNil, isString} = lodash
import AggregateError from 'aggregate-error';
import getError from '../get-error.js';
import PLUGINS_DEFINITIONS from '../definitions/plugins.js';
import {validatePlugin, validateStep, loadPlugin, parseConfig} from './utils.js';
import pipeline from './pipeline.js';
import normalize from './normalize.js';
module.exports = (context, pluginsPath) => {
export default (context, pluginsPath) => {
let {options, logger} = context;
const errors = [];
+9 -7
View File
@@ -1,11 +1,13 @@
const {isPlainObject, isFunction, noop, cloneDeep, omit} = require('lodash');
const debug = require('debug')('semantic-release:plugins');
const getError = require('../get-error');
const {extractErrors} = require('../utils');
const PLUGINS_DEFINITIONS = require('../definitions/plugins');
const {loadPlugin, parseConfig} = require('./utils');
import lodash from 'lodash'
const {isPlainObject, isFunction, noop, cloneDeep, omit} = lodash
import debugFactory from 'debug';
const debug = debugFactory('semantic-release:plugins');
import getError from '../get-error.js';
import {extractErrors} from '../utils.js';
import PLUGINS_DEFINITIONS from '../definitions/plugins.js';
import {loadPlugin, parseConfig} from './utils.js';
module.exports = (context, type, pluginOpt, pluginsPath) => {
export default (context, type, pluginOpt, pluginsPath) => {
const {stdout, stderr, options, logger} = context;
if (!pluginOpt) {
return noop;
+6 -5
View File
@@ -1,7 +1,8 @@
const {identity} = require('lodash');
const pReduce = require('p-reduce');
const AggregateError = require('aggregate-error');
const {extractErrors} = require('../utils');
import lodash from 'lodash'
const {identity} = lodash
import pReduce from 'p-reduce';
import AggregateError from 'aggregate-error';
import {extractErrors} from '../utils.js';
/**
* A Function that execute a list of function sequencially. If at least one Function ins the pipeline throws an Error or rejects, the pipeline function rejects as well.
@@ -25,7 +26,7 @@ const {extractErrors} = require('../utils');
*
* @return {Pipeline} A Function that execute the `steps` sequencially
*/
module.exports = (steps, {settleAll = false, getNextInput = identity, transform = identity} = {}) => async (input) => {
export default (steps, {settleAll = false, getNextInput = identity, transform = identity} = {}) => async (input) => {
const results = [];
const errors = [];
await pReduce(
+13 -4
View File
@@ -1,6 +1,7 @@
const {dirname} = require('path');
const {isString, isFunction, castArray, isArray, isPlainObject, isNil} = require('lodash');
const resolveFrom = require('resolve-from');
import {dirname} from 'path';
import lodash from 'lodash'
const {isString, isFunction, castArray, isArray, isPlainObject, isNil} = lodash
import resolveFrom from 'resolve-from';
const validateSteps = (conf) => {
return conf.every((conf) => {
@@ -65,4 +66,12 @@ function parseConfig(plugin) {
return [path, config || {}];
}
module.exports = {validatePlugin, validateStep, loadPlugin, parseConfig};
const exported = {
validatePlugin,
validateStep,
loadPlugin,
parseConfig,
};
export default exported;
export {validatePlugin, validateStep, loadPlugin, parseConfig};
+24 -4
View File
@@ -1,6 +1,7 @@
const {isFunction, union, template} = require('lodash');
const semver = require('semver');
const hideSensitive = require('./hide-sensitive');
import lodash from 'lodash'
const {isFunction, union, template} = lodash
import semver from 'semver';
import hideSensitive from './hide-sensitive.js';
function extractErrors(err) {
return err && isFunction(err[Symbol.iterator]) ? [...err] : [err];
@@ -82,7 +83,26 @@ function isSameChannel(channel, otherChannel) {
return channel === otherChannel || (!channel && !otherChannel);
}
module.exports = {
const exported = {
extractErrors,
hideSensitiveValues,
tagsToVersions,
isMajorRange,
isMaintenanceRange,
getUpperBound,
getLowerBound,
highest,
lowest,
getLatestVersion,
getEarliestVersion,
getFirstVersion,
getRange,
makeTag,
isSameChannel,
};
export default exported;
export {
extractErrors,
hideSensitiveValues,
tagsToVersions,
+6 -5
View File
@@ -1,9 +1,10 @@
const {template, isString, isPlainObject} = require('lodash');
const AggregateError = require('aggregate-error');
const {isGitRepo, verifyTagName} = require('./git');
const getError = require('./get-error');
import lodash from 'lodash'
const {template, isString, isPlainObject} = lodash
import AggregateError from 'aggregate-error';
import {isGitRepo, verifyTagName} from './git.js';
import getError from './get-error.js';
module.exports = async (context) => {
export default async (context) => {
const {
cwd,
env,
+7091 -19571
View File
File diff suppressed because it is too large Load Diff
+21 -19
View File
@@ -1,5 +1,6 @@
{
"name": "semantic-release",
"type": "module",
"description": "Automated semver compliant package publishing",
"version": "0.0.0-development",
"author": "Stephan Bönnemann <stephan@boennemann.me> (http://boennemann.me)",
@@ -20,11 +21,11 @@
"Pierre Vanduynslager (https://twitter.com/@pvdlg_)"
],
"dependencies": {
"@semantic-release/commit-analyzer": "^9.0.2",
"@semantic-release/error": "^3.0.0",
"@semantic-release/github": "^8.0.0",
"@semantic-release/npm": "^9.0.0",
"@semantic-release/release-notes-generator": "^10.0.0",
"@semantic-release/commit-analyzer": "^8.0.0",
"@semantic-release/error": "^2.2.0",
"@semantic-release/github": "^7.0.0",
"@semantic-release/npm": "^7.0.0",
"@semantic-release/release-notes-generator": "^9.0.0",
"aggregate-error": "^3.0.0",
"cosmiconfig": "^7.0.0",
"debug": "^4.0.0",
@@ -37,8 +38,8 @@
"hook-std": "^2.0.0",
"hosted-git-info": "^4.0.0",
"lodash": "^4.17.21",
"marked": "^4.0.10",
"marked-terminal": "^5.0.0",
"marked": "^2.0.0",
"marked-terminal": "^4.1.1",
"micromatch": "^4.0.2",
"p-each-series": "^2.1.0",
"p-reduce": "^2.0.0",
@@ -51,26 +52,27 @@
},
"devDependencies": {
"ava": "3.15.0",
"clear-module": "4.1.2",
"codecov": "3.8.3",
"cjs2esm": "^2.0.0",
"clear-module": "4.1.1",
"codecov": "3.8.2",
"delay": "5.0.0",
"dockerode": "3.3.1",
"dockerode": "3.3.0",
"file-url": "3.0.0",
"fs-extra": "9.1.0",
"got": "11.8.5",
"fs-extra": "10.0.0",
"got": "11.8.2",
"js-yaml": "4.1.0",
"mockserver-client": "5.11.2",
"nock": "13.2.1",
"nock": "13.1.1",
"nyc": "15.1.0",
"p-retry": "4.6.1",
"proxyquire": "2.1.3",
"sinon": "12.0.1",
"sinon": "11.1.1",
"stream-buffers": "3.0.2",
"tempy": "1.0.1",
"xo": "0.32.1"
"xo": "0.29.1"
},
"engines": {
"node": ">=16 || ^14.17"
"node": ">=14.17"
},
"files": [
"bin",
@@ -92,7 +94,7 @@
"version"
],
"license": "MIT",
"main": "index.js",
"exports": "./index.js",
"nyc": {
"include": [
"lib/**/*.js",
@@ -129,8 +131,8 @@
"prettier": true,
"space": true,
"rules": {
"unicorn/no-reduce": "off",
"unicorn/string-content": "off"
"unicorn/string-content": "off",
"import/extensions": "off"
}
},
"renovate": {
+5 -4
View File
@@ -1,7 +1,8 @@
const test = require('ava');
const {union} = require('lodash');
const semver = require('semver');
const proxyquire = require('proxyquire');
import test from 'ava';
import lodash from 'lodash'
const {union} = 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});
+3 -3
View File
@@ -1,6 +1,6 @@
const test = require('ava');
const expand = require('../../lib/branches/expand');
const {gitRepo, gitCommits, gitCheckout, gitPush} = require('../helpers/git-utils');
import test from 'ava';
import expand from '../../lib/branches/expand.js';
import {gitRepo, gitCommits, gitCheckout, gitPush} from '../helpers/git-utils.js';
test('Expand branches defined with globs', async (t) => {
const {cwd, repositoryUrl} = await gitRepo(true);
+3 -3
View File
@@ -1,6 +1,6 @@
const test = require('ava');
const getTags = require('../../lib/branches/get-tags');
const {gitRepo, gitCommits, gitTagVersion, gitCheckout, gitAddNote} = require('../helpers/git-utils');
import test from 'ava';
import getTags from '../../lib/branches/get-tags.js';
import {gitRepo, gitCommits, gitTagVersion, gitCheckout, gitAddNote} from '../helpers/git-utils.js';
test('Get the valid tags', async (t) => {
const {cwd} = await gitRepo();
+2 -2
View File
@@ -1,5 +1,5 @@
const test = require('ava');
const normalize = require('../../lib/branches/normalize');
import test from 'ava';
import normalize from '../../lib/branches/normalize.js';
const toTags = (versions) => versions.map((version) => ({version}));
+17 -16
View File
@@ -1,16 +1,17 @@
const test = require('ava');
const {escapeRegExp} = require('lodash');
import test from 'ava';
import lodash from 'lodash'
const {escapeRegExp} = lodash
const proxyquire = require('proxyquire').noPreserveCache();
const {stub} = require('sinon');
const {SECRET_REPLACEMENT} = require('../lib/definitions/constants');
import sinon from 'sinon';
import {SECRET_REPLACEMENT} from '../lib/definitions/constants.js';
test.beforeEach((t) => {
t.context.logs = '';
t.context.errors = '';
t.context.stdout = stub(process.stdout, 'write').callsFake((value) => {
t.context.stdout = sinon.stubprocess.stdout, 'write').callsFake((value) => {
t.context.logs += value.toString();
});
t.context.stderr = stub(process.stderr, 'write').callsFake((value) => {
t.context.stderr = sinon.stubprocess.stderr, 'write').callsFake((value) => {
t.context.errors += value.toString();
});
});
@@ -21,7 +22,7 @@ test.afterEach.always((t) => {
});
test.serial('Pass options to semantic-release API', async (t) => {
const run = stub().resolves(true);
const run = sinon.stub).resolves(true);
const argv = [
'',
'',
@@ -87,7 +88,7 @@ test.serial('Pass options to semantic-release API', async (t) => {
});
test.serial('Pass options to semantic-release API with alias arguments', async (t) => {
const run = stub().resolves(true);
const run = sinon.stub).resolves(true);
const argv = [
'',
'',
@@ -120,7 +121,7 @@ test.serial('Pass options to semantic-release API with alias arguments', async (
});
test.serial('Pass unknown options to semantic-release API', async (t) => {
const run = stub().resolves(true);
const run = sinon.stub).resolves(true);
const argv = ['', '', '--bool', '--first-option', 'value1', '--second-option', 'value2', '--second-option', 'value3'];
const cli = proxyquire('../cli', {'.': run, process: {...process, argv}});
@@ -134,7 +135,7 @@ test.serial('Pass unknown options to semantic-release API', async (t) => {
});
test.serial('Pass empty Array to semantic-release API for list option set to "false"', async (t) => {
const run = stub().resolves(true);
const run = sinon.stub).resolves(true);
const argv = ['', '', '--publish', 'false'];
const cli = proxyquire('../cli', {'.': run, process: {...process, argv}});
@@ -146,7 +147,7 @@ test.serial('Pass empty Array to semantic-release API for list option set to "fa
});
test.serial('Do not set properties in option for which arg is not in command line', async (t) => {
const run = stub().resolves(true);
const run = sinon.stub).resolves(true);
const argv = ['', '', '-b', 'master'];
const cli = proxyquire('../cli', {'.': run, process: {...process, argv}});
@@ -163,7 +164,7 @@ test.serial('Do not set properties in option for which arg is not in command lin
});
test.serial('Display help', async (t) => {
const run = stub().resolves(true);
const run = sinon.stub).resolves(true);
const argv = ['', '', '--help'];
const cli = proxyquire('../cli', {'.': run, process: {...process, argv}});
@@ -174,7 +175,7 @@ test.serial('Display help', async (t) => {
});
test.serial('Return error exitCode and prints help if called with a command', async (t) => {
const run = stub().resolves(true);
const run = sinon.stub).resolves(true);
const argv = ['', '', 'pre'];
const cli = proxyquire('../cli', {'.': run, process: {...process, argv}});
@@ -186,7 +187,7 @@ test.serial('Return error exitCode and prints help if called with a command', as
});
test.serial('Return error exitCode if multiple plugin are set for single plugin', async (t) => {
const run = stub().resolves(true);
const run = sinon.stub).resolves(true);
const argv = ['', '', '--analyze-commits', 'analyze1', 'analyze2'];
const cli = proxyquire('../cli', {'.': run, process: {...process, argv}});
@@ -198,7 +199,7 @@ test.serial('Return error exitCode if multiple plugin are set for single plugin'
});
test.serial('Return error exitCode if semantic-release throw error', async (t) => {
const run = stub().rejects(new Error('semantic-release error'));
const run = sinon.stub).rejects(new Error('semantic-release error'));
const argv = ['', ''];
const cli = proxyquire('../cli', {'.': run, process: {...process, argv}});
@@ -210,7 +211,7 @@ test.serial('Return error exitCode if semantic-release throw error', async (t) =
test.serial('Hide sensitive environment variable values from the logs', async (t) => {
const env = {MY_TOKEN: 'secret token'};
const run = stub().rejects(new Error(`Throw error: Exposing token ${env.MY_TOKEN}`));
const run = sinon.stub).rejects(new Error(`Throw error: Exposing token ${env.MY_TOKEN}`));
const argv = ['', ''];
const cli = proxyquire('../cli', {'.': run, process: {...process, argv, env: {...process.env, ...env}}});
+2 -8
View File
@@ -1,8 +1,7 @@
const test = require('ava');
const {maintenance, prerelease, release} = require('../../lib/definitions/branches');
import test from 'ava';
import {maintenance, prerelease, release} from '../../lib/definitions/branches.js';
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) => {
/* eslint-disable unicorn/no-fn-reference-in-iterator */
t.true(maintenance.filter({name: '1.x.x'}));
t.true(maintenance.filter({name: '1.0.x'}));
t.true(maintenance.filter({name: '1.x'}));
@@ -16,7 +15,6 @@ test('A "maintenance" branch is identified by having a "range" property or a "na
t.false(maintenance.filter({name: 'some-name'}));
t.false(maintenance.filter({name: '1.0.0'}));
t.false(maintenance.filter({name: 'x.x.x'}));
/* eslint-enable unicorn/no-fn-reference-in-iterator */
});
test('A "maintenance" branches must have a "range" property formatted like "N.x", "N.x.x" or "N.N.x"', (t) => {
@@ -39,7 +37,6 @@ test('The "maintenance" branches must have unique ranges', (t) => {
});
test('A "prerelease" branch is identified by having a thruthy "prerelease" property', (t) => {
/* eslint-disable unicorn/no-fn-reference-in-iterator */
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: ''}));
@@ -47,7 +44,6 @@ test('A "prerelease" branch is identified by having a thruthy "prerelease" prope
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'}));
/* eslint-enable unicorn/no-fn-reference-in-iterator */
});
test('A "prerelease" branch must have a valid prerelease detonation in "prerelease" property or in "name" if "prerelease" is "true"', (t) => {
@@ -70,7 +66,6 @@ test('The "prerelease" branches must have unique "prerelease" property', (t) =>
});
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) => {
/* eslint-disable unicorn/no-fn-reference-in-iterator */
t.true(release.filter({name: 'some-name'}));
t.false(release.filter({name: '1.x.x'}));
@@ -79,7 +74,6 @@ test('A "release" branch is identified by not havin a "range" or "prerelease" pr
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'}));
/* eslint-enable unicorn/no-fn-reference-in-iterator */
});
test('There must be between 1 and 3 release branches', (t) => {
+3 -3
View File
@@ -1,6 +1,6 @@
const test = require('ava');
const plugins = require('../../lib/definitions/plugins');
const {RELEASE_NOTES_SEPARATOR, SECRET_REPLACEMENT} = require('../../lib/definitions/constants');
import test from 'ava';
import plugins from '../../lib/definitions/plugins.js';
import {RELEASE_NOTES_SEPARATOR, SECRET_REPLACEMENT} from '../../lib/definitions/constants.js';
test('The "analyzeCommits" plugin output must be either undefined or a valid semver release type', (t) => {
t.false(plugins.analyzeCommits.outputValidator('invalid'));
+1 -1
View File
@@ -1 +1 @@
module.exports = () => {};
export default () => {};
+5 -1
View File
@@ -1,4 +1,4 @@
module.exports = {
const exported = {
verifyConditions: () => {},
getLastRelease: () => {},
analyzeCommits: () => {},
@@ -6,3 +6,7 @@ module.exports = {
generateNotes: () => {},
publish: () => {},
};
export default exported;
export const {verifyConditions, getLastRelease, analyzeCommits, verifyRelease, generateNotes, publish} = exported;
+2 -2
View File
@@ -1,4 +1,4 @@
const SemanticReleaseError = require('@semantic-release/error');
import SemanticReleaseError from '@semantic-release/error';
class InheritedError extends SemanticReleaseError {
constructor(message, code) {
@@ -9,6 +9,6 @@ class InheritedError extends SemanticReleaseError {
}
}
module.exports = () => {
export default () => {
throw new InheritedError('Inherited error', 'EINHERITED');
};
+1 -1
View File
@@ -1,4 +1,4 @@
module.exports = () => {
export default () => {
const error = new Error('a');
error.errorProperty = 'errorProperty';
throw error;
+2 -2
View File
@@ -1,5 +1,5 @@
const AggregateError = require('aggregate-error');
import AggregateError from 'aggregate-error';
module.exports = () => {
export default () => {
throw new AggregateError([new Error('a'), new Error('b')]);
};
+1 -1
View File
@@ -1 +1 @@
module.exports = (pluginConfig, context) => context;
export default (pluginConfig, context) => context;
+1 -1
View File
@@ -1,4 +1,4 @@
module.exports = (pluginConfig, {env, logger}) => {
export default (pluginConfig, {env, logger}) => {
console.log(`Console: Exposing token ${env.MY_TOKEN}`);
logger.log(`Log: Exposing token ${env.MY_TOKEN}`);
logger.error(`Error: Console token ${env.MY_TOKEN}`);
+1 -1
View File
@@ -1 +1 @@
module.exports = () => {};
export default () => {};
+1 -1
View File
@@ -1 +1 @@
module.exports = (pluginConfig, context) => ({pluginConfig, context});
export default (pluginConfig, context) => ({pluginConfig, context});
+6 -6
View File
@@ -1,12 +1,12 @@
const test = require('ava');
const {stub} = require('sinon');
const getCommits = require('../lib/get-commits');
const {gitRepo, gitCommits, gitDetachedHead} = require('./helpers/git-utils');
import test from 'ava';
import sinon from 'sinon';
import getCommits from '../lib/get-commits.js';
import {gitRepo, gitCommits, gitDetachedHead} from './helpers/git-utils.js';
test.beforeEach((t) => {
// Stub the logger functions
t.context.log = stub();
t.context.error = stub();
t.context.log = sinon.stub();
t.context.error = sinon.stub();
t.context.logger = {log: t.context.log, error: t.context.error};
});
+11 -10
View File
@@ -1,12 +1,13 @@
const path = require('path');
const {format} = require('util');
const test = require('ava');
const {writeFile, outputJson} = require('fs-extra');
const {omit} = require('lodash');
const proxyquire = require('proxyquire');
const {stub} = require('sinon');
const yaml = require('js-yaml');
const {gitRepo, gitTagVersion, gitCommits, gitShallowClone, gitAddConfig} = require('./helpers/git-utils');
import path from 'path';
import {format} from 'util';
import test from 'ava';
import {writeFile, outputJson} from 'fs-extra';
import lodash from 'lodash'
const {omit} = lodash
import proxyquire from 'proxyquire';
import sinon from 'sinon';
import yaml from 'js-yaml';
import {gitRepo, gitTagVersion, gitCommits, gitShallowClone, gitAddConfig} from './helpers/git-utils.js';
const DEFAULT_PLUGINS = [
'@semantic-release/commit-analyzer',
@@ -16,7 +17,7 @@ const DEFAULT_PLUGINS = [
];
test.beforeEach((t) => {
t.context.plugins = stub().returns({});
t.context.plugins = sinon.stub).returns({});
t.context.getConfig = proxyquire('../lib/get-config', {'./plugins': t.context.plugins});
});
+3 -3
View File
@@ -1,6 +1,6 @@
const test = require('ava');
const getAuthUrl = require('../lib/get-git-auth-url');
const {gitRepo} = require('./helpers/git-utils');
import test from 'ava';
import getAuthUrl from '../lib/get-git-auth-url.js';
import {gitRepo} from './helpers/git-utils.js';
const env = {GIT_ASKPASS: 'echo', GIT_TERMINAL_PROMPT: 0};
+2 -2
View File
@@ -1,5 +1,5 @@
const test = require('ava');
const getLastRelease = require('../lib/get-last-release');
import test from 'ava';
import getLastRelease from '../lib/get-last-release.js';
test('Get the highest non-prerelease valid tag', (t) => {
const result = getLastRelease({
+3 -3
View File
@@ -1,6 +1,6 @@
const test = require('ava');
const {spy} = require('sinon');
const getLogger = require('../lib/get-logger');
import test from 'ava';
import {spy} from 'sinon';
import getLogger from '../lib/get-logger.js';
test('Expose "error", "success" and "log" functions', (t) => {
const stdout = spy();
+4 -4
View File
@@ -1,10 +1,10 @@
const test = require('ava');
const {stub} = require('sinon');
const getNextVersion = require('../lib/get-next-version');
import test from 'ava';
import sinon from 'sinon';
import getNextVersion from '../lib/get-next-version.js';
test.beforeEach((t) => {
// Stub the logger functions
t.context.log = stub();
t.context.log = sinon.stub);
t.context.logger = {log: t.context.log};
});
+2 -2
View File
@@ -1,5 +1,5 @@
const test = require('ava');
const getReleaseToAdd = require('../lib/get-release-to-add');
import test from 'ava';
import getReleaseToAdd from '../lib/get-release-to-add.js';
test('Return versions merged from release to maintenance branch, excluding lower than branch start range', (t) => {
const result = getReleaseToAdd({
+8 -6
View File
@@ -1,6 +1,7 @@
const test = require('ava');
const tempy = require('tempy');
const {
import test from 'ava';
import tempy from 'tempy';
import {
getTagHead,
isRefExists,
fetch,
@@ -16,8 +17,9 @@ const {
getNote,
addNote,
fetchNotes,
} = require('../lib/git');
const {
} from '../lib/git.js';
import {
gitRepo,
gitCommits,
gitCheckout,
@@ -34,7 +36,7 @@ const {
gitGetNote,
gitFetch,
initGit,
} = require('./helpers/git-utils');
} from './helpers/git-utils.js';
test('Get the last commit sha', async (t) => {
// Create a git repository, set the current working directory at the root of the repo
-23
View File
@@ -1,23 +0,0 @@
storage: /verdaccio/storage/data
plugins: /verdaccio/plugins
web:
title: Verdaccio
auth:
htpasswd:
file: /verdaccio/storage/htpasswd
packages:
'@*/*':
access: $all
publish: $authenticated
unpublish: $authenticated
'**':
access: $all
publish: $authenticated
unpublish: $authenticated
server:
keepAliveTimeout: 60
middlewares:
audit:
enabled: true
logs:
- { type: stdout, format: pretty, level: http }
+34 -8
View File
@@ -1,10 +1,10 @@
const tempy = require('tempy');
const execa = require('execa');
const fileUrl = require('file-url');
const pEachSeries = require('p-each-series');
const gitLogParser = require('git-log-parser');
const getStream = require('get-stream');
const {GIT_NOTE_REF} = require('../../lib/definitions/constants');
import tempy from 'tempy';
import execa from 'execa';
import fileUrl from 'file-url';
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.js';
/**
* Commit message information.
@@ -323,7 +323,33 @@ async function gitGetNote(ref, execaOptions) {
return (await execa('git', ['notes', '--ref', GIT_NOTE_REF, 'show', ref], execaOptions)).stdout;
}
module.exports = {
const exported = {
initGit,
gitRepo,
initBareRepo,
gitCommits,
gitGetCommits,
gitCheckout,
gitFetch,
gitHead,
gitTagVersion,
gitShallowClone,
gitDetachedHead,
gitDetachedHeadFromBranch,
gitAddConfig,
gitTagHead,
gitRemoteTagHead,
gitCommitTag,
gitPush,
merge,
mergeFf,
rebase,
gitAddNote,
gitGetNote,
};
export default exported;
export {
initGit,
gitRepo,
initBareRepo,
+14 -6
View File
@@ -1,9 +1,9 @@
const Docker = require('dockerode');
const getStream = require('get-stream');
const pRetry = require('p-retry');
const {initBareRepo, gitShallowClone} = require('./git-utils');
import Docker from 'dockerode';
import getStream from 'get-stream';
import pRetry from 'p-retry';
import {initBareRepo, gitShallowClone} from './git-utils.js';
const IMAGE = 'semanticrelease/docker-gitbox:latest';
const IMAGE = 'pvdlg/docker-gitbox:latest';
const SERVER_PORT = 80;
const HOST_PORT = 2080;
const SERVER_HOST = 'localhost';
@@ -69,4 +69,12 @@ async function createRepo(name, branch = 'master', description = `Repository ${n
return {cwd, repositoryUrl, authUrl};
}
module.exports = {start, stop, gitCredential, createRepo};
const exported = {
start,
stop,
gitCredential,
createRepo,
};
export default exported;
export {start, stop, gitCredential, createRepo};
+18 -9
View File
@@ -1,8 +1,8 @@
const Docker = require('dockerode');
const getStream = require('get-stream');
const got = require('got');
const pRetry = require('p-retry');
const {mockServerClient} = require('mockserver-client');
import Docker from 'dockerode';
import getStream from 'get-stream';
import got from 'got';
import pRetry from 'p-retry';
import {mockServerClient} from 'mockserver-client';
const IMAGE = 'jamesdbloom/mockserver:latest';
const MOCK_SERVER_PORT = 1080;
@@ -30,13 +30,13 @@ async function start() {
minTimeout: 1000,
factor: 2,
});
} catch {
} catch (_) {
throw new Error(`Couldn't start mock-server after 2 min`);
}
}
/**
* Stop and remove the `mockserver` Docker container.
* Stop and remote the `mockserver` Docker container.
*/
async function stop() {
await container.stop();
@@ -91,7 +91,7 @@ async function mock(
}
/**
* Verify the `mockserver` has been called with a request matching expectations. The `expectation` is created with the `mock` function.
* Verify the `mockserver` has been called with a requestion matching expectations. The `expectation` is created with the `mock` function.
*
* @param {Object} expectation The expectation created with `mock` function.
* @return {Promise} A Promise that resolves if the expectation is met or reject otherwise.
@@ -100,4 +100,13 @@ function verify(expectation) {
return client.verify(expectation);
}
module.exports = {start, stop, mock, verify, url};
const exported = {
start,
stop,
mock,
verify,
url,
};
export default exported;
export {start, stop, mock, verify, url};
+28 -16
View File
@@ -1,13 +1,15 @@
const Docker = require('dockerode');
const getStream = require('get-stream');
const got = require('got');
const path = require('path');
const delay = require('delay');
const pRetry = require('p-retry');
import Docker from 'dockerode';
import getStream from 'get-stream';
import got from 'got';
import delay from 'delay';
import pRetry from 'p-retry';
const IMAGE = 'verdaccio/verdaccio:4';
const REGISTRY_PORT = 4873;
const REGISTRY_HOST = 'localhost';
const IMAGE = 'semanticrelease/npm-registry-docker:latest';
const SERVER_PORT = 15986;
const COUCHDB_PORT = 5984;
const SERVER_HOST = 'localhost';
const COUCHDB_USER = 'admin';
const COUCHDB_PASSWORD = 'password';
const NPM_USERNAME = 'integration';
const NPM_PASSWORD = 'suchsecure';
const NPM_EMAIL = 'integration@test.com';
@@ -23,8 +25,8 @@ async function start() {
container = await docker.createContainer({
Tty: true,
Image: IMAGE,
PortBindings: {[`${REGISTRY_PORT}/tcp`]: [{HostPort: `${REGISTRY_PORT}`}]},
Binds: [`${path.join(__dirname, 'config.yaml')}:/verdaccio/conf/config.yaml`],
PortBindings: {[`${COUCHDB_PORT}/tcp`]: [{HostPort: `${SERVER_PORT}`}]},
Env: [`COUCHDB_USER=${COUCHDB_USER}`, `COUCHDB_PASSWORD=${COUCHDB_PASSWORD}`],
});
await container.start();
@@ -32,17 +34,19 @@ async function start() {
try {
// Wait for the registry to be ready
await pRetry(() => got(`http://${REGISTRY_HOST}:${REGISTRY_PORT}/`, {cache: false}), {
await pRetry(() => got(`http://${SERVER_HOST}:${SERVER_PORT}/registry/_design/app`, {cache: false}), {
retries: 7,
minTimeout: 1000,
factor: 2,
});
} catch {
} catch (_) {
throw new Error(`Couldn't start npm-registry-docker after 2 min`);
}
// Create user
await got(`http://${REGISTRY_HOST}:${REGISTRY_PORT}/-/user/org.couchdb.user:${NPM_USERNAME}`, {
await got(`http://${SERVER_HOST}:${SERVER_PORT}/_users/org.couchdb.user:${NPM_USERNAME}`, {
username: COUCHDB_USER,
password: COUCHDB_PASSWORD,
method: 'PUT',
json: {
_id: `org.couchdb.user:${NPM_USERNAME}`,
@@ -55,7 +59,7 @@ async function start() {
});
}
const url = `http://${REGISTRY_HOST}:${REGISTRY_PORT}/`;
const url = `http://${SERVER_HOST}:${SERVER_PORT}/registry/_design/app/_rewrite/`;
const authEnv = {
npm_config_registry: url, // eslint-disable-line camelcase
@@ -72,4 +76,12 @@ async function stop() {
await container.remove();
}
module.exports = {start, stop, authEnv, url};
const exported = {
start,
stop,
authEnv,
url,
};
export default exported;
export {start, stop, authEnv, url};
+7 -2
View File
@@ -1,7 +1,12 @@
const execa = require('execa');
import execa from 'execa';
async function npmView(packageName, env) {
return JSON.parse((await execa('npm', ['view', packageName, '--json'], {env})).stdout);
}
module.exports = {npmView};
const exported = {
npmView,
};
export default exported;
export {npmView};
+5 -4
View File
@@ -1,7 +1,8 @@
const test = require('ava');
const {repeat} = require('lodash');
const hideSensitive = require('../lib/hide-sensitive');
const {SECRET_REPLACEMENT, SECRET_MIN_SIZE} = require('../lib/definitions/constants');
import test from 'ava';
import lodash from 'lodash'
const {repeat} = lodash
import hideSensitive from '../lib/hide-sensitive.js';
import {SECRET_REPLACEMENT, SECRET_MIN_SIZE} from '../lib/definitions/constants.js';
test('Replace multiple sensitive environment variable values', (t) => {
const env = {SOME_PASSWORD: 'password', SOME_TOKEN: 'secret'};
+217 -221
View File
@@ -1,13 +1,15 @@
const test = require('ava');
const {escapeRegExp, isString, sortBy, omit} = require('lodash');
const proxyquire = require('proxyquire');
const {spy, stub} = require('sinon');
const {WritableStreamBuffer} = require('stream-buffers');
const AggregateError = require('aggregate-error');
const SemanticReleaseError = require('@semantic-release/error');
const {COMMIT_NAME, COMMIT_EMAIL, SECRET_REPLACEMENT} = require('../lib/definitions/constants');
const {
gitHead: getGitHead,
import test from 'ava';
import lodash from 'lodash'
const {escapeRegExp, isString, sortBy, omit} = lodash
import proxyquire from 'proxyquire';
import sinon from 'sinon';
import {WritableStreamBuffer} from 'stream-buffers';
import AggregateError from 'aggregate-error';
import SemanticReleaseError from '@semantic-release/error';
import {COMMIT_NAME, COMMIT_EMAIL, SECRET_REPLACEMENT} from '../lib/definitions/constants.js';
import {
gitHead as getGitHead,
gitCheckout,
gitTagHead,
gitRepo,
@@ -21,17 +23,17 @@ const {
rebase,
gitAddNote,
gitGetNote,
} = require('./helpers/git-utils');
} from './helpers/git-utils.js';
const requireNoCache = proxyquire.noPreserveCache();
const pluginNoop = require.resolve('./fixtures/plugin-noop');
test.beforeEach((t) => {
// Stub the logger functions
t.context.log = spy();
t.context.error = spy();
t.context.success = spy();
t.context.warn = spy();
t.context.log = sinon.spy();
t.context.error = sinon.spy();
t.context.success = sinon.spy();
t.context.warn = sinon.spy();
t.context.logger = {
log: t.context.log,
error: t.context.error,
@@ -73,24 +75,23 @@ test('Plugins are called with expected values', async (t) => {
const notes1 = 'Release notes 1';
const notes2 = 'Release notes 2';
const notes3 = 'Release notes 3';
const verifyConditions1 = stub().resolves();
const verifyConditions2 = stub().resolves();
const analyzeCommits = stub().resolves(nextRelease.type);
const verifyRelease = stub().resolves();
const generateNotes1 = stub().resolves(notes1);
const generateNotes2 = stub().resolves(notes2);
const generateNotes3 = stub().resolves(notes3);
const verifyConditions1 = sinon.stub().resolves();
const verifyConditions2 = sinon.stub().resolves();
const analyzeCommits = sinon.stub().resolves(nextRelease.type);
const verifyRelease = sinon.stub().resolves();
const generateNotes1 = sinon.stub().resolves(notes1);
const generateNotes2 = sinon.stub().resolves(notes2);
const generateNotes3 = sinon.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 publish = stub().resolves(release2);
const success = stub().resolves();
const addChannel = sinon.stub().resolves(release1);
const prepare = sinon.stub().resolves();
const publish = sinon.stub().resolves(release2);
const success = sinon.stub().resolves();
const env = {};
const config = {
branches: [{name: 'master'}, {name: 'next'}],
repositoryUrl,
originalRepositoryURL: repositoryUrl,
globalOpt: 'global',
tagFormat: `v\${version}`,
};
@@ -409,15 +410,15 @@ test('Use custom tag format', async (t) => {
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(),
fail: stub().resolves(),
verifyConditions: sinon.stub().resolves(),
analyzeCommits: sinon.stub().resolves(nextRelease.type),
verifyRelease: sinon.stub().resolves(),
generateNotes: sinon.stub().resolves(notes),
addChannel: sinon.stub().resolves(),
prepare: sinon.stub().resolves(),
publish: sinon.stub().resolves(),
success: sinon.stub().resolves(),
fail: sinon.stub().resolves(),
};
const semanticRelease = requireNoCache('..', {
@@ -459,24 +460,24 @@ test('Use new gitHead, and recreate release notes if a prepare plugin create a c
};
const notes = 'Release notes';
const generateNotes = stub().resolves(notes);
const prepare1 = stub().callsFake(async () => {
const generateNotes = sinon.stub().resolves(notes);
const prepare1 = sinon.stub().callsFake(async () => {
commits = (await gitCommits(['Third'], {cwd})).concat(commits);
});
const prepare2 = stub().resolves();
const publish = stub().resolves();
const prepare2 = sinon.stub().resolves();
const publish = sinon.stub().resolves();
const options = {
branches: ['master'],
repositoryUrl,
verifyConditions: stub().resolves(),
analyzeCommits: stub().resolves(nextRelease.type),
verifyRelease: stub().resolves(),
verifyConditions: sinon.stub().resolves(),
analyzeCommits: sinon.stub().resolves(nextRelease.type),
verifyRelease: sinon.stub().resolves(),
generateNotes,
addChannel: stub().resolves(),
addChannel: sinon.stub().resolves(),
prepare: [prepare1, prepare2],
publish,
success: stub().resolves(),
fail: stub().resolves(),
success: sinon.stub().resolves(),
fail: sinon.stub().resolves(),
};
const semanticRelease = requireNoCache('..', {
@@ -528,12 +529,12 @@ test('Make a new release when a commit is forward-ported to an upper branch', as
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 verifyConditions = sinon.stub().resolves();
const verifyRelease = sinon.stub().resolves();
const addChannel = sinon.stub().resolves();
const prepare = sinon.stub().resolves();
const publish = sinon.stub().resolves();
const success = sinon.stub().resolves();
const config = {branches: [{name: '1.0.x'}, {name: 'master'}], repositoryUrl, tagFormat: `v\${version}`};
const options = {
@@ -571,14 +572,14 @@ test('Publish a pre-release version', async (t) => {
const config = {branches: ['master', {name: 'beta', prerelease: true}], repositoryUrl};
const options = {
...config,
verifyConditions: stub().resolves(),
verifyRelease: stub().resolves(),
generateNotes: stub().resolves(''),
verifyConditions: sinon.stub().resolves(),
verifyRelease: sinon.stub().resolves(),
generateNotes: sinon.stub().resolves(''),
addChannel: false,
prepare: stub().resolves(),
publish: stub().resolves(),
success: stub().resolves(),
fail: stub().resolves(),
prepare: sinon.stub().resolves(),
publish: sinon.stub().resolves(),
success: sinon.stub().resolves(),
fail: sinon.stub().resolves(),
};
const semanticRelease = requireNoCache('..', {
@@ -621,17 +622,17 @@ test('Publish releases from different branch on the same channel', async (t) =>
branches: ['master', {name: 'next', channel: false}, {name: 'next-major', channel: false}],
repositoryUrl,
};
const addChannel = stub().resolves({});
const addChannel = sinon.stub().resolves({});
const options = {
...config,
verifyConditions: stub().resolves(),
verifyRelease: stub().resolves(),
generateNotes: stub().resolves(''),
verifyConditions: sinon.stub().resolves(),
verifyRelease: sinon.stub().resolves(),
generateNotes: sinon.stub().resolves(''),
addChannel,
prepare: stub().resolves(),
publish: stub().resolves(),
success: stub().resolves(),
fail: stub().resolves(),
prepare: sinon.stub().resolves(),
publish: sinon.stub().resolves(),
success: sinon.stub().resolves(),
fail: sinon.stub().resolves(),
};
let semanticRelease = requireNoCache('..', {
@@ -684,14 +685,14 @@ test('Publish pre-releases the same channel as regular releases', async (t) => {
};
const options = {
...config,
verifyConditions: stub().resolves(),
verifyRelease: stub().resolves(),
generateNotes: stub().resolves(''),
verifyConditions: sinon.stub().resolves(),
verifyRelease: sinon.stub().resolves(),
generateNotes: sinon.stub().resolves(''),
addChannel: false,
prepare: stub().resolves(),
publish: stub().resolves(),
success: stub().resolves(),
fail: stub().resolves(),
prepare: sinon.stub().resolves(),
publish: sinon.stub().resolves(),
success: sinon.stub().resolves(),
fail: sinon.stub().resolves(),
};
const semanticRelease = requireNoCache('..', {
@@ -734,14 +735,14 @@ test('Do not add pre-releases to a different channel', async (t) => {
await merge('beta', {cwd});
await gitPush('origin', 'master', {cwd});
const verifyConditions = stub().resolves();
const verifyRelease = stub().resolves();
const generateNotes = stub().resolves('Release notes');
const verifyConditions = sinon.stub().resolves();
const verifyRelease = sinon.stub().resolves();
const generateNotes = sinon.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 addChannel = sinon.stub().resolves(release1);
const prepare = sinon.stub().resolves();
const publish = sinon.stub().resolves();
const success = sinon.stub().resolves();
const config = {
branches: [{name: 'master'}, {name: 'beta', prerelease: 'beta'}],
@@ -792,15 +793,15 @@ async function addChannelMacro(t, mergeFunction) {
await gitPush('origin', 'master', {cwd});
const notes = 'Release notes';
const verifyConditions = stub().resolves();
const verifyRelease = stub().resolves();
const generateNotes = stub().resolves(notes);
const verifyConditions = sinon.stub().resolves();
const verifyRelease = sinon.stub().resolves();
const generateNotes = sinon.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 addChannel1 = sinon.stub().resolves(release1);
const addChannel2 = sinon.stub().resolves();
const prepare = sinon.stub().resolves();
const publish = sinon.stub().resolves();
const success = sinon.stub().resolves();
const config = {
branches: [
@@ -871,14 +872,14 @@ test('Call all "success" plugins even if one errors out', async (t) => {
channel: null,
};
const notes = 'Release notes';
const verifyConditions1 = stub().resolves();
const verifyConditions2 = stub().resolves();
const analyzeCommits = stub().resolves(nextRelease.type);
const generateNotes = stub().resolves(notes);
const verifyConditions1 = sinon.stub().resolves();
const verifyConditions2 = sinon.stub().resolves();
const analyzeCommits = sinon.stub().resolves(nextRelease.type);
const generateNotes = sinon.stub().resolves(notes);
const release = {name: 'Release', url: 'https://release.com'};
const publish = stub().resolves(release);
const success1 = stub().rejects();
const success2 = stub().resolves();
const publish = sinon.stub().resolves(release);
const success1 = sinon.stub().rejects();
const success2 = sinon.stub().resolves();
const config = {
branches: [{name: 'master'}],
repositoryUrl,
@@ -890,8 +891,8 @@ test('Call all "success" plugins even if one errors out', async (t) => {
verifyConditions: [verifyConditions1, verifyConditions2],
analyzeCommits,
generateNotes,
addChannel: stub().resolves(),
prepare: stub().resolves(),
addChannel: sinon.stub().resolves(),
prepare: sinon.stub().resolves(),
publish,
success: [success1, success2],
};
@@ -927,17 +928,12 @@ test('Log all "verifyConditions" errors', async (t) => {
const error1 = new Error('error 1');
const error2 = new SemanticReleaseError('error 2', 'ERR2');
const error3 = new SemanticReleaseError('error 3', 'ERR3');
const fail = stub().resolves();
const config = {
branches: [{name: 'master'}],
repositoryUrl,
originalRepositoryURL: repositoryUrl,
tagFormat: `v\${version}`,
};
const fail = sinon.stub().resolves();
const config = {branches: [{name: 'master'}], repositoryUrl, tagFormat: `v\${version}`};
const options = {
...config,
plugins: false,
verifyConditions: [stub().rejects(new AggregateError([error1, error2])), stub().rejects(error3)],
verifyConditions: [sinon.stub().rejects(new AggregateError([error1, error2])), sinon.stub().rejects(error3)],
fail,
};
@@ -976,13 +972,13 @@ 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 fail = sinon.stub().resolves();
const config = {branches: [{name: 'master'}], repositoryUrl, tagFormat: `v\${version}`};
const options = {
...config,
verifyConditions: stub().resolves(),
analyzeCommits: stub().resolves('major'),
verifyRelease: [stub().rejects(error1), stub().rejects(error2)],
verifyConditions: sinon.stub().resolves(),
analyzeCommits: sinon.stub().resolves('major'),
verifyRelease: [sinon.stub().rejects(error1), sinon.stub().rejects(error2)],
fail,
};
@@ -1017,14 +1013,14 @@ test('Dry-run skips addChannel, prepare, publish and success', async (t) => {
await gitCheckout('next', true, {cwd});
await gitPush('origin', 'next', {cwd});
const verifyConditions = stub().resolves();
const analyzeCommits = stub().resolves('minor');
const verifyRelease = stub().resolves();
const generateNotes = stub().resolves();
const addChannel = stub().resolves();
const prepare = stub().resolves();
const publish = stub().resolves();
const success = stub().resolves();
const verifyConditions = sinon.stub().resolves();
const analyzeCommits = sinon.stub().resolves('minor');
const verifyRelease = sinon.stub().resolves();
const generateNotes = sinon.stub().resolves();
const addChannel = sinon.stub().resolves();
const prepare = sinon.stub().resolves();
const publish = sinon.stub().resolves();
const success = sinon.stub().resolves();
const options = {
dryRun: true,
@@ -1083,13 +1079,13 @@ test('Dry-run skips fail', async (t) => {
const error1 = new SemanticReleaseError('error 1', 'ERR1');
const error2 = new SemanticReleaseError('error 2', 'ERR2');
const fail = stub().resolves();
const fail = sinon.stub().resolves();
const options = {
dryRun: true,
branches: ['master'],
repositoryUrl,
verifyConditions: [stub().rejects(error1), stub().rejects(error2)],
verifyConditions: [sinon.stub().rejects(error1), sinon.stub().rejects(error2)],
fail,
};
@@ -1131,12 +1127,12 @@ test('Force a dry-run if not on a CI and "noCi" is not explicitly set', async (t
};
const notes = 'Release notes';
const verifyConditions = stub().resolves();
const analyzeCommits = stub().resolves(nextRelease.type);
const verifyRelease = stub().resolves();
const generateNotes = stub().resolves(notes);
const publish = stub().resolves();
const success = stub().resolves();
const verifyConditions = sinon.stub().resolves();
const analyzeCommits = sinon.stub().resolves(nextRelease.type);
const verifyRelease = sinon.stub().resolves();
const generateNotes = sinon.stub().resolves(notes);
const publish = sinon.stub().resolves();
const success = sinon.stub().resolves();
const options = {
dryRun: false,
@@ -1146,11 +1142,11 @@ test('Force a dry-run if not on a CI and "noCi" is not explicitly set', async (t
analyzeCommits,
verifyRelease,
generateNotes,
addChannel: stub().resolves(),
prepare: stub().resolves(),
addChannel: sinon.stub().resolves(),
prepare: sinon.stub().resolves(),
publish,
success,
fail: stub().resolves(),
fail: sinon.stub().resolves(),
};
const semanticRelease = requireNoCache('..', {
@@ -1187,8 +1183,8 @@ test('Dry-run does not print changelog if "generateNotes" return "undefined"', a
await gitPush(repositoryUrl, 'master', {cwd});
const nextRelease = {type: 'major', version: '2.0.0', gitHead: await getGitHead({cwd}), gitTag: 'v2.0.0'};
const analyzeCommits = stub().resolves(nextRelease.type);
const generateNotes = stub().resolves();
const analyzeCommits = sinon.stub().resolves(nextRelease.type);
const generateNotes = sinon.stub().resolves();
const options = {
dryRun: true,
@@ -1240,12 +1236,12 @@ test('Allow local releases with "noCi" option', async (t) => {
};
const notes = 'Release notes';
const verifyConditions = stub().resolves();
const analyzeCommits = stub().resolves(nextRelease.type);
const verifyRelease = stub().resolves();
const generateNotes = stub().resolves(notes);
const publish = stub().resolves();
const success = stub().resolves();
const verifyConditions = sinon.stub().resolves();
const analyzeCommits = sinon.stub().resolves(nextRelease.type);
const verifyRelease = sinon.stub().resolves();
const generateNotes = sinon.stub().resolves(notes);
const publish = sinon.stub().resolves();
const success = sinon.stub().resolves();
const options = {
noCi: true,
@@ -1255,11 +1251,11 @@ test('Allow local releases with "noCi" option', async (t) => {
analyzeCommits,
verifyRelease,
generateNotes,
addChannel: stub().resolves(),
prepare: stub().resolves(),
addChannel: sinon.stub().resolves(),
prepare: sinon.stub().resolves(),
publish,
success,
fail: stub().resolves(),
fail: sinon.stub().resolves(),
};
const semanticRelease = requireNoCache('..', {
@@ -1309,27 +1305,27 @@ test('Accept "undefined" value returned by "generateNotes" and "false" by "publi
gitTag: 'v1.2.0',
channel: null,
};
const analyzeCommits = stub().resolves(nextRelease.type);
const verifyRelease = stub().resolves();
const generateNotes1 = stub().resolves();
const analyzeCommits = sinon.stub().resolves(nextRelease.type);
const verifyRelease = sinon.stub().resolves();
const generateNotes1 = sinon.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 generateNotes2 = sinon.stub().resolves(notes2);
const publish = sinon.stub().resolves(false);
const addChannel = sinon.stub().resolves(false);
const success = sinon.stub().resolves();
const options = {
branches: ['master', 'next'],
repositoryUrl,
verifyConditions: stub().resolves(),
verifyConditions: sinon.stub().resolves(),
analyzeCommits,
verifyRelease,
generateNotes: [generateNotes1, generateNotes2],
addChannel,
prepare: stub().resolves(),
prepare: sinon.stub().resolves(),
publish,
success,
fail: stub().resolves(),
fail: sinon.stub().resolves(),
};
const semanticRelease = requireNoCache('..', {
@@ -1392,12 +1388,12 @@ test('Throws "EINVALIDNEXTVERSION" if next release is out of range of the curren
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 verifyConditions = sinon.stub().resolves();
const verifyRelease = sinon.stub().resolves();
const addChannel = sinon.stub().resolves();
const prepare = sinon.stub().resolves();
const publish = sinon.stub().resolves();
const success = sinon.stub().resolves();
const config = {
branches: [{name: '1.x'}, {name: 'master'}],
@@ -1444,12 +1440,12 @@ test('Throws "EINVALIDNEXTVERSION" if next release is out of range of the curren
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 verifyConditions = sinon.stub().resolves();
const verifyRelease = sinon.stub().resolves();
const addChannel = sinon.stub().resolves();
const prepare = sinon.stub().resolves();
const publish = sinon.stub().resolves();
const success = sinon.stub().resolves();
const config = {
branches: [{name: 'master'}, {name: 'next'}, {name: 'next-major'}],
@@ -1502,15 +1498,15 @@ test('Throws "EINVALIDMAINTENANCEMERGE" if merge an out of range release in a ma
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 verifyConditions = sinon.stub().resolves();
const analyzeCommits = sinon.stub().resolves();
const verifyRelease = sinon.stub().resolves();
const generateNotes = sinon.stub().resolves(notes);
const addChannel = sinon.stub().resolves();
const prepare = sinon.stub().resolves();
const publish = sinon.stub().resolves();
const success = sinon.stub().resolves();
const fail = sinon.stub().resolves();
const config = {branches: [{name: 'master'}, {name: '1.1.x'}], repositoryUrl, tagFormat: `v\${version}`};
const options = {
@@ -1585,15 +1581,15 @@ test('Returns false if not running from the configured branch', async (t) => {
const options = {
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(),
fail: stub().resolves(),
verifyConditions: sinon.stub().resolves(),
analyzeCommits: sinon.stub().resolves(),
verifyRelease: sinon.stub().resolves(),
generateNotes: sinon.stub().resolves(),
addChannel: sinon.stub().resolves(),
prepare: sinon.stub().resolves(),
publish: sinon.stub().resolves(),
success: sinon.stub().resolves(),
fail: sinon.stub().resolves(),
};
const semanticRelease = requireNoCache('..', {
@@ -1622,23 +1618,23 @@ test('Returns false if there is no relevant changes', async (t) => {
await gitCommits(['First'], {cwd});
await gitPush(repositoryUrl, 'master', {cwd});
const analyzeCommits = stub().resolves();
const verifyRelease = stub().resolves();
const generateNotes = stub().resolves();
const publish = stub().resolves();
const analyzeCommits = sinon.stub().resolves();
const verifyRelease = sinon.stub().resolves();
const generateNotes = sinon.stub().resolves();
const publish = sinon.stub().resolves();
const options = {
branches: ['master'],
repositoryUrl,
verifyConditions: [stub().resolves()],
verifyConditions: [sinon.stub().resolves()],
analyzeCommits,
verifyRelease,
generateNotes,
addChannel: stub().resolves(),
prepare: stub().resolves(),
addChannel: sinon.stub().resolves(),
prepare: sinon.stub().resolves(),
publish,
success: stub().resolves(),
fail: stub().resolves(),
success: sinon.stub().resolves(),
fail: sinon.stub().resolves(),
};
const semanticRelease = requireNoCache('..', {
@@ -1682,19 +1678,19 @@ test('Exclude commits with [skip release] or [release skip] from analysis', asyn
{cwd}
);
await gitPush(repositoryUrl, 'master', {cwd});
const analyzeCommits = stub().resolves();
const analyzeCommits = sinon.stub().resolves();
const config = {branches: ['master'], repositoryUrl, globalOpt: 'global'};
const options = {
...config,
verifyConditions: [stub().resolves(), stub().resolves()],
verifyConditions: [sinon.stub().resolves(), sinon.stub().resolves()],
analyzeCommits,
verifyRelease: stub().resolves(),
generateNotes: stub().resolves(),
addChannel: stub().resolves(),
prepare: stub().resolves(),
publish: stub().resolves(),
success: stub().resolves(),
fail: stub().resolves(),
verifyRelease: sinon.stub().resolves(),
generateNotes: sinon.stub().resolves(),
addChannel: sinon.stub().resolves(),
prepare: sinon.stub().resolves(),
publish: sinon.stub().resolves(),
success: sinon.stub().resolves(),
fail: sinon.stub().resolves(),
};
const semanticRelease = requireNoCache('..', {
@@ -1722,8 +1718,8 @@ test('Log both plugins errors and errors thrown by "fail" plugin', async (t) =>
const options = {
branches: ['master'],
repositoryUrl,
verifyConditions: stub().rejects(pluginError),
fail: [stub().rejects(failError1), stub().rejects(failError2)],
verifyConditions: sinon.stub().rejects(pluginError),
fail: [sinon.stub().rejects(failError1), sinon.stub().rejects(failError2)],
};
const semanticRelease = requireNoCache('..', {
'./lib/get-logger': () => t.context.logger,
@@ -1742,12 +1738,12 @@ test('Log both plugins errors and errors thrown by "fail" plugin', async (t) =>
test('Call "fail" only if a plugin returns a SemanticReleaseError', async (t) => {
const {cwd, repositoryUrl} = await gitRepo(true);
const pluginError = new Error('Plugin error');
const fail = stub().resolves();
const fail = sinon.stub().resolves();
const options = {
branches: ['master'],
repositoryUrl,
verifyConditions: stub().rejects(pluginError),
verifyConditions: sinon.stub().rejects(pluginError),
fail,
};
const semanticRelease = requireNoCache('..', {
@@ -1795,16 +1791,16 @@ test('Throw an Error if plugin returns an unexpected value', async (t) => {
await gitCommits(['Second'], {cwd});
await gitPush(repositoryUrl, 'master', {cwd});
const verifyConditions = stub().resolves();
const analyzeCommits = stub().resolves('string');
const verifyConditions = sinon.stub().resolves();
const analyzeCommits = sinon.stub().resolves('string');
const options = {
branches: ['master'],
repositoryUrl,
verifyConditions: [verifyConditions],
analyzeCommits,
success: stub().resolves(),
fail: stub().resolves(),
success: sinon.stub().resolves(),
fail: sinon.stub().resolves(),
};
const semanticRelease = requireNoCache('..', {
@@ -1821,19 +1817,19 @@ test('Throw an Error if plugin returns an unexpected value', async (t) => {
test('Hide sensitive information passed to "fail" plugin', async (t) => {
const {cwd, repositoryUrl} = await gitRepo(true);
const fail = stub().resolves();
const fail = sinon.stub().resolves();
const env = {MY_TOKEN: 'secret token'};
const options = {
branch: 'master',
repositoryUrl,
verifyConditions: stub().throws(
verifyConditions: sinon.stub().throws(
new SemanticReleaseError(
`Message: Exposing token ${env.MY_TOKEN}`,
'ERR',
`Details: Exposing token ${env.MY_TOKEN}`
)
),
success: stub().resolves(),
success: sinon.stub().resolves(),
fail,
};
@@ -1864,7 +1860,7 @@ test('Hide sensitive information passed to "success" plugin', async (t) => {
await gitCommits(['feat: new feature'], {cwd});
await gitPush(repositoryUrl, 'master', {cwd});
const success = stub().resolves();
const success = sinon.stub().resolves();
const env = {MY_TOKEN: 'secret token'};
const options = {
branch: 'master',
@@ -1872,14 +1868,14 @@ test('Hide sensitive information passed to "success" plugin', async (t) => {
verifyConditions: false,
verifyRelease: false,
prepare: false,
generateNotes: stub().resolves(`Exposing token ${env.MY_TOKEN}`),
publish: stub().resolves({
generateNotes: sinon.stub().resolves(`Exposing token ${env.MY_TOKEN}`),
publish: sinon.stub().resolves({
name: `Name: Exposing token ${env.MY_TOKEN}`,
url: `URL: Exposing token ${env.MY_TOKEN}`,
}),
addChannel: false,
success,
fail: stub().resolves(),
fail: sinon.stub().resolves(),
};
const semanticRelease = requireNoCache('..', {
@@ -1917,19 +1913,19 @@ test('Get all commits including the ones not in the shallow clone', async (t) =>
channel: undefined,
};
const notes = 'Release notes';
const analyzeCommits = stub().resolves(nextRelease.type);
const analyzeCommits = sinon.stub().resolves(nextRelease.type);
const config = {branches: ['master'], repositoryUrl, globalOpt: 'global'};
const options = {
...config,
verifyConditions: stub().resolves(),
verifyConditions: sinon.stub().resolves(),
analyzeCommits,
verifyRelease: stub().resolves(),
generateNotes: stub().resolves(notes),
prepare: stub().resolves(),
publish: stub().resolves(),
success: stub().resolves(),
fail: stub().resolves(),
verifyRelease: sinon.stub().resolves(),
generateNotes: sinon.stub().resolves(notes),
prepare: sinon.stub().resolves(),
publish: sinon.stub().resolves(),
success: sinon.stub().resolves(),
fail: sinon.stub().resolves(),
};
const semanticRelease = requireNoCache('..', {
+19 -16
View File
@@ -1,14 +1,16 @@
const path = require('path');
const test = require('ava');
const proxyquire = require('proxyquire');
const {escapeRegExp} = require('lodash');
const {writeJson, readJson} = require('fs-extra');
const execa = require('execa');
const {WritableStreamBuffer} = require('stream-buffers');
const delay = require('delay');
const getAuthUrl = require('../lib/get-git-auth-url');
const {SECRET_REPLACEMENT} = require('../lib/definitions/constants');
const {
import path from 'path';
import test from 'ava';
import proxyquire from 'proxyquire';
import lodash from 'lodash'
const {escapeRegExp} = lodash
import {writeJson, readJson} from 'fs-extra';
import execa from 'execa';
import {WritableStreamBuffer} from 'stream-buffers';
import delay from 'delay';
import getAuthUrl from '../lib/get-git-auth-url.js';
import {SECRET_REPLACEMENT} from '../lib/definitions/constants.js';
import {
gitHead,
gitTagHead,
gitRepo,
@@ -18,11 +20,12 @@ const {
gitCheckout,
merge,
gitGetNote,
} = require('./helpers/git-utils');
const {npmView} = require('./helpers/npm-utils');
const gitbox = require('./helpers/gitbox');
const mockServer = require('./helpers/mockserver');
const npmRegistry = require('./helpers/npm-registry');
} from './helpers/git-utils.js';
import {npmView} from './helpers/npm-utils.js';
import gitbox from './helpers/gitbox.js';
import mockServer from './helpers/mockserver.js';
import npmRegistry from './helpers/npm-registry.js';
/* eslint camelcase: ["error", {properties: "never"}] */
+17 -16
View File
@@ -1,16 +1,17 @@
const test = require('ava');
const {noop} = require('lodash');
const {stub} = require('sinon');
const normalize = require('../../lib/plugins/normalize');
import test from 'ava';
import lodash from 'lodash'
const {noop} = lodash
import sinon from 'sinon';
import normalize from '../../lib/plugins/normalize.js';
const cwd = process.cwd();
test.beforeEach((t) => {
// Stub the logger functions
t.context.log = stub();
t.context.error = stub();
t.context.success = stub();
t.context.stderr = {write: stub()};
t.context.log = sinon.stub);
t.context.error = sinon.stub);
t.context.success = sinon.stub);
t.context.stderr = {write: sinon.stub)};
t.context.logger = {
log: t.context.log,
error: t.context.error,
@@ -99,7 +100,7 @@ test('Normalize and load plugin that retuns multiple functions', (t) => {
});
test('Wrap "analyzeCommits" plugin in a function that validate the output of the plugin', async (t) => {
const analyzeCommits = stub().resolves(2);
const analyzeCommits = sinon.stub).resolves(2);
const plugin = normalize(
{cwd, options: {}, stderr: t.context.stderr, logger: t.context.logger},
'analyzeCommits',
@@ -117,7 +118,7 @@ test('Wrap "analyzeCommits" plugin in a function that validate the output of the
});
test('Wrap "generateNotes" plugin in a function that validate the output of the plugin', async (t) => {
const generateNotes = stub().resolves(2);
const generateNotes = sinon.stub).resolves(2);
const plugin = normalize(
{cwd, options: {}, stderr: t.context.stderr, logger: t.context.logger},
'generateNotes',
@@ -135,7 +136,7 @@ test('Wrap "generateNotes" plugin in a function that validate the output of the
});
test('Wrap "publish" plugin in a function that validate the output of the plugin', async (t) => {
const publish = stub().resolves(2);
const publish = sinon.stub).resolves(2);
const plugin = normalize(
{cwd, options: {}, stderr: t.context.stderr, logger: t.context.logger},
'publish',
@@ -153,7 +154,7 @@ test('Wrap "publish" plugin in a function that validate the output of the plugin
});
test('Wrap "addChannel" plugin in a function that validate the output of the plugin', async (t) => {
const addChannel = stub().resolves(2);
const addChannel = sinon.stub).resolves(2);
const plugin = normalize(
{cwd, options: {}, stderr: t.context.stderr, logger: t.context.logger},
'addChannel',
@@ -171,7 +172,7 @@ test('Wrap "addChannel" plugin in a function that validate the output of the plu
});
test('Plugin is called with "pluginConfig" (with object definition) and input', async (t) => {
const pluginFunction = stub().resolves();
const pluginFunction = sinon.stub).resolves();
const pluginConf = {path: pluginFunction, conf: 'confValue'};
const options = {global: 'globalValue'};
const plugin = normalize({cwd, options, logger: t.context.logger}, '', pluginConf, {});
@@ -186,7 +187,7 @@ test('Plugin is called with "pluginConfig" (with object definition) and input',
});
test('Plugin is called with "pluginConfig" (with array definition) and input', async (t) => {
const pluginFunction = stub().resolves();
const pluginFunction = sinon.stub).resolves();
const pluginConf = [pluginFunction, {conf: 'confValue'}];
const options = {global: 'globalValue'};
const plugin = normalize({cwd, options, logger: t.context.logger}, '', pluginConf, {});
@@ -201,7 +202,7 @@ test('Plugin is called with "pluginConfig" (with array definition) and input', a
});
test('Prevent plugins to modify "pluginConfig"', async (t) => {
const pluginFunction = stub().callsFake((pluginConfig) => {
const pluginFunction = sinon.stub).callsFake((pluginConfig) => {
pluginConfig.conf.subConf = 'otherConf';
});
const pluginConf = {path: pluginFunction, conf: {subConf: 'originalConf'}};
@@ -214,7 +215,7 @@ test('Prevent plugins to modify "pluginConfig"', async (t) => {
});
test('Prevent plugins to modify its input', async (t) => {
const pluginFunction = stub().callsFake((pluginConfig, options) => {
const pluginFunction = sinon.stub).callsFake((pluginConfig, options) => {
options.param.subParam = 'otherParam';
});
const input = {param: {subParam: 'originalSubParam'}, options: {}};

Some files were not shown because too many files have changed in this diff Show More