|
| 1 | +# git-cliff ~ default configuration file |
| 2 | +# https://git-cliff.org/docs/configuration |
| 3 | + |
| 4 | +[changelog] |
| 5 | +# template for the changelog header |
| 6 | +header = """ |
| 7 | +# Changelog\n |
| 8 | +All notable changes to this project will be documented in this file.\n |
| 9 | +""" |
| 10 | +# template for the changelog body |
| 11 | +# https://keats.github.io/tera/docs/#introduction |
| 12 | +body = """ |
| 13 | +{% for group, commits in commits | group_by(attribute="group") %} |
| 14 | + ### {{ group | striptags | trim | upper_first }} |
| 15 | + {% for commit in commits %} |
| 16 | + - {% if commit.scope %}*({{ commit.scope }})* {% endif %}\ |
| 17 | + {% if commit.breaking %}[**breaking**] {% endif %}\ |
| 18 | + {{ commit.message | upper_first }}\ |
| 19 | + {% if commit.remote.username %} by @{{ commit.remote.username }}{%- endif -%}\ |
| 20 | + {% endfor %} |
| 21 | +{% endfor %}\n |
| 22 | +
|
| 23 | +
|
| 24 | +{% if github.contributors | filter(attribute="is_first_time", value=true) | length != 0 %} |
| 25 | + ## New Contributors ❤️ |
| 26 | +{% endif %}\ |
| 27 | +{% for contributor in github.contributors | filter(attribute="is_first_time", value=true) %} |
| 28 | + * @{{ contributor.username }} made their first contribution |
| 29 | + {%- if contributor.pr_number %} in \ |
| 30 | + [#{{ contributor.pr_number }}]({{ self::remote_url() }}/pull/{{ contributor.pr_number }}) \ |
| 31 | + {%- endif %} |
| 32 | +{%- endfor -%} |
| 33 | +
|
| 34 | +{% if version %} |
| 35 | + {% if previous.version %} |
| 36 | + **Full Changelog**: {{ self::remote_url() }}/compare/{{ previous.version }}...{{ version }} |
| 37 | + {% endif %} |
| 38 | +{% else -%} |
| 39 | + {% raw %}\n{% endraw %} |
| 40 | +{% endif %} |
| 41 | +
|
| 42 | +{%- macro remote_url() -%} |
| 43 | + https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }} |
| 44 | +{%- endmacro -%} |
| 45 | +
|
| 46 | +""" |
| 47 | +# template for the changelog footer |
| 48 | +footer = """ |
| 49 | +<!-- generated by git-cliff --> |
| 50 | +""" |
| 51 | +# remove the leading and trailing s |
| 52 | +trim = true |
| 53 | +# postprocessors |
| 54 | +postprocessors = [ |
| 55 | + # { pattern = '<REPO>', replace = "https://github.com/orhun/git-cliff" }, # replace repository URL |
| 56 | +] |
| 57 | + |
| 58 | +[git] |
| 59 | +# parse the commits based on https://www.conventionalcommits.org |
| 60 | +conventional_commits = true |
| 61 | +# filter out the commits that are not conventional |
| 62 | +filter_unconventional = false |
| 63 | +# process each line of a commit as an individual commit |
| 64 | +split_commits = false |
| 65 | +# regex for preprocessing the commit messages |
| 66 | +commit_preprocessors = [ |
| 67 | + # Replace issue numbers |
| 68 | + #{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/issues/${2}))"}, |
| 69 | + # Check spelling of the commit with https://github.com/crate-ci/typos |
| 70 | + # If the spelling is incorrect, it will be automatically fixed. |
| 71 | + #{ pattern = '.*', replace_command = 'typos --write-changes -' }, |
| 72 | +] |
| 73 | +# regex for parsing and grouping commits |
| 74 | +commit_parsers = [ |
| 75 | + { message = "^feat", group = "<!-- 0 -->🚀 Features" }, |
| 76 | + { message = "^fix", group = "<!-- 1 -->🐛 Bug Fixes" }, |
| 77 | + { message = "^refactor", group = "<!-- 2 -->🚜 Refactor" }, |
| 78 | + { message = "^doc", group = "<!-- 3 -->📚 Documentation" }, |
| 79 | + { message = "^perf", group = "<!-- 4 -->⚡ Performance" }, |
| 80 | + { message = "^style\\(fmt\\)", skip = true }, |
| 81 | + { message = "^style", group = "<!-- 5 -->🎨 Styling" }, |
| 82 | + { message = "^test", group = "<!-- 6 -->🧪 Testing" }, |
| 83 | + { message = "^build", group = "<!-- 7 -->🛠️ Builds" }, |
| 84 | + { message = "^chore\\(release\\): prepare for", skip = true }, |
| 85 | + { message = "^chore\\(deps.*\\)", skip = true }, |
| 86 | + { message = "^chore\\(pr\\)", skip = true }, |
| 87 | + { message = "^chore\\(pull\\)", skip = true }, |
| 88 | + { message = "^chore|^ci", group = "<!-- 8 -->⚙️ Miscellaneous Tasks" }, |
| 89 | + { body = ".*security", group = "<!-- 9 -->🛡️ Security" }, |
| 90 | + { message = "^revert", group = "<!-- 10 -->◀️ Revert" }, |
| 91 | +] |
| 92 | +# filter out the commits that are not matched by commit parsers |
| 93 | +filter_commits = false |
| 94 | +# sort the tags topologically |
| 95 | +topo_order = false |
| 96 | +# sort the commits inside sections by oldest/newest order |
| 97 | +sort_commits = "oldest" |
0 commit comments