spread0x/changie

Automated changelog tool for preparing releases with lots of customization options

Changie

Separate your changelog from commit messages without conflicts.

Features

• File based changelog management keeps your commit history and release notes separate.
• Track changes while you work while the knowledge is fresh.
• Extensive configuration options to fit your project.
• Language and framework agnostic using a single go binary.

Getting Started

• User documentation is available on the website.
• Specifically, the guide is a good place to start.
• View Changie's Changelog for an example.

Need help?

Use the discussions page for help requests and how-to questions.

Please open GitHub issues for bugs and feature requests. File an issue before creating a pull request, unless it is something simple like a typo.

Media

• Introduction to Changelog Management
• Get help with Changie
• Headers, footers, bumping, latest, dry run
• Prereleases and metadata
• Choices and Replacements

Want to Contribute?

If you want to contribute through code or documentation, the Contributing guide is the place to start. If you need additional help create an issue or post on discussions.

Semantic Version Compatibility

Changie is focused around the CLI and its configuration options and aims to keep existing CLI commands and options suported in major versions. It is possible to use Changie as a dependent package but no support or compability is guaranteed.

License

Distributed under the MIT License.