semantic-changelog-gen

Semantic Changelog Gen

A lightweight and extensible changelog generator working with semantic commits. This generator sticks to the rules defined in Karma Git Commit Msg.

How to install

If you have Go installed, it's as simple as running:

go get github.com/typusomega/semantic-changelog-gen

Usage

To generate your changelog simply navigate into the git repository and run:

semantic-changelog-gen generate

You can also specify the repository and the output file like this:

semantic-changelog-gen generate \
   --dir /path/to/repo \
   --out /path/to/changelog.md

If you are tired of the default markdown format used by the generator, feel free to use your own style:

semantic-changelog-gen generate \
   --dir /path/to/repo \
   --out /path/to/changelog.vnext \
   --format custom \
   --template /path/to/your/go.tpl

If you are consistent with the scoping of your commits, you may also include them into your changelog:

semantic-changelog-gen generate --include-scopes

Contribution

Create a new issue if you want to:

• have a new feature
• report a bug
• something else

Pull requests are welcome