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