spritz/release-plz.toml at main · dfallman/spritz · GitHub

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
[workspace]
# Binary app — none of the crates go to crates.io.
publish = false
# Skip cargo-semver-checks; relevant only for public library APIs.
semver_check = false
# Annotated tag per release (release-plz creates annotated tags by default).
git_tag_name = "v{{ version }}"
# release-plz creates an empty GitHub Release (body = changelog) on release;
# the release.yml workflow then attaches cross-compiled binaries to it via
# `gh release upload`. Keeping this true so release-plz is the single source
# of truth for "is this released".
git_release_enable = true
git_release_body = """{{ changelog }}"""
# Title of the release PR.
pr_name = "chore(release): update version to {{ version }}"
pr_labels = ["release"]
changelog_update = true
changelog_path = "./CHANGELOG.md"

# Unified workspace versioning: all four crates bump to the same X.Y.Z,
# but only one (`cli`, the user-facing binary) gets a git tag and GitHub
# Release. Without this, every crate tries to create the same tag name
# and the second one hits a 422 "Reference already exists".
[[package]]
name = "spritz-core"
git_tag_enable = false
git_release_enable = false

[[package]]
name = "api"
git_tag_enable = false
git_release_enable = false

[[package]]
name = "dlna"
git_tag_enable = false
git_release_enable = false

[changelog]
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.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
"""

body = """
## [{{ version }}] - {{ timestamp | date(format="%Y-%m-%d") }}
{% for group, commits in commits | group_by(attribute="group") %}
### {{ group | upper_first }}
{% for commit in commits %}
- {{ commit.message | split(pat="\\n") | first | trim | upper_first }}{% if commit.breaking %} **[BREAKING]**{% endif %}
{%- endfor %}
{% endfor %}
"""

# Map Conventional Commit types to changelog sections.
commit_parsers = [
    { message = "^feat", group = "Added" },
    { message = "^fix", group = "Fixed" },
    { message = "^perf", group = "Performance" },
    { message = "^refactor", group = "Changed" },
    { message = "^docs", group = "Documentation" },
    { message = "^style", skip = true },
    { message = "^test", skip = true },
    { message = "^chore\\(release\\)", skip = true },
    { message = "^chore", skip = true },
    { message = "^ci", skip = true },
    { message = "^build", skip = true },
    { message = "^revert", group = "Reverted" },
]

# Commits that don't match any of the parsers above are silently dropped
# from the changelog (release-plz default behavior — no opt-in flag needed).
protect_breaking_commits = true
sort_commits = "newest"