Sienna Meridian Satterwhite
1e2055d66c
- Add cliff.toml with conventional commits configuration - Configure changelog sections and formatting - Regenerate CHANGELOG.md using git-cliff - Set up automatic changelog generation for future releases
85 lines
2.9 KiB
TOML
85 lines
2.9 KiB
TOML
# git-cliff configuration file
|
|
# https://git-cliff.org/docs/configuration
|
|
|
|
[changelog]
|
|
# changelog header
|
|
header = """
|
|
# Changelog
|
|
|
|
All notable changes to this project will be documented in this file.
|
|
|
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
|
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\n
|
|
"""
|
|
# template for the changelog body
|
|
body = """
|
|
{% if version %}\
|
|
## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
|
|
{% else %}\
|
|
## [Unreleased]
|
|
{% endif %}\
|
|
{% for group, commits in commits | group_by(attribute="group") %}
|
|
### {{ group | upper_first }}
|
|
{% for commit in commits %}
|
|
- {% if commit.scope %}**{{ commit.scope }}**: {% endif %}{{ commit.message | upper_first }}\
|
|
{% if commit.breaking %} [**BREAKING**]{% endif %}
|
|
{% endfor %}
|
|
{% endfor %}\n
|
|
"""
|
|
# template for the changelog footer
|
|
footer = """
|
|
<!-- generated by git-cliff -->
|
|
"""
|
|
# remove the leading and trailing whitespace from the templates
|
|
trim = true
|
|
|
|
[git]
|
|
# parse the commits based on https://www.conventionalcommits.org
|
|
conventional_commits = true
|
|
# filter out the commits that are not conventional
|
|
filter_unconventional = true
|
|
# process each line of a commit as an individual commit
|
|
split_commits = false
|
|
# regex for preprocessing the commit messages
|
|
commit_preprocessors = [
|
|
# Remove issue numbers from commits
|
|
# { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "" },
|
|
]
|
|
# regex for parsing and grouping commits
|
|
commit_parsers = [
|
|
{ message = "^feat", group = "<!-- 0 -->Features" },
|
|
{ message = "^fix", group = "<!-- 1 -->Bug Fixes" },
|
|
{ message = "^doc", group = "<!-- 2 -->Documentation" },
|
|
{ message = "^perf", group = "<!-- 3 -->Performance" },
|
|
{ message = "^refactor", group = "<!-- 4 -->Refactoring" },
|
|
{ message = "^style", group = "<!-- 5 -->Styling" },
|
|
{ message = "^test", group = "<!-- 6 -->Testing" },
|
|
{ message = "^chore\\(release\\):", skip = true },
|
|
{ message = "^chore\\(deps\\)", skip = true },
|
|
{ message = "^chore\\(pr\\)", skip = true },
|
|
{ message = "^chore\\(pull\\)", skip = true },
|
|
{ message = "^chore|ci", group = "<!-- 7 -->Miscellaneous Tasks" },
|
|
{ body = ".*security", group = "<!-- 8 -->Security" },
|
|
{ message = "^revert", group = "<!-- 9 -->Revert" },
|
|
]
|
|
# protect breaking changes from being skipped due to matching a skipping commit_parser
|
|
protect_breaking_commits = false
|
|
# filter out the commits that are not matched by commit parsers
|
|
filter_commits = false
|
|
# regex for matching git tags
|
|
tag_pattern = "v[0-9].*"
|
|
# regex for skipping tags
|
|
skip_tags = ""
|
|
# regex for ignoring tags
|
|
ignore_tags = ""
|
|
# sort the tags topologically
|
|
topo_order = false
|
|
# sort the commits inside sections by oldest/newest order
|
|
sort_commits = "oldest"
|
|
# limit the number of commits included in the changelog.
|
|
# limit_commits = 42
|
|
|
|
[remote.github]
|
|
owner = "r3t-studios"
|
|
repo = "marathon"
|