Nix Auto Changelog

This flake provides run auto-changelog, a NodeJS tool for generating a changelog from git tags and commit history.

The idea behind this tool is to have a quick up-and-running tool to generate a changelog using Nix.

Usage

While being extremely stable for years, "flake" is an upcoming feature of the Nix package manager. In order to use it, you must explicitly enable it, please check the documentation to enable it, this is currently an opt-in option.

In your project directory, run:

nix run github:loophp/nix-auto-changelog

To generate the changelog for until a specific tag (<tag>):

nix run github:loophp/nix-auto-changelog -- -v <tag>

To see all the available options, run:

nix run github:loophp/nix-auto-changelog -- --help

A configuration file .auto-changelog can be created per project, as such:

{
  "output": "CHANGELOG.md",
  "template": "keepachangelog",
  "unreleased": true,
  "commitLimit": false,
  "hideCredit": true,
  "sortCommits": "date-desc",
  "breakingPattern": "BREAKING CHANGE: yes"
}

For all the configuration properties, check the project homepage.

Contributing

Feel free to contribute by sending pull requests. We are a usually very responsive team and we will help you going through your pull request from the beginning to the end.

For some reasons, if you can't contribute to the code and willing to help, sponsoring is a good, sound and safe way to show us some gratitude for the hours we invested in this package.

Sponsor me on Github and/or any of the contributors.

Changelog

See CHANGELOG.md for a changelog based on git commits.

For more detailed changelogs, please check the release changelogs.