https://github.com/eclass/semantic-release-npm-github-config
Semantic-release shareable config for NPM with Github
https://github.com/eclass/semantic-release-npm-github-config
changelog git github npm semantic-release semantic-release-config
Last synced: 6 months ago
JSON representation
Semantic-release shareable config for NPM with Github
- Host: GitHub
- URL: https://github.com/eclass/semantic-release-npm-github-config
- Owner: eclass
- License: mit
- Created: 2018-09-18T16:30:01.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-02-23T23:11:59.000Z (over 1 year ago)
- Last Synced: 2024-04-24T20:43:21.552Z (about 1 year ago)
- Topics: changelog, git, github, npm, semantic-release, semantic-release-config
- Language: JavaScript
- Size: 1.04 MB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# @eclass/semantic-release-npm-github-config
[](https://www.npmjs.com/package/@eclass/semantic-release-npm-github-config)
[](https://www.npmjs.com/package/@eclass/semantic-release-npm-github-config)
[](https://codeclimate.com/github/eclass/semantic-release-npm-github-config/maintainability)
> [Semantic-release](https://github.com/semantic-release/semantic-release) shareable config for [NPM](https://www.npmjs.com/) with [GitHub](https://github.com/).
## Usage
### Local installation
```bash
npm i -D semantic-release @eclass/semantic-release-npm-github-config @semantic-release/{changelog,git}
```
In `package.json`:
```json
{
"release": {
"extends": "@eclass/semantic-release-npm-github-config"
}
}
```
### Global installation
```bash
$ npm i -g semantic-release @eclass/semantic-release-npm-github-config @semantic-release/{changelog,git}
$ semantic-release -e @eclass/semantic-release-npm-github-config
```
## Configuration
### GitHub authentication
The GitHub authentication configuration is **required** and can be set via [environment variables](#environment-variables).
See [GitHub authentication](https://github.com/semantic-release/gitlab#gitlab-authentication).
### Npm registry authentication
The npm authentication configuration is **required** and can be set via [environment variables](#environment-variables).
See [Npm registry authentication](https://github.com/semantic-release/npm#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](https://docs.npmjs.com/getting-started/working_with_tokens#how-to-create-new-tokens) |
### Additional options
This shareable config uses the [`@semantic-release/changelog`](https://github.com/semantic-release/changelog), [`@semantic-release/git`](https://github.com/semantic-release/git), [`@semantic-release/github`](https://github.com/semantic-release/github) and [`@semantic-release/npm`](https://github.com/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:
```json
{
"release": {
"extends": "@eclass/semantic-release-npm-github-config",
"githubUrl": "https://custom.github.com"
}
}
```
## License
[MIT](https://tldrlegal.com/license/mit-license)