github-publish-release

Tools aimed to simplify release publishing on github. It gets latest release available and builds a list of pull requests that were merged thereafter. As a result you get a nicely looking release notes:

Usage no npm install needed!

<script type="module">
  import githubPublishRelease from 'https://cdn.skypack.dev/github-publish-release';
</script>

README

github-publish-release

Tools aimed to simplify release publishing on github. It gets latest release available and builds a list of pull requests that were merged thereafter. As a result you get a nicely looking release notes:

  • initial version #1 (by @runk)
  • fix path, update readme #2 (by @runk)

Configuration

In order to use this tool you need to generate personal access token with repository access (see help article for details), then configure environment variable GITHUB_OAUTH_TOKEN with this token. That's it.

Expected release flow

  1. Make a commit with message including [major], [minor] or [patch].
git commit -a -m '[major]: Do some breaking changes'
  1. Run github-publish-release script.
  2. Push local changes (that occur in p. 1) to github with git push --follow-tags or similar.
  3. Publish module with npm publish.