# git-cliff configuration — changelog generated from Conventional Commits. # https://git-cliff.org · renders the placeholder notes of the draft GitHub Release (release.yml) and the # .deb changelog (contrib/debian/gen-docs.sh); the published notes come from the github-release-notes skill. [changelog] header = """ # Changelog All notable changes to Ferrofin are documented here. The format follows [Keep a Changelog](https://keepachangelog.com) and [Conventional Commits](https://www.conventionalcommits.org); versions follow [Semantic Versioning](https://semver.org). What to do, or plan for, when you upgrade is in [docs/UPGRADING.md](docs/UPGRADING.md).\n """ # tera template — one section per release, grouped by commit type. body = """ {% if version %}\ ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }} {% else %}\ ## [Unreleased] {% endif %}\ {% for group, commits in commits | group_by(attribute="group") %} ### {{ group | upper_first }} {% for commit in commits %}\ - {{ commit.message | upper_first }}{% if commit.breaking %} **[breaking]**{% endif %} {% endfor %}\ {% endfor %}\n """ trim = true footer = "" [git] conventional_commits = true filter_unconventional = false split_commits = false # Map commit prefixes to changelog sections. commit_parsers = [ { message = "^Merge", skip = true }, { message = "^[Ww]ip", skip = true }, { message = "^style", skip = true }, { message = "^feat", group = "Features" }, { message = "^fix", group = "Bug Fixes" }, { message = "^perf", group = "Performance" }, { message = "^refactor", group = "Refactor" }, { message = "^doc", group = "Documentation" }, { message = "^test", group = "Testing" }, { message = "^ci", group = "CI/CD" }, { message = "^build", group = "Build" }, { message = "^chore\\(release\\)", skip = true }, { message = "^chore", group = "Miscellaneous" }, { body = ".*security", group = "Security" }, ] # Only final vX.Y.Z tags count. An unanchored "v[0-9]*" also matched chart-v* and -rc.N tags. tag_pattern = "^v[0-9]+\\.[0-9]+\\.[0-9]+$" filter_commits = false topo_order = false sort_commits = "oldest"