Quick Start

Before starting, if you already have a CHANGELOG.md read the backup guide first.

Run init to bootstrap your project with a sample config, header and empty changelog.

changie init

You can configure changie by editing the generated .changie.yaml file.

When completing work on a feature, bugfix or user impacting change use the new command to generate your change file.

changie new

When it is time to prepare your next release, batch all unreleased changes into one using the batch command.

# changie supports semver bump values for batch
changie batch <major|minor|patch>
# as well as an explicit version
changie batch <version>

After you have batched a new version you can merge it into the parent changelog using the merge command.

changie merge