Skip to content

vveysner/github-release-from-changelog

 
 

Repository files navigation

github-release-from-changelog NPM version

Create GitHub releases from CHANGELOG.md

Included in npmpub(lish) !.

You need:

  • a CHANGELOG following the format of keep a changelog or a CHANGELOG with the following format:
# X.Y.Z - ...

...
  • a package.json with a version field
  • a git tag with the corresponding version in either X.Y.Z or vX.Y.Z formats
  • a GITHUB_TOKEN as an env var

This tool edit the git tag on GitHub and create a GitHub release with the correct CHANGELOG.md section.

Install

npm install github-release-from-changelog

Usage

github-release-from-changelog [--filename CustomChangelog.md]

CONTRIBUTING

  • ⇄ Pull requests and ★ Stars are always welcome.
  • For bugs and feature requests, please create an issue.

About

Create GitHub releases from CHANGELOG.md

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%