# https://git-cliff.org/docs/configuration [changelog] # template for the changelog header header = """ --- title: "" linkTitle: "Changelog" weight: 5 menu: false type: docs --- """ # template for the changelog body # https://keats.github.io/tera/docs/#introduction body = """ {% if version %}\
{{ version | trim_start_matches(pat="v") }} {{ timestamp | date(format="%Y-%m-%d") }} - {{ commit_id | truncate(length=7, end="") }}
\ {% else %}\
unreleased/untagged
{% endif %}\ {% for group, commits in commits | group_by(attribute="group") %}

{% for commit in commits %}
- {{ commit.id | truncate(length=7, end="") }} {{ commit.message | upper_first }}
{% endfor %}\
{% endfor %}\n
""" # template for the changelog footer footer = """ """ # remove the leading and trailing whitespace from the templates trim = true [git] # parse the commits based on https://www.conventionalcommits.org conventional_commits = true # filter out the commits that are not conventional filter_unconventional = true # process each line of a commit as an individual commit split_commits = false # regex for parsing and grouping commits commit_parsers = [ { message = "Release rosenpass version", group = "๐Ÿ“ Release" }, { message = "^feat", group = "๐Ÿš€ Features" }, { message = "^fix", group = "๐Ÿ› Bug Fixes" }, { message = "^doc|Documentation|Doc", group = "๐Ÿ“š Documentation" }, { message = "^perf", group = "โšก Performance" }, { message = "^refactor", group = "๐Ÿšœ Refactor" }, { message = "^style", group = "๐ŸŽจ Styling" }, { message = "^test", group = "๐Ÿงช Testing" }, { field = "author.name", pattern = "dependabot", skip = true }, { message = "^chore\\(release\\): prepare for", skip = true }, { message = "^chore\\(deps.*\\)", skip = true }, { message = "^chore\\(pr\\)", skip = true }, { message = "^chore\\(pull\\)", skip = true }, { body = ".*security", group = "๐Ÿ›ก๏ธ Security" }, { message = "^revert", group = "โ—€๏ธ Revert" }, # Catch-all for uncategorized commits { message = ".*", group = "๐Ÿ“ฆ Miscellaneous Tasks" }, ] # protect breaking changes from being skipped due to matching a skipping commit_parser protect_breaking_commits = false # filter out the commits that are not matched by commit parsers filter_commits = false # regex for matching git tags tag_pattern = "v[0-9].*" # regex for skipping tags skip_tags = "v0.1.0-beta.1" # regex for ignoring tags ignore_tags = "" # sort the tags topologically topo_order = false # sort the commits inside sections by oldest/newest order sort_commits = "newest"