semantic-git-release-cli
A CLI for semantic releases. Writes a changelog and tags the new version.
Table of contents
Why?
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
Installation
$ npm i -g semantic-git-release-cli
or
$ yarn add global semantic-git-release-cli
Usage
Forget the times when you had to manually write changelogs, update versions, tag commits. Now just type:
$ sgr
or if you already have an alias for sgr, use following instead:
$ semantic-git-release
Commands
semantic-git-release-cli
was build to be as simple as possible, so there are just a few commands you need to know.
Options
semantic-git-release-cli
was build to be as simple as possible, so there are just a few options you need to know.
sgr
With sgr
you can release a new version of your project.
Tasks
So there are a few tasks semantic-git-release-cli
will do for you:
- removes and reinstalls
node_modules
(prefersyarn
by default) - runs tests by calling
npm test
- updates the
version
inpackage.json
- creates or updates the
CHANGELOG.md
- commits and tags the new
version
# release a new version
$ sgr
sgr recover
With 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
With sgr version
you can display the current version of semantic-git-release-cli
.
# current version
$ sgr version
sgr recover --backup
With sgr recover --backup
you can recover your complete CHANGELOG.md, and recover the old CHANGELOG.md to .sgr_backup
.
# generates the complete CHANGELOG.md and saves the old CHANGELOG.md to `.sgr_backup`
$ sgr recover --backup
sgr --help
With sgr --help
you can display usage of semantic-git-release-cli
.
# usage of cli
$ sgr --help
sgr --version
With sgr --version
you can display the current version of semantic-git-release-cli
.
# current version
$ sgr --version