mirror of
https://github.com/torrentpier/torrentpier.git
synced 2025-01-23 19:32:53 -08:00
127 lines
4.9 KiB
TOML
127 lines
4.9 KiB
TOML
# git-cliff ~ TorrentPier configuration file
|
|
# https://git-cliff.org/docs/configuration
|
|
#
|
|
# Lines starting with "#" are comments.
|
|
# Configuration options are organized into tables and keys.
|
|
# See documentation for more information on available options.
|
|
|
|
[remote.github]
|
|
owner = "torrentpier"
|
|
repo = "torrentpier"
|
|
|
|
[changelog]
|
|
# template for the changelog header
|
|
header = """
|
|
# 📖 Change Log\n
|
|
> [!NOTE]
|
|
> To view changelog from **v2.0.0** to **v2.4.5-rc.2** navigate to [HISTORY.md](HISTORY.md).
|
|
"""
|
|
# template for the changelog body
|
|
# https://keats.github.io/tera/docs/#introduction
|
|
body = """
|
|
{%- macro remote_url() -%}
|
|
https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}
|
|
{%- endmacro -%}
|
|
|
|
{%- macro nightly_url() -%}
|
|
https://nightly.link/{{ remote.github.owner }}/{{ remote.github.repo }}/workflows/build/master/TorrentPier
|
|
{%- endmacro -%}
|
|
|
|
{% macro print_commit(commit) -%}
|
|
- {% if commit.scope %}*({{ commit.scope }})* {% endif %}\
|
|
{% if commit.breaking %}[**breaking**] {% endif %}\
|
|
{{ commit.message | upper_first }} - \
|
|
([{{ commit.id | truncate(length=7, end="") }}]({{ self::remote_url() }}/commit/{{ commit.id }}))\
|
|
{% endmacro -%}
|
|
|
|
{% if version %}\
|
|
{% if previous.version %}\
|
|
## [{{ version }}]\
|
|
({{ self::remote_url() }}/compare/{{ previous.version }}..{{ version }}) ({{ timestamp | date(format="%Y-%m-%d") }})
|
|
{% else %}\
|
|
## {{ version }} ({{ timestamp | date(format="%Y-%m-%d") }})
|
|
{% endif %}\
|
|
{% else %}\
|
|
## [nightly]({{ self::nightly_url() }})
|
|
{% endif %}\
|
|
|
|
{% for group, commits in commits | group_by(attribute="group") %}
|
|
### {{ group | striptags | trim | upper_first }}
|
|
{% for commit in commits
|
|
| filter(attribute="scope")
|
|
| sort(attribute="scope") %}
|
|
{{ self::print_commit(commit=commit) }}
|
|
{%- endfor %}
|
|
{% for commit in commits %}
|
|
{%- if not commit.scope -%}
|
|
{{ self::print_commit(commit=commit) }}
|
|
{% endif -%}
|
|
{% endfor -%}
|
|
{% endfor -%}
|
|
{%- if github -%}
|
|
{% if github.contributors | filter(attribute="is_first_time", value=true) | length != 0 %}
|
|
## New Contributors ❤️
|
|
{% endif %}\
|
|
{% for contributor in github.contributors | filter(attribute="is_first_time", value=true) %}
|
|
* [@{{ contributor.username }}](https://github.com/{{ contributor.username }}) made their first contribution
|
|
{%- if contributor.pr_number %} in \
|
|
[#{{ contributor.pr_number }}]({{ self::remote_url() }}/pull/{{ contributor.pr_number }}) \
|
|
{%- endif %}
|
|
{%- endfor -%}
|
|
{%- endif %}
|
|
"""
|
|
# template for the changelog footer
|
|
footer = """
|
|
<!-- generated by git-cliff -->
|
|
"""
|
|
# remove the leading and trailing whitespace from the templates
|
|
trim = true
|
|
# postprocessors
|
|
postprocessors = [
|
|
{ pattern = '<REPO>', replace = "https://github.com/torrentpier/torrentpier" }, # replace repository URL
|
|
]
|
|
|
|
[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 = [
|
|
# Replace issue numbers
|
|
{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/pull/${2}))" },
|
|
# Check spelling of the commit with https://github.com/crate-ci/typos
|
|
# If the spelling is incorrect, it will be automatically fixed.
|
|
# { pattern = '.*', replace_command = 'typos --write-changes -' },
|
|
]
|
|
# regex for parsing and grouping commits
|
|
commit_parsers = [
|
|
{ message = "^feat", group = "<!-- 0 -->🚀 Features" },
|
|
{ message = "^fix", group = "<!-- 1 -->🐛 Bug Fixes" },
|
|
{ message = "^doc", group = "<!-- 3 -->📚 Documentation" },
|
|
{ message = "^perf", group = "<!-- 4 -->⚡ Performance" },
|
|
{ message = "^refactor", group = "<!-- 2 -->🚜 Refactor" },
|
|
{ message = "^style", group = "<!-- 5 -->🎨 Styling" },
|
|
{ message = "^test", group = "<!-- 6 -->🧪 Testing" },
|
|
{ message = "^ignore|^release", skip = true },
|
|
{ message = "^chore|^ci|^misc", group = "<!-- 7 -->⚙️ Miscellaneous" },
|
|
{ body = ".*security", group = "<!-- 8 -->🛡️ Security" },
|
|
{ message = "^revert", group = "<!-- 9 -->◀️ Revert" },
|
|
{ message = "^crowdin", group = "<!-- 10 -->🈳 New translations" }, # crowdin pulls supporting
|
|
{ message = "^Composer", group = "<!-- 11 -->📦 Dependencies" }, # dependabot pulls supporting
|
|
{ message = "^rem|^drop|^removed", group = "<!-- 12 -->🗑️ Removed" },
|
|
{ message = ".*", group = "<!-- 13 -->💼 Other" },
|
|
]
|
|
# 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].*"
|
|
# sort the tags topologically
|
|
topo_order = false
|
|
# sort the commits inside sections by oldest/newest order
|
|
sort_commits = "newest"
|