mirror of https://github.com/yupix/mipac
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
93 lines
3.4 KiB
93 lines
3.4 KiB
# git-cliff ~ configuration file
|
|
# https://git-cliff.org/docs/configuration
|
|
|
|
[remote.github]
|
|
owner = "yupix"
|
|
repo = "MiPAC"
|
|
|
|
[changelog]
|
|
# changelog header
|
|
header = """
|
|
# Changelog\n
|
|
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.0.0/),
|
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\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 group, commits in commits | group_by(attribute="group") %}
|
|
### {{ group | upper_first }}
|
|
{% for commit in commits %}
|
|
- {% if commit.breaking %}[**breaking**] {% endif %}\
|
|
{{ commit.message | upper_first }} ([{{ commit.id | truncate(length=7, end="") }}](https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}/commit/{{ commit.id }}))\
|
|
{% endfor %}
|
|
{% endfor %}\n
|
|
"""
|
|
# template for the changelog footer
|
|
footer = """
|
|
{% for release in releases -%}
|
|
{% if release.version -%}
|
|
{% if release.previous.version -%}
|
|
[{{ release.version | trim_start_matches(pat="v") }}]: \
|
|
https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}\
|
|
/compare/{{ release.previous.version }}..{{ release.version }}
|
|
{% endif -%}
|
|
{% else -%}
|
|
[unreleased]: https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}\
|
|
/compare/{{ release.previous.version }}..HEAD
|
|
{% endif -%}
|
|
{% endfor %}
|
|
<!-- 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 parsing and grouping commits
|
|
commit_parsers = [
|
|
{ message = "^feat", group = "<!-- 0 -->🚀 Features" },
|
|
{ message = "^fix", group = "<!-- 1 -->🐛 Bug Fixes" },
|
|
{ message = "^doc|chore\\(docs\\)", group = "<!-- 3 -->📚 Documentation" },
|
|
{ message = "^perf", group = "<!-- 4 -->⚡ Performance" },
|
|
{ message = "^refactor", group = "<!-- 2 -->🚜 Refactor" },
|
|
{ message = "^style", group = "<!-- 5 -->🎨 Styling" },
|
|
{ message = "^test", group = "<!-- 6 -->🧪 Testing" },
|
|
{ message = "^chore\\(release\\): prepare for", 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 = true
|
|
# regex for matching git tags
|
|
tag_pattern = "[0-9].*"
|
|
# regex for skipping tags
|
|
skip_tags = "v0.1.0-beta.1"
|
|
# 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"
|
|
|
|
[bump]
|
|
breaking_always_bump_major = false
|