|
| 1 | +# git-cliff 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 | +header = """ |
| 10 | +## What's new |
| 11 | +""" |
| 12 | +# template for the changelog body |
| 13 | +# https://tera.netlify.app/docs |
| 14 | +body = """ |
| 15 | +{% for group, commits in commits | group_by(attribute="group") %}\ |
| 16 | + {% for commit in commits %} |
| 17 | + - {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first | trim }}\ |
| 18 | + {% if commit.github.username %} by @{{ commit.github.username }}{%- endif %}\ |
| 19 | + {% endfor %}\ |
| 20 | +{% endfor %} |
| 21 | +""" |
| 22 | +# remove the leading and trailing whitespace from the template |
| 23 | +trim = true |
| 24 | +footer = """ |
| 25 | +""" |
| 26 | +postprocessors = [ ] |
| 27 | +[git] |
| 28 | +# parse the commits based on https://www.conventionalcommits.org |
| 29 | +conventional_commits = true |
| 30 | +# filter out the commits that are not conventional |
| 31 | +filter_unconventional = false |
| 32 | +# process each line of a commit as an individual commit |
| 33 | +split_commits = false |
| 34 | +# regex for preprocessing the commit messages |
| 35 | +commit_preprocessors = [] |
| 36 | +# regex for parsing and grouping commits |
| 37 | +commit_parsers = [ |
| 38 | + { message = "^build\\(deps\\)", skip = true }, |
| 39 | + { message = "^build\\(deps-dev\\)", skip = true }, |
| 40 | + { message = "^ci", skip = true }, |
| 41 | + { body = ".*", group = "Changes" }, |
| 42 | +] |
| 43 | +# protect breaking changes from being skipped due to matching a skipping commit_parser |
| 44 | +protect_breaking_commits = false |
| 45 | +# filter out the commits that are not matched by commit parsers |
| 46 | +filter_commits = false |
| 47 | +# glob pattern for matching git tags |
| 48 | +tag_pattern = "v[0-9]*" |
| 49 | +# regex for skipping tags |
| 50 | +skip_tags = "" |
| 51 | +# regex for ignoring tags |
| 52 | +ignore_tags = "" |
| 53 | +# sort the tags topologically |
| 54 | +topo_order = false |
| 55 | +# sort the commits inside sections by oldest/newest order |
| 56 | +sort_commits = "newest" |
| 57 | +# limit the number of commits included in the changelog. |
| 58 | +# limit_commits = 42 |
0 commit comments