Repository navigation
Expand file tree
/
Copy pathcliff.toml
More file actions
140 lines (123 loc) · 5.55 KB
/
Copy pathcliff.toml
File metadata and controls
140 lines (123 loc) · 5.55 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
# git-cliff ~ configuration file
# https://git-cliff.org/docs/configuration
#
# Generates CHANGELOG.md from conventional-commit history.
# Triggered by .github/workflows/changelog.yml on `push: tags: v*`.
#
# Sections follow Keep-A-Changelog 1.1.0:
# https://keepachangelog.com/en/1.1.0/
#
# A commit's scope (the part in parentheses, e.g. `refactor(quantize): ...`)
# is preserved on the changelog entry; the leading typeword (`refactor`)
# decides which section the entry lands in.
[changelog]
# Marker line that lets `--prepend` replace just the [Unreleased] body.
header_marker = "<!-- git-cliff: end of header -->"
# Header: descriptive prose at the top of CHANGELOG.md. The marker line
# above marks the *end* of the manually-edited header so that
# `git-cliff --prepend` does not stomp on it.
header = """
# Changelog
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.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
This file is **auto-generated** by [git-cliff](https://git-cliff.org) from the
conventional-commit history at every `v*` tag push. See
[.github/workflows/changelog.yml](.github/workflows/changelog.yml) for the
generator and [cliff.toml](cliff.toml) for the section/commit-type mapping.
Hand-edit only the lines **above** the `<!-- git-cliff: end of header -->`
marker; everything below is regenerated.
<!-- git-cliff: end of header -->
"""
# Body template. One release section per git tag, with Keep-A-Changelog
# subsections extracted from commit groups defined in [git] below.
body = """
{% if version %}\
## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
{% else %}\
## [Unreleased]
{% endif %}\
{% for entry in commits | commit_groups(groups=commit_parsers_groups) %}
### {{ entry.group | striptags | trim | upper_first }}
{% for commit in entry.commits -%}
- {% if commit.scope %}*({{ commit.scope }})* {% endif -%}
{% if commit.breaking %}[**breaking**] {% endif -%}
{{ commit.message | split(pat="\n") | first | trim | upper_first }}
{% endfor %}\
{% endfor %}
"""
# Footer: release-comparison URL link section. Stays identical across
# regenerations because it references the same GitHub origin.
footer = """
<!-- git-cliff: end of body -->
## Release link table
<!-- Auto-managed; compare links for each shipped version. New rows
must be added by hand when a new tag ships, since git-cliff does
not derive a comparison base URL automatically. -->
[Unreleased]: https://github.com/espetro/dinov2.cpp/compare/v0.5.0...HEAD
[0.5.0]: https://github.com/espetro/dinov2.cpp/compare/v0.4.0...v0.5.0
[0.4.0]: https://github.com/espetro/dinov2.cpp/compare/v0.3.0...v0.4.0
"""
trim = true
render_always = true
postprocessors = []
[git]
conventional_commits = true
# Many commits in this repo (especially the upstream-forked history
# before the conventional-commits editorial switch) are *not* conventional.
# Group them as "Miscellaneous" via the catch-all commit_parser at the
# bottom rather than dropping them; this preserves the v0.1.0..v0.2.0
# history needed for an end-to-end backfill.
filter_unconventional = false
require_conventional = false
split_commits = false
commit_preprocessors = []
protect_breaking_commits = false
# Order of commit parsers matters: first match wins.
# Skip automated/meta commits; group conventional types; everything else
# falls into "Miscellaneous" so it is never lost.
commit_parsers = [
# Skip human/release-engineering meta commits
{ message = "^chore\\(release\\): prepare for", skip = true },
{ message = "^chore\\(pr\\)", skip = true },
{ message = "^chore\\(pull\\)", skip = true },
# Skip lockfile/CI-only deps bumps (still recorded by hand in CHANGELOG
# when the bump is a headline change, but auto-derived entries add noise)
{ message = "^chore\\(deps.*\\)", skip = true },
# Conventional commit type -> Keep-A-Changelog subsection.
# git-cliff matches the longest group title for ordering; identical
# group titles collapse into a single section. So all the commit
# types that should land in the "Changed" subsection do so with the
# exact same group string.
{ message = "^feat", group = "Added" },
{ message = "^fix", group = "Fixed" },
{ message = "^perf", group = "Changed" },
{ message = "^refactor", group = "Changed" },
{ message = "^bench", group = "Changed" },
{ message = "^ci", group = "Changed" },
{ message = "^docs?(?P<scope>\\([0-9A-Za-z_-]+\\))?", group = "Changed" },
{ message = "^test", group = "Changed" },
{ message = "^style", group = "Changed" },
{ message = "^chore", group = "Changed" },
# Deprecations are surfaced as their own subsection (Keep-A-Changelog
# supports it; rarely used by this repo so far).
{ message = "^deprecate", group = "Deprecated" },
# Security advisories would land here if any future commit has a
# `^security` prefix or a body containing "CVE-...".
{ message = ".*security", group = "Security" },
# Reverts of public-API behavior changes.
{ message = "^revert", group = "Changed" },
# Catch-all for non-conventional commits (e.g. pre-fork history where
# the message is plain prose). Land in "Miscellaneous" so they show up
# in the changelog instead of being silently dropped.
{ message = "^Initial commit", group = "Miscellaneous" },
{ message = ".*", group = "Miscellaneous" },
]
filter_commits = false
fail_on_unmatched_commit = false
link_parsers = []
use_branch_tags = false
topo_order = false
topo_order_commits = true
sort_commits = "oldest"
recurse_submodules = false