acts/CI/cliff.toml

0001 # git-cliff ~ default configuration file
0002 # https://git-cliff.org/docs/configuration
0003 #
0004 # Lines starting with "#" are comments.
0005 # Configuration options are organized into tables and keys.
0006 # See documentation for more information on available options.
0007
0008 [changelog]
0009 # changelog header
0010 header = """
0011 """
0012 # template for the changelog body
0013 # https://keats.github.io/tera/docs/#introduction
0014 body = """
0015 {% if version %}\
0016     # {{ version | trim_start_matches(pat="v") }}
0017 {% else %}\
0018     # [unreleased]
0019 {% endif %}\
0020 {% for group, commits in commits | group_by(attribute="group") %}
0021     ## {{ group | striptags | trim | upper_first }}
0022     {% for commit in commits %}
0023         - {% if commit.scope %}*({{ commit.scope }})* {% endif %}\
0024             {% if commit.breaking %} 🚨 **BREAKING**: {% endif %}\
0025             {{ commit.message | upper_first }}\
0026             {% if commit.github.username %} by @{{ commit.github.username }}{%- endif %}\
0027     {% endfor %}
0028 {% endfor %}\n
0029 """
0030 # template for the changelog footer
0031 footer = """
0032 """
0033 # remove the leading and trailing s
0034 trim = true
0035 # postprocessors
0036 postprocessors = [
0037   # { pattern = '<REPO>', replace = "https://github.com/orhun/git-cliff" }, # replace repository URL
0038 ]
0039
0040 [git]
0041 # parse the commits based on https://www.conventionalcommits.org
0042 conventional_commits = true
0043 # filter out the commits that are not conventional
0044 filter_unconventional = true
0045 # process each line of a commit as an individual commit
0046 split_commits = false
0047 # regex for preprocessing the commit messages
0048 commit_preprocessors = [
0049   # Replace issue numbers
0050   #{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/issues/${2}))"},
0051   # Check spelling of the commit with https://github.com/crate-ci/typos
0052   # If the spelling is incorrect, it will be automatically fixed.
0053   #{ pattern = '.*', replace_command = 'typos --write-changes -' },
0054 ]
0055 # regex for parsing and grouping commits
0056 commit_parsers = [
0057   { message = "^feat", group = "<!-- 0 -->🚀 Features" },
0058   { message = "^fix", group = "<!-- 1 -->🐛 Bug Fixes" },
0059   { message = "^doc", group = "<!-- 3 -->📚 Documentation" },
0060   { message = "^perf", group = "<!-- 4 -->⚡ Performance" },
0061   { message = "^refactor", group = "<!-- 2 -->🚜 Refactor" },
0062   { message = "^test", group = "<!-- 6 -->🧪 Testing" },
0063   { message = "^build", group = "<!-- 7 --> 🛠️ Build" },
0064   { message = "^chore\\(deps.*\\)", skip = true },
0065   { message = "^chore|^ci", group = "<!-- 8 -->⚙️ Miscellaneous Tasks" },
0066   { body = ".*security", group = "<!-- 9 -->🛡️ Security" },
0067   { message = "^revert", group = "<!-- 10 -->◀️ Revert" },
0068 ]
0069 # protect breaking changes from being skipped due to matching a skipping commit_parser
0070 protect_breaking_commits = false
0071 # filter out the commits that are not matched by commit parsers
0072 filter_commits = false
0073 # regex for matching git tags
0074 # tag_pattern = "v[0-9].*"
0075 # regex for skipping tags
0076 # skip_tags = ""
0077 # regex for ignoring tags
0078 # ignore_tags = ""
0079 # sort the tags topologically
0080 topo_order = false
0081 # sort the commits inside sections by oldest/newest order
0082 sort_commits = "oldest"
0083 # limit the number of commits included in the changelog.
0084 # limit_commits = 42
0085
0086 [remote.github]
0087 owner = "acts-project"
0088 repo = "acts"