cargo-upkeep 0.3.2

Unified Rust project maintenance CLI (cargo subcommand)
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

[changelog]
header = """
# Changelog

All notable changes to this project will be documented in this file.

"""
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 | striptags | trim | upper_first }}
    {% for commit in commits %}
        - {% if commit.scope %}**{{ commit.scope }}:** {% endif %}\
            {{ commit.message | upper_first }}{% if commit.remote.pr_number %} \
            ([#{{ commit.remote.pr_number }}](https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}/pull/{{ commit.remote.pr_number }})){% endif %}\
    {% endfor %}
{% endfor %}
"""
footer = ""
trim = true

[git]
conventional_commits = true
filter_unconventional = true
split_commits = false
commit_parsers = [
    # Types that change the published artifact, so each one cuts a release.
    { message = "^feat", group = "Features" },
    { message = "^fix", group = "Bug Fixes" },
    { message = "^perf", group = "Performance" },
    { message = "^refactor", group = "Refactoring" },
    { message = "^revert", group = "Bug Fixes" },
    { message = "^build", group = "Miscellaneous" },

    # Types that cannot change what a consumer downloads. Skipped so they never
    # trigger a crates.io release. Note git-cliff's `skip` also drops them from the
    # changelog. These must sit ABOVE the body-matching rules below, or a commit that
    # merely mentions security in its body would be rescued into a release.
    { message = "^doc", skip = true },
    { message = "^style", skip = true },
    { message = "^test", skip = true },
    { message = "^ci", skip = true },
    { message = "^chore\\(release\\)", skip = true },

    # Routine dependency bumps are noise, but a security-relevant one must still
    # surface and still release. Scoped to chore(deps) so it cannot rescue anything
    # skipped above.
    { message = "^chore\\(deps\\)", body = "(?i)(rustsec|advisor|vulnerab|security)", group = "Security" },
    { message = "^chore\\(deps\\)", skip = true },

    { message = "^chore", group = "Miscellaneous" },
]
protect_breaking_commits = false
filter_commits = false
tag_pattern = "v[0-9].*"
topo_order = false
sort_commits = "oldest"

[bump]
# On 0.x cargo already treats a minor bump as breaking, so mapping BREAKING CHANGE
# to minor is correct rather than a fudge. `just bump-auto` additionally caps the
# result at minor, so a major bump is never produced automatically.
features_always_bump_minor = true
breaking_always_bump_major = false