-
-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathcliff.toml
More file actions
68 lines (63 loc) · 2.45 KB
/
Copy pathcliff.toml
File metadata and controls
68 lines (63 loc) · 2.45 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
# git-cliff — changelog / release-note generator (https://git-cliff.org).
#
# git-cliff is itself a Rust tool, and a dev/CI utility only — NOT a crate
# dependency. It never appears in `cargo tree -p ordvec`, so it does not affect
# the no-system-deps gate.
#
# Used two ways:
# * .github/workflows/release.yml (the `notes` job) runs `git cliff --latest`
# when a vX.Y.Z tag is pushed, to author that release's GitHub Release notes.
# * Locally, to draft the next CHANGELOG.md section during release prep:
# git cliff --unreleased --tag vX.Y.Z
# Output mirrors the repo's Keep a Changelog 1.1.0 + SemVer layout.
[changelog]
header = """
# Changelog
All notable changes to this project are documented here.
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).
"""
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.scope %}*({{ commit.scope }})* {% endif %}\
{% if commit.breaking %}[**breaking**] {% endif %}\
{{ commit.message | upper_first }}\
{% endfor %}
{% endfor %}\n
"""
footer = ""
trim = true
[git]
conventional_commits = true
filter_unconventional = true
split_commits = false
# Turn "(#NN)" PR references into links in the public release notes.
commit_preprocessors = [
{ pattern = '\(#([0-9]+)\)', replace = "([#${1}](https://github.com/Project-Navi/ordvec/pull/${1}))" },
]
# Conventional Commit type -> Keep a Changelog section. Housekeeping and merge
# commits are dropped so the notes stay user-facing.
commit_parsers = [
{ message = "^feat", group = "Added" },
{ message = "^fix", group = "Fixed" },
{ message = "^perf", group = "Performance" },
{ message = "^refactor", group = "Changed" },
{ message = "^docs", group = "Documentation" },
{ message = "^(chore|ci|test|build|style)", skip = true },
{ message = "^Merge ", skip = true },
{ message = ".*", group = "Changed" },
]
protect_breaking_commits = true
filter_commits = false
# Only exact SemVer release tags count: each segment is either `0` or a
# non-zero-prefixed integer, matching `release.yml`'s strict guard.
tag_pattern = '^v(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)$'
topo_order = false
sort_commits = "newest"