d0b304e240
- Remove the `getLastRelease` plugin type - Retrieve the last release based on Git tags - Create the next release Git tag before calling the `publish` plugins BREAKING CHANGE: Remove the `getLastRelease` plugin type The `getLastRelease` plugins will not be called anymore. BREAKING CHANGE: Git repository authentication is now mandatory The Git authentication is now mandatory and must be set via `GH_TOKEN`, `GITHUB_TOKEN`, `GL_TOKEN`, `GITLAB_TOKEN` or `GIT_CREDENTIALS` as described in [CI configuration](https://github.com/semantic-release/semantic-release/blob/caribou/docs/usage/ci-configuration.md#authentication).
4.1 KiB
Configuration
In order to customize semantic-release’s behavior, options and plugins can be set via:
- A
.releasercfile, written in YAML or JSON, with optional extensions: .yaml/.yml/.json/.js - A
release.config.jsfile that exports an object - A
releasekey in the project'spackage.jsonfile - CLI arguments
The following two examples are the same.
Via CLI argument:
$ semantic-release --branch next
Via release key in the project's package.json file:
"release": {
"branch": "next"
}
$ semantic-release
Note: CLI arguments take precedence over options configured in the configuration file.
Note: Plugins options cannot be defined via CLI arguments and must be defined in the configuration file.
Options
extends
Type: Array, String
CLI arguments: -e, --extends
List of modules or file paths containing a shareable configuration. If multiple shareable configuration are set, they will be imported in the order defined with each configuration option taking precedence over the options defined in a previous shareable configuration.
Note: Options defined via CLI arguments or in the configuration file will take precedence over the ones defined in any shareable configuration.
branch
Type: String
Default: master
CLI arguments: -b, --branch
The branch on which releases should happen.
repositoryUrl
Type: String
Default: repository property in package.json or git origin url
CLI arguments: -r, --repository-url
The git repository URL
Any valid git url format is supported (See Git protocols).
Note: If the Github plugin is used the URL must be a valid Github URL that include the owner, the repository name and the host. The Github shorthand URL is not supported.
dryRun
Type: Boolean
Default: false if running in a CI environment, false otherwise
CLI arguments: -d, --dry-run
Dry-run mode, skip publishing, print next version and release notes.
noCi
Type: Boolean
Default: false
CLI arguments: --no-ci
Skip Continuous Integration environment verifications, allowing to make releases from a local machine.
debug
Type: Boolean
Default: false
CLI argument: --debug
Output debugging information. It can also be enabled by set the DEBUG environment variable to semantic-release.
verifyConditions
Type: Array, String, Object
Default: ['@semantic-release/npm', '@semantic-release/github']
CLI argument: --verify-conditions
Define the list of verify conditions plugins. Plugins will run in series, in the order defined in the Array.
See Plugins configuration for more details.
analyzeCommits
Type: String, Object
Default: ['@semantic-release/commit-analyzer']
CLI argument: --analyze-commits
Define the analyze commits plugin.
See Plugins configuration for more details.
verifyRelease
Type: Array, String, Object
Default: []
CLI argument: --verify-release
Define the list of verify release plugins. Plugins will run in series, in the order defined in the Array.
See Plugins configuration for more details.
generateNotes
Type: String, Object
Default: ['@semantic-release/release-notes-generator']
CLI argument: --generate-notes
Define the generate notes plugin.
See Plugins configuration for more details.
publish
Type: Array, String, Object
Default: ['@semantic-release/npm', '@semantic-release/github']
CLI argument: --publish
Define the list of publish plugins. Plugins will run in series, in the order defined in the Array.
See Plugins configuration for more details.