lgaticaqnpm-github-config
Semantic-release shareable config for NPM with GitHub.
Usage
Local installation
npm i -D semantic-release npm-github-config @semantic-release/{changelog,git}
In package.json:
{
"release": {
"extends": "npm-github-config"
}
}
Global installation
$ npm i -g semantic-release npm-github-config @semantic-release/{changelog,git}
$ semantic-release -e npm-github-config
Configuration
GitHub authentication
The GitHub authentication configuration is required and can be set via environment variables.
Npm registry authentication
The npm authentication configuration is required and can be set via environment variables.
See Npm registry authentication
Environment variables
| Variable | Description |
|---|---|
GH_TOKEN or GITHUB_TOKEN |
Required. The token used to authenticate with GitLab repository. |
NPM_TOKEN |
Required. Npm token created via npm token create |
Additional options
This shareable config uses the @semantic-release/changelog, @semantic-release/git, @semantic-release/github and @semantic-release/npm plugins. See the documentation of each plugins for additional options.
Options can be set in the Semantic-release configuration.
For example to set a custom GitHub URL:
{
"release": {
"extends": "npm-github-config",
"githubUrl": "https://custom.github.com"
}
}