Create GitHub releases from CHANGELOG.mdgithub-release-from-changelog
Create GitHub releases from
This tool edits the git tag on GitHub and create a GitHub release with the correct changelog section.
- a changelog file (various filenames supported automatically or specified via
--filenameoption) with markdown titles that start with the version (eg:
- a git tag with the corresponding version in either
GITHUB_TOKENas an env var. See https://github.com/MoOx/npmpub#requirements for instructions.
Included in npmpub !
npm install github-release-from-changelog
github-release-from-changelog [--filename CustomChangelog.md]
Specify your own filename
Test what the release will looks like
Display parsing information
Advanced Installation and Usage
github-release-from-changelog is fully integrated in npmpub. Please follow the instructions at https://github.com/MoOx/npmpub#install to install and use it. npmpub automatically calls github-release-from-changelog by default.
github-release-from-changelog also plays well with other publishing tools such as release-it.
One can create a release using release-it (which also updates
package.json, but does not free you from maintaining
CHANGELOG.md for yourself) and then use github-release-from-changelog to create the release on GitHub.
- ⇄ Pull requests and ★ Stars are always welcome.
- For bugs and feature requests, please create an issue.
The license is MIT. See LICENSE.