Npm-github-config NPM

npm-github-config

Semantic-release shareable config for NPM with GitHub.

npm i -D semantic-release npm-github-config @semantic-release/{changelog,git}

In package.json:

{
  "release": {
    "extends": "npm-github-config"  
  }
}

$ npm i -g semantic-release npm-github-config @semantic-release/{changelog,git}
$ semantic-release -e npm-github-config

The GitHub authentication configuration is required and can be set via environment variables.

The npm authentication configuration is required and can be set via 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

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"
  }
}

5 years ago

6 years ago

6 years ago