A CLI for semantic releases. Writes a changelog and tags the new version.
Table of contents
Many projects need versioning. It is always the same: testing, writing the changelog, updating the version, tagging the commit, and finally releasing the new version.
sgr will take care of all of them, so you can focus on the more important stuff: code
$ npm i -g semantic-git-release-cli
$ yarn add global semantic-git-release-cli
Forget the times when you had to manually write changelogs, update versions, tag commits. Now just type:
or if you already have an alias for sgr, use following instead:
semantic-git-release-cli was build to be as simple as possible, so there are just a few commands you need to know.
semantic-git-release-cli was build to be as simple as possible, so there are just a few options you need to know.
sgr you can release a new version of your project.
So there are a few tasks
semantic-git-release-cli will do for you:
- removes and reinstalls
- runs tests by calling
- updates the
- creates or updates the
- commits and tags the new
# release a new version $ sgr
sgr recover [backup] you can recover your complete CHANGELOG.md if you just started to use
semantic-git-release-cli but already released (and tagged) versions.
# generates the complete CHANGELOG.md $ sgr recover # generates the complete CHANGELOG.md, and creates a backup of the old one $ sgr recover --backup
sgr version you can display the current version of
# current version $ sgr version
sgr recover --backup
sgr recover --backup you can recover your complete CHANGELOG.md, and recover the old CHANGELOG.md to
# generates the complete CHANGELOG.md and saves the old CHANGELOG.md to `.sgr_backup` $ sgr recover --backup
sgr --help you can display usage of
# usage of cli $ sgr --help
sgr --version you can display the current version of
# current version $ sgr --version