Last active
October 22, 2024 18:19
-
-
Save eeriemyxi/da2edd0187f157f3de1f2dc74bdb6426 to your computer and use it in GitHub Desktop.
cliff-git config file. See also: https://gist.github.com/eeriemyxi/3765765c994bbd2af201f844e6793097
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# git-cliff ~ configuration file | |
# https://git-cliff.org/docs/configuration | |
[changelog] | |
postprocessors = [ | |
{ pattern = '\$REPO', replace = "{{REPO}}" }, # replace repository URL | |
] | |
# template for the changelog header | |
header = """ | |
# Changelog\n | |
All notable changes to this project will be documented in this file. See [conventional commits](https://www.conventionalcommits.org/) for commit guidelines.\n | |
""" | |
# template for the changelog body | |
# https://keats.github.io/tera/docs/#introduction | |
body = """ | |
--- | |
{% if version %}\ | |
{% if previous.version %}\ | |
## [{{ version | trim_start_matches(pat="v") }}]($REPO/compare/{{ previous.version }}..{{ version }}) - {{ timestamp | date(format="%Y-%m-%d") }} | |
{% else %}\ | |
## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }} | |
{% endif %}\ | |
{% else %}\ | |
## [unreleased] | |
{% endif %}\ | |
{% for group, commits in commits | group_by(attribute="group") %} | |
### {{ group | striptags | trim | upper_first }} | |
{% for commit in commits | |
| filter(attribute="scope") | |
| sort(attribute="scope") %} | |
- **({{commit.scope}})**{% if commit.breaking %} [**breaking**]{% endif %} \ | |
{{ commit.message }} - ([{{ commit.id | truncate(length=7, end="") }}]($REPO/commit/{{ commit.id }})) - {{ commit.author.name }} | |
{%- endfor -%} | |
{% raw %}\n{% endraw %}\ | |
{%- for commit in commits %} | |
{%- if commit.scope -%} | |
{% else -%} | |
- {% if commit.breaking %} [**breaking**]{% endif %}\ | |
{{ commit.message }} - ([{{ commit.id | truncate(length=7, end="") }}]($REPO/commit/{{ commit.id }})) - {{ commit.author.name }} | |
{% endif -%} | |
{% endfor -%} | |
{% endfor %}\n | |
""" | |
# template for the changelog footer | |
footer = """ | |
<!-- generated by git-cliff --> | |
""" | |
# remove the leading and trailing whitespace from the templates | |
trim = true | |
# postprocessors | |
[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 preprocessing the commit messages | |
commit_preprocessors = [ | |
# { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](https://github.com/orhun/git-cliff/issues/${2}))"}, # replace issue numbers | |
] | |
# regex for parsing and grouping commits | |
commit_parsers = [ | |
{ message = "^feat", group = "Features" }, | |
{ message = "^fix", group = "Bug Fixes" }, | |
{ message = "^doc", group = "Documentation" }, | |
{ message = "^perf", group = "Performance" }, | |
{ message = "^refactor", group = "Refactoring" }, | |
{ message = "^style", group = "Style" }, | |
{ message = "^revert", group = "Revert" }, | |
{ message = "^test", group = "Tests" }, | |
{ message = "^chore\\(version\\):", skip = true }, | |
{ message = "^chore", group = "Miscellaneous Chores" }, | |
{ body = ".*security", group = "Security" }, | |
] | |
# filter out the commits that are not matched by commit parsers | |
filter_commits = false | |
# sort the tags topologically | |
topo_order = false | |
# sort the commits inside sections by oldest/newest order | |
sort_commits = "oldest" |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment