Getting Started

Changelogs are generated by the Git2SemVer.Tool, instruction to install are here.

To generate a changelog, in a directory in your repository, run:

git2semver changelog

A changelog in the current directory named CHANGELOG.md will be created with any changes described by Conventional Commits since the last release.

It also created a directory .git2semver/changelog to hold data files that will be used when later updating the changelog. All of these files should be added to the repository.

As changes are made and committed using Conventional Commits, the new changes will be added to the changelog. You can groom the changelog and rerun the command and your changes will not be lost.

To customise the changelog see Customising.

For more information on usign the changelog generator see Workflows.