mirror of
https://github.com/danbulant/oxc
synced 2026-05-24 12:21:58 +00:00
68 lines
2.6 KiB
TOML
68 lines
2.6 KiB
TOML
# git-cliff ~ configuration file
|
|
# https://git-cliff.org/docs/configuration
|
|
|
|
[changelog]
|
|
# changelog header
|
|
header = """
|
|
# Changelog\n
|
|
All notable changes to this package will be documented in this file.
|
|
|
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
and this project does not adhere to [Semantic Versioning](https://semver.org/spec/v2.0.0.html) until v1.0.0.\n
|
|
"""
|
|
# template for the changelog body
|
|
# https://keats.github.io/tera/docs/#introduction
|
|
body = """
|
|
{% if version -%}
|
|
## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
|
|
{% else -%}
|
|
## [Unreleased]
|
|
{% endif -%}
|
|
{% for commit in commits | filter(attribute="breaking", value=true) %}
|
|
- **BREAKING** {{ commit.scope }}: {{ commit.message | trim }}
|
|
{% endfor -%}
|
|
{% for group, commits in commits | sort(attribute="group") | group_by(attribute="group") %}
|
|
### {{ group | striptags | trim | upper_first }}
|
|
{% for commit in commits | filter(attribute="breaking", value=false) | filter(attribute="scope") | sort(attribute="scope") %}
|
|
* {{commit.scope}}: {{ commit.message | trim }}
|
|
{%- endfor -%}
|
|
{%- for commit in commits | filter(attribute="breaking", value=false) %}
|
|
{%- if not commit.scope -%}
|
|
- {{ commit.message | trim }} |
|
|
{%- endif -%}
|
|
{%- endfor %}
|
|
{% endfor %}\n
|
|
"""
|
|
# 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 parsing and grouping commits
|
|
commit_parsers = [
|
|
{ message = "^feat", group = "<!-- 0 -->Features" },
|
|
{ message = "^fix", group = "<!-- 1 -->Bug Fixes" },
|
|
{ message = "^perf", group = "<!-- 2 -->Performance" },
|
|
{ message = "^doc", group = "<!-- 3 -->Documentation" },
|
|
{ message = "^refactor", group = "<!-- 4 -->Refactor" },
|
|
{ message = "^style", group = "<!-- 5 -->Styling" },
|
|
{ message = "^test", group = "<!-- 6 -->Testing" },
|
|
]
|
|
# 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 = true
|
|
# sort the tags topologically
|
|
topo_order = false
|
|
# sort the commits inside sections by oldest/newest order
|
|
sort_commits = "newest"
|
|
|
|
# https://git-cliff.org/docs/configuration/bump
|
|
[bump]
|
|
features_always_bump_minor = true
|
|
breaking_always_bump_major = false
|