|
1 | | -# git-cliff ~ default configuration file |
2 | | -# https://git-cliff.org/docs/configuration |
3 | | -# |
4 | | -# Lines starting with "#" are comments. |
5 | | -# Configuration options are organized into tables and keys. |
6 | | -# See documentation for more information on available options. |
7 | | - |
8 | | -[changelog] |
9 | | -# changelog header |
10 | | -header = """ |
11 | | -# Changelog\n |
12 | | -All notable changes to this project will be documented in this file.\n |
13 | | -""" |
14 | | -# template for the changelog body |
15 | | -# https://keats.github.io/tera/docs/#introduction |
16 | | -body = """ |
17 | | -{% if version %}\ |
18 | | - ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }} |
19 | | -{% else %}\ |
20 | | - ## [unreleased] |
21 | | -{% endif %}\ |
22 | | -{% for group, commits in commits | group_by(attribute="group") %} |
23 | | - ### {{ group | striptags | trim | upper_first }} |
24 | | - {% for commit in commits %} |
25 | | - - {% if commit.scope %}*({{ commit.scope }})* {% endif %}\ |
26 | | - {% if commit.breaking %}[**breaking**] {% endif %}\ |
27 | | - {{ commit.message | upper_first }}\ |
28 | | - {% endfor %} |
29 | | -{% endfor %}\n |
30 | | -""" |
31 | | -# template for the changelog footer |
32 | | -footer = """ |
33 | | -<!-- generated by git-cliff --> |
34 | | -""" |
35 | | -# remove the leading and trailing s |
36 | | -trim = true |
37 | | -# postprocessors |
38 | | -postprocessors = [ |
39 | | - # { pattern = '<REPO>', replace = "https://github.com/orhun/git-cliff" }, # replace repository URL |
40 | | -] |
41 | | - |
42 | | -[git] |
43 | | -# parse the commits based on https://www.conventionalcommits.org |
44 | | -conventional_commits = true |
45 | | -# filter out the commits that are not conventional |
46 | | -filter_unconventional = true |
47 | | -# process each line of a commit as an individual commit |
48 | | -split_commits = false |
49 | | -# regex for preprocessing the commit messages |
50 | | -commit_preprocessors = [ |
51 | | - # Replace issue numbers |
52 | | - #{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/issues/${2}))"}, |
53 | | - # Check spelling of the commit with https://github.com/crate-ci/typos |
54 | | - # If the spelling is incorrect, it will be automatically fixed. |
55 | | - #{ pattern = '.*', replace_command = 'typos --write-changes -' }, |
56 | | -] |
57 | | -# regex for parsing and grouping commits |
58 | | -commit_parsers = [ |
59 | | - { message = "^feat", group = "<!-- 0 -->🚀 Features" }, |
60 | | - { message = "^fix", group = "<!-- 1 -->🐛 Bug Fixes" }, |
61 | | - { message = "^doc", group = "<!-- 3 -->📚 Documentation" }, |
62 | | - { message = "^perf", group = "<!-- 4 -->⚡ Performance" }, |
63 | | - { message = "^refactor", group = "<!-- 2 -->🚜 Refactor" }, |
64 | | - { message = "^style", group = "<!-- 5 -->🎨 Styling" }, |
65 | | - { message = "^test", group = "<!-- 6 -->🧪 Testing" }, |
66 | | - { message = "^chore\\(release\\): prepare for", skip = true }, |
67 | | - { message = "^chore\\(deps.*\\)", skip = true }, |
68 | | - { message = "^chore\\(pr\\)", skip = true }, |
69 | | - { message = "^chore\\(pull\\)", skip = true }, |
70 | | - { message = "^chore|^ci", group = "<!-- 7 -->⚙️ Miscellaneous Tasks" }, |
71 | | - { body = ".*security", group = "<!-- 8 -->🛡️ Security" }, |
72 | | - { message = "^revert", group = "<!-- 9 -->◀️ Revert" }, |
73 | | -] |
74 | | -# protect breaking changes from being skipped due to matching a skipping commit_parser |
75 | | -protect_breaking_commits = false |
76 | | -# filter out the commits that are not matched by commit parsers |
77 | | -filter_commits = false |
78 | | -# regex for matching git tags |
79 | | -# tag_pattern = "v[0-9].*" |
80 | | -# regex for skipping tags |
81 | | -# skip_tags = "" |
82 | | -# regex for ignoring tags |
83 | | -# ignore_tags = "" |
84 | | -# sort the tags topologically |
85 | | -topo_order = false |
86 | | -# sort the commits inside sections by oldest/newest order |
87 | | -sort_commits = "oldest" |
88 | | -# limit the number of commits included in the changelog. |
89 | | -# limit_commits = 42 |
| 1 | +# git-cliff ~ default configuration file |
| 2 | +# https://git-cliff.org/docs/configuration |
| 3 | +# |
| 4 | +# Lines starting with "#" are comments. |
| 5 | +# Configuration options are organized into tables and keys. |
| 6 | +# See documentation for more information on available options. |
| 7 | + |
| 8 | +[changelog] |
| 9 | +# changelog header |
| 10 | +header = """ |
| 11 | +# Changelog\n |
| 12 | +All notable changes to this project will be documented in this file.\n |
| 13 | +""" |
| 14 | +# template for the changelog body |
| 15 | +# https://keats.github.io/tera/docs/#introduction |
| 16 | +body = """ |
| 17 | +{% if version %}\ |
| 18 | + ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }} |
| 19 | +{% else %}\ |
| 20 | + ## [unreleased] |
| 21 | +{% endif %}\ |
| 22 | +{% for group, commits in commits | group_by(attribute="group") %} |
| 23 | + ### {{ group | striptags | trim | upper_first }} |
| 24 | + {% for commit in commits %} |
| 25 | + - {% if commit.scope %}*({{ commit.scope }})* {% endif %}\ |
| 26 | + {% if commit.breaking %}[**breaking**] {% endif %}\ |
| 27 | + {{ commit.message | upper_first }}\ |
| 28 | + {% endfor %} |
| 29 | +{% endfor %}\n |
| 30 | +""" |
| 31 | +# template for the changelog footer |
| 32 | +footer = """ |
| 33 | +<!-- generated by git-cliff --> |
| 34 | +""" |
| 35 | +# remove the leading and trailing s |
| 36 | +trim = true |
| 37 | +# postprocessors |
| 38 | +postprocessors = [ |
| 39 | + # { pattern = '<REPO>', replace = "https://github.com/orhun/git-cliff" }, # replace repository URL |
| 40 | +] |
| 41 | + |
| 42 | +[git] |
| 43 | +# parse the commits based on https://www.conventionalcommits.org |
| 44 | +conventional_commits = true |
| 45 | +# filter out the commits that are not conventional |
| 46 | +filter_unconventional = true |
| 47 | +# process each line of a commit as an individual commit |
| 48 | +split_commits = false |
| 49 | +# regex for preprocessing the commit messages |
| 50 | +commit_preprocessors = [ |
| 51 | + # Replace issue numbers |
| 52 | + #{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/issues/${2}))"}, |
| 53 | + # Check spelling of the commit with https://github.com/crate-ci/typos |
| 54 | + # If the spelling is incorrect, it will be automatically fixed. |
| 55 | + #{ pattern = '.*', replace_command = 'typos --write-changes -' }, |
| 56 | +] |
| 57 | +# regex for parsing and grouping commits |
| 58 | +commit_parsers = [ |
| 59 | + { message = "^feat", group = "<!-- 0 -->🚀 Features" }, |
| 60 | + { message = "^fix", group = "<!-- 1 -->🐛 Bug Fixes" }, |
| 61 | + { message = "^docs?", group = "<!-- 3 -->📚 Documentation" }, |
| 62 | + { message = "^perf", group = "<!-- 4 -->⚡ Performance" }, |
| 63 | + { message = "^refactor", group = "<!-- 2 -->🚜 Refactor" }, |
| 64 | + { message = "^style", group = "<!-- 5 -->🎨 Styling" }, |
| 65 | + { message = "^test", group = "<!-- 6 -->🧪 Testing" }, |
| 66 | + { message = "^chore\\(release\\): prepare for", skip = true }, |
| 67 | + { message = "^chore\\(deps.*\\)", skip = true }, |
| 68 | + { message = "^chore\\(pr\\)", skip = true }, |
| 69 | + { message = "^chore\\(pull\\)", skip = true }, |
| 70 | + { message = "^chore|^ci", group = "<!-- 7 -->⚙️ Miscellaneous Tasks" }, |
| 71 | + { body = ".*security", group = "<!-- 8 -->🛡️ Security" }, |
| 72 | + { message = "^revert", group = "<!-- 9 -->◀️ Revert" }, |
| 73 | +] |
| 74 | +# protect breaking changes from being skipped due to matching a skipping commit_parser |
| 75 | +protect_breaking_commits = false |
| 76 | +# filter out the commits that are not matched by commit parsers |
| 77 | +filter_commits = false |
| 78 | +# regex for matching git tags |
| 79 | +# tag_pattern = "v[0-9].*" |
| 80 | +# regex for skipping tags |
| 81 | +# skip_tags = "" |
| 82 | +# regex for ignoring tags |
| 83 | +# ignore_tags = "" |
| 84 | +# sort the tags topologically |
| 85 | +topo_order = false |
| 86 | +# sort the commits inside sections by oldest/newest order |
| 87 | +sort_commits = "oldest" |
| 88 | +# limit the number of commits included in the changelog. |
| 89 | +# limit_commits = 42 |
0 commit comments