mirror of
https://github.com/FoxxMD/multi-scrobbler.git
synced 2026-05-21 02:20:26 +00:00
80d6879d2a
* Add as dev dependency with npm script so it can be run anywhere project is installed * Update config with newer template based on scopesorted * Add more scopes and give them pretty emojis
80 lines
3 KiB
TOML
80 lines
3 KiB
TOML
# git-cliff ~ configuration file
|
|
# https://git-cliff.org/docs/configuration
|
|
|
|
[changelog]
|
|
# A Tera template to be rendered as the changelog's header.
|
|
# See https://keats.github.io/tera/docs/#introduction
|
|
header = """
|
|
# Changelog\n
|
|
All notable changes to this project will be documented in this file.\n
|
|
"""
|
|
# A Tera template to be rendered for each release in the changelog.
|
|
# See 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 group, commits in commits | group_by(attribute="group") %}
|
|
### {{ group | upper_first }}
|
|
{% for commit in commits
|
|
| filter(attribute="scope")
|
|
| sort(attribute="scope") %}
|
|
- *({{commit.scope}})* {{ commit.message | upper_first }}
|
|
{%- if commit.breaking %}
|
|
{% raw %} {% endraw %}- **BREAKING**: {{commit.breaking_description}}
|
|
{%- endif -%}
|
|
{%- endfor -%}
|
|
{% raw %}\n{% endraw %}\
|
|
{%- for commit in commits %}
|
|
{%- if commit.scope -%}
|
|
{% else -%}
|
|
- *(No Category)* {{ commit.message | upper_first }}
|
|
{% if commit.breaking -%}
|
|
{% raw %} {% endraw %}- **BREAKING**: {{commit.breaking_description}}
|
|
{% endif -%}
|
|
{% endif -%}
|
|
{% endfor -%}
|
|
{% raw %}\n{% endraw %}\
|
|
{% endfor %}\n
|
|
"""
|
|
# A Tera template to be rendered as the changelog's footer.
|
|
# See https://keats.github.io/tera/docs/#introduction
|
|
footer = """
|
|
<!-- generated by git-cliff -->
|
|
"""
|
|
# Remove leading and trailing whitespaces from the changelog's body.
|
|
trim = true
|
|
|
|
[git]
|
|
# Parse commits according to the conventional commits specification.
|
|
# See https://www.conventionalcommits.org
|
|
conventional_commits = true
|
|
# Exclude commits that do not match the conventional commits specification.
|
|
filter_unconventional = true
|
|
# An array of regex based parsers for extracting data from the commit message.
|
|
# Assigns commits to groups.
|
|
# Optionally sets the commit's scope and can decide to exclude commits from further processing.
|
|
commit_parsers = [
|
|
{ message = "^feat", group = "⛰️ Features" },
|
|
{ message = "^fix", group = "🐛 Bug Fixes" },
|
|
{ message = "^doc", group = "📚 Documentation" },
|
|
{ message = "^perf", group = "⚡ Performance" },
|
|
{ message = "^refactor", group = "🚜 Refactor" },
|
|
{ message = "^style", group = "💅 Styling" },
|
|
{ message = "^test", group = "🧪 Testing" },
|
|
{ message = "^ci", group = "🧑🍳 Continuous Integration" },
|
|
{ message = "^build", group = "🐋 Build" },
|
|
{ message = "^chore\\(release\\)", skip = true },
|
|
{ message = "^chore", group = "⚙️ Miscellaneous Tasks" },
|
|
{ body = ".*security", group = "🛡️ Security" },
|
|
]
|
|
# Exclude commits that are not matched by any commit parser.
|
|
filter_commits = false
|
|
# Order releases topologically instead of chronologically.
|
|
topo_order = false
|
|
# Order of commits in each group/release within the changelog.
|
|
# Allowed values: newest, oldest
|
|
sort_commits = "oldest"
|
|
|