mirror of
https://github.com/scratchfoundation/scratch-semantic-release-config.git
synced 2024-11-30 11:17:20 -05:00
41 lines
1.9 KiB
Markdown
41 lines
1.9 KiB
Markdown
# @jedmao/semantic-release-npm-github-config
|
|
|
|
[**semantic-release**](https://github.com/semantic-release/semantic-release) shareable config to publish npm packages with [GitHub](https://github.com).
|
|
|
|
[](https://travis-ci.com/jedmao/semantic-release-npm-github-config)
|
|
[](https://www.npmjs.com/package/@jedmao/semantic-release-npm-github-config)
|
|
|
|
## Plugins
|
|
|
|
This shareable configuration use the following plugins:
|
|
|
|
- [`@semantic-release/commit-analyzer`](https://github.com/semantic-release/commit-analyzer)
|
|
- [`@semantic-release/release-notes-generator`](https://github.com/semantic-release/release-notes-generator)
|
|
- [`@semantic-release/npm`](https://github.com/semantic-release/npm)
|
|
- [`@semantic-release/github`](https://github.com/semantic-release/github)
|
|
- [`@semantic-release/git`](https://github.com/semantic-release/git)
|
|
|
|
## Install
|
|
|
|
```bash
|
|
$ npm install --save-dev semantic-release @jedmao/semantic-release-npm-github-config
|
|
```
|
|
|
|
## Usage
|
|
|
|
The shareable config can be configured in the [**semantic-release** configuration file](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#configuration):
|
|
|
|
```json
|
|
{
|
|
"extends": "@jedmao/semantic-release-npm-github-config",
|
|
"branch": "master"
|
|
}
|
|
```
|
|
|
|
## Configuration
|
|
|
|
Ensure that your CI configuration has the following **_secret_** environment variables set:
|
|
- [`GH_TOKEN`](https://github.com/settings/tokens) with [`public_repo`](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/#available-scopes) access.
|
|
- [`NPM_TOKEN`](https://docs.npmjs.com/cli/token)
|
|
|
|
See each [plugin](#plugins) documentation for required installation and configuration steps.
|