mirror of
https://github.com/rosenpass/rosenpass.git
synced 2026-02-28 14:33:37 -08:00
96 lines
4.0 KiB
TOML
96 lines
4.0 KiB
TOML
|
||
|
||
# https://git-cliff.org/docs/configuration
|
||
|
||
[changelog]
|
||
# template for the changelog header
|
||
header = """
|
||
---
|
||
title: ""
|
||
linkTitle: "Changelog"
|
||
weight: 5
|
||
menu: false
|
||
type: docs
|
||
---
|
||
|
||
<script src="https://cdn.jsdelivr.net/npm/jquery@3.5.1/dist/jquery.slim.min.js" integrity="sha384-DfXdz2htPH0lsSSs5nCTpuj/zy4C+OGpamoFVy38MVBnE+IbbVYUew+OrCXaRkfj" crossorigin="anonymous"></script>
|
||
<script src="https://cdn.jsdelivr.net/npm/bootstrap@4.6.2/dist/js/bootstrap.bundle.min.js" integrity="sha384-Fy6S3B9q64WdZWQUiU+q4/2Lc9npb8tCaSX9FK7E8HnRr0Jz8D6OP9dO5Vg3Q9ct" crossorigin="anonymous"></script>
|
||
|
||
"""
|
||
# template for the changelog body
|
||
# https://keats.github.io/tera/docs/#introduction
|
||
body = """
|
||
{% if version %}\
|
||
<div class="changelog-container card card-body">
|
||
<div class="h3 changelog-release">{{ version | trim_start_matches(pat="v") }} <span class="">{{ timestamp | date(format="%Y-%m-%d") }}<span> - <a href="{{ commit_id}}" class="">{{ commit_id | truncate(length=7, end="") }}</a></div>\
|
||
{% else %}\
|
||
<div class="changelog-container card card-body">
|
||
<div class="h3 changelog-release">unreleased/untagged</div>
|
||
{% endif %}\
|
||
|
||
{% for group, commits in commits | group_by(attribute="group") %}
|
||
<p>
|
||
<button class="btn btn-primary changelog" type="button" data-toggle="collapse" data-target="#{{ group | reverse| truncate(length=5, end="") }}{{ timestamp }}" aria-expanded="false" aria-controls="{{ group | reverse | truncate(length=5, end="") }}{{ timestamp }}">
|
||
<div class="h4"> {{ group | upper_first }} <i class="fa-solid fa-sort-down"></i></div>
|
||
</button>
|
||
</p>
|
||
<div class="collapse changelog" id="{{ group | reverse | truncate(length=5, end="") }}{{ timestamp }}">
|
||
<div class="card card-body">
|
||
{% for commit in commits %}
|
||
<div class="changelog-commit"> - <a href="https://github.com/rosenpass/rosenpass/commit/{{ commit.id }}">{{ commit.id | truncate(length=7, end="") }}</a> {{ commit.message | upper_first }}</div>
|
||
{% endfor %}\
|
||
</div>
|
||
</div>
|
||
{% endfor %}\n
|
||
</div>
|
||
"""
|
||
# 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 parsing and grouping commits
|
||
commit_parsers = [
|
||
{ message = "Release rosenpass version", group = "<!-- 0 -->📝 Release" },
|
||
{ message = "^feat", group = "<!-- 0 -->🚀 Features" },
|
||
{ message = "^fix", group = "<!-- 1 -->🐛 Bug Fixes" },
|
||
{ message = "^doc|Documentation|Doc", group = "<!-- 3 -->📚 Documentation" },
|
||
{ message = "^perf", group = "<!-- 4 -->⚡ Performance" },
|
||
{ message = "^refactor", group = "<!-- 2 -->🚜 Refactor" },
|
||
{ message = "^style", group = "<!-- 5 -->🎨 Styling" },
|
||
{ message = "^test", group = "<!-- 6 -->🧪 Testing" },
|
||
{ field = "author.name", pattern = "dependabot", skip = true },
|
||
{ message = "^chore\\(release\\): prepare for", skip = true },
|
||
{ message = "^chore\\(deps.*\\)", skip = true },
|
||
{ message = "^chore\\(pr\\)", skip = true },
|
||
{ message = "^chore\\(pull\\)", skip = true },
|
||
{ body = ".*security", group = "<!-- 7 -->🛡️ Security" },
|
||
{ message = "^revert", group = "<!-- 8 -->◀️ Revert" },
|
||
# Catch-all for uncategorized commits
|
||
{ message = ".*", group = "<!-- 9 -->📦 Miscellaneous Tasks" },
|
||
]
|
||
# 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 = "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 = "newest"
|
||
|