|
| 1 | +# git-cliff ~ configuration file |
| 2 | +# https://git-cliff.org/docs/configuration |
| 3 | + |
| 4 | +[changelog] |
| 5 | +# A Tera template to be rendered for each release in the changelog. |
| 6 | +# See https://keats.github.io/tera/docs/#introduction |
| 7 | +body = """ |
| 8 | +{% if version %}\ |
| 9 | + ## {{ version | trim_start_matches(pat="v") }} - {{ timestamp | date(format="%Y-%m-%d") }}\ |
| 10 | +{% else %}\ |
| 11 | + ## Unreleased |
| 12 | +{% endif %}\ |
| 13 | +{% for group, commits in commits | group_by(attribute="group") %} |
| 14 | + ### {{ group | upper_first }} |
| 15 | + {% for commit in commits %}\ |
| 16 | + - {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }}\ |
| 17 | + {% if commit.remote.username %} by @{{ commit.remote.username }}{%- endif %}\ |
| 18 | + {% if commit.remote.pr_number %} in #{{ commit.remote.pr_number }}\ |
| 19 | + {% else %} in ([{{ commit.id | truncate(length=7, end="") }}]({{ commit.id }}))\ |
| 20 | + {%- endif %} |
| 21 | + {% endfor %}\ |
| 22 | +{% endfor %}\ |
| 23 | +{% raw %}\n{% endraw %} |
| 24 | +""" |
| 25 | + |
| 26 | +[git] |
| 27 | +conventional_commits = true |
| 28 | +filter_commits = true |
| 29 | +commit_parsers = [ |
| 30 | + { message = "^feat", group = "Features" }, |
| 31 | + { message = "^fix", group = "Bug Fixes" }, |
| 32 | + { message = "^doc", group = "Documentation" }, |
| 33 | + { message = "^perf", group = "Performance" }, |
| 34 | + { message = "^refactor", group = "Refactor" }, |
| 35 | + { message = "^style", group = "Styling" }, |
| 36 | + { message = "^test", group = "Testing" }, |
| 37 | + { message = "^chore\\(release\\):", skip = true }, |
| 38 | + { message = "^chore|^ci", group = "Miscellaneous Tasks" }, |
| 39 | +] |
0 commit comments