This project provides tooling support for working with Keep A Changelog.
Run the following to install this library:
$ composer require phly/keep-a-changelog
Alternately, install globally, for use with any repository:
$ composer global require phly/keep-a-changelog
If you install globally, ensure you add $HOME/.composer/bin
to your $PATH
environment variable. Once setup this way, you can call keep-a-changelog
instead of ./vendor/bin/keep-a-changelog
.
You may get a list of commands by running:
$ ./vendor/bin/keep-a-changelog
Currently supported commands include:
-
tag
allows tagging a release based on the latest version discovered in theCHANGELOG.md
file. The tag will contain the changelog entry for that version within the commit message. -
release
will push a tag to GitHub, and then create a release for it, using the changelog entry for the release. -
bump
andbump:bugfix
will prepend a new changelog entry for a new bugfix release, based on the latest release found in theCHANGELOG.md
file. -
bump:minor
will prepend a new changelog entry for a new minor release, based on the latest release found in theCHANGELOG.md
file. -
bump:major
will prepend a new changelog entry for a new major release, based on the latest release found in theCHANGELOG.md
file.
For a list of required parameters and all options for a command, run:
$ ./vendor/bin/keep-a-changelog help <command>