| 1 | # github-publish-release
|
| 2 |
|
| 3 | Tools aimed to simplify release publishing on github. It gets latest release available and builds a list of pull
|
| 4 | requests that were merged thereafter. As a result you get a nicely looking release notes:
|
| 5 |
|
| 6 | -----
|
| 7 |
|
| 8 | - initial version #1 (by @runk)
|
| 9 | - fix path, update readme #2 (by @runk)
|
| 10 |
|
| 11 | -----
|
| 12 |
|
| 13 |
|
| 14 | #### Configuration
|
| 15 |
|
| 16 | In order to use this tool you need to generate personal access token with repository access (see
|
| 17 | [help article](https://help.github.com/articles/creating-an-access-token-for-command-line-use/) for details), then
|
| 18 | configure environment variable `GITHUB_OAUTH_TOKEN` with this token. That's it.
|
| 19 |
|
| 20 | #### Expected release flow
|
| 21 |
|
| 22 | 1. Bump version in `package.json`, either manually or via `npm version minor` etc.
|
| 23 | 2. Run `github-publish-release` script.
|
| 24 | 3. Push local changes (that occur in p. 1) to github with `git push --follow-tags` or similar.
|
| 25 | 4. Publish module with `npm publish`.
|