Changelog (git-cliff)

relwolf delegates all changelog formatting to git-cliff (bundled via npm). Put a cliff.toml into your repository to control groups, templates, header and footer. Which commit types appear in the changelog is purely git-cliff configuration.

• relwolf passes the file with --config when you set cliff-config; otherwise git-cliff finds cliff.toml in the repository root on its own.
• relwolf adds --tag, --tag-pattern, --include-path/--exclude-path and the commit range, and prepends the entry to the changelog file.
• Use RELWOLF_GIT_CLIFF to run your own git-cliff executable instead of the bundled one.

WARNING

Release merge requests are titled chore(release): Create release …. Make sure your cliff.toml does not list that commit in the changelog (relwolf's own cliff.toml skips all chore commits).

Example: everything except chores

[git]
conventional_commits = true
filter_unconventional = true
commit_parsers = [
  { message = "^chore", skip = true },
  { message = "^feat", group = "Features" },
  { message = "^fix", group = "Bug Fixes" },
  { message = "^doc", group = "Documentation" },
]

See the git-cliff documentation for templates, links to diffs and contributor sections. relwolf's own cliff.toml is a complete example with diff links and a "Special thanks" section.