create a change log based on your commit history and tags
This toolkit only contains one tool currently. That tool will create a
changelog.md for a project using the git
repository tags and the git commit history.
composer require --dev chancegarcia/git-toolkit
Unless specified in a config file, the repository found in the current working directory will be used.
Default values for some command arguments and options can be set via a config file in
.dist file provides an example of configuration options.
The following values are configurable:
project_root: the directory where the repository resides
project_name: The main header value
filename: name of the markdown file to write out.
output_directory: path to where the markdown file should be written
./vendor/bin/toolkit toolkit:changelog toolkit:changelog
The changelog file will produce a markdown document with a main header (optionally set by the header argument)
Projecty McProjectFace. Tag names are the subheaders and the commits between the tags are printed after the
While you can run the base command, without a header argument, to produce a changelog, you might want to pass the a main
header argument with it. Unless you really want to have the top header be
Projecty McProjectFace (totally not judging)
./vendor/bin/toolkit toolkit:changelog toolkit:changelog "I am not a cat."
If no tags are present. The subheader will be the commit id.
In order to "create" a new tag, use the
--new-tag=<NEWTAG> to set the new header and write all recent commits since
the previous tag (if there is one) into the changelog.
./vendor/chancegarcia/git-toolkit/bin/toolkit toolkit:changelog "We Love Kittens" --new-tag="1.0.0"