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