LaTeX_Template/cliff.toml at main · NathanielJS1541/LaTeX_Template · 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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
# git-cliff ~ configuration file
# https://git-cliff.org/docs/configuration


[changelog]
# A Tera template to be rendered for each release in the changelog.
# See https://keats.github.io/tera/docs/#introduction
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 -%}
            {%- if commit.breaking %}[**breaking**] {% endif -%}
            {{ commit.message | upper_first }}
            {%- if commit.remote.username %} by @{{ commit.remote.username }}{%- endif -%}
            {%- if commit.remote.pr_number %} in #{{ commit.remote.pr_number }}{%- endif %}
    {% endfor %}
{% endfor -%}
{%- if github.contributors | filter(attribute="is_first_time", value=true) -%}
    ### New Contributors

    {% for contributor in github.contributors | filter(attribute="is_first_time", value=true) -%}
        - @{{ contributor.username }} made their first contribution
            {%- if contributor.pr_number %} in #{{ contributor.pr_number }}{%- endif %}
    {% endfor -%}
{%- endif -%}
"""
# Remove leading and trailing whitespaces from the changelog's body.
trim = true
# Render body even when there are no releases to process.
render_always = true
# An array of regex based postprocessors to modify the changelog.
postprocessors = [
    # Replace the placeholder <REPO> with a URL.
    { pattern = '<REPO>', replace = "https://github.com/NathanielJS1541/LaTeX_Template" },
]

[git]
# Parse commits according to the conventional commits specification.
# See https://www.conventionalcommits.org
conventional_commits = true
# Require all commits to be conventional.
# This is required by the lint-commits.yml GitHub Action workflow.
require_conventional = true
# An array of regex based parsers to modify commit messages prior to further processing.
commit_preprocessors = [
    # Replace issue numbers with link templates to be updated in `changelog.postprocessors`.
    { pattern = '#([0-9]+)', replace = "[#${1}](<REPO>/issues/${1})"},
    # Check spelling of the commit message using https://github.com/crate-ci/typos.
    # If the spelling is incorrect, it will be fixed automatically.
    #{ pattern = '.*', replace_command = 'typos --write-changes -' },
]
# Prevent commits that are breaking from being excluded by commit parsers.
protect_breaking_commits = true
# An array of regex based parsers for extracting data from the commit message.
# Assigns commits to groups.
# Optionally sets the commit's scope and can decide to exclude commits from
# further processing.
#
# Note that any changes here should be reflected in the CONTRIBUTING.md
# document.
commit_parsers = [
    { message = "^feat", group = "<!-- 0 -->🚀 Features" },
    { message = "^fix", group = "<!-- 1 -->🐛 Fixes" },
    { message = "^docs", group = "<!-- 2 -->📚 Documentation" },
    { message = "^ci", group = "<!-- 3 -->🛠️ CI/CD" },
    { message = "^style", group = "<!-- 4 -->🎨 Styling" },
    { message = "^chore\\(release\\)", skip = true },
    { message = "^chore", group = "<!-- 5 -->⚙️ Miscellaneous Tasks" },
    { message = "^revert", group = "<!-- 6 -->◀️ Revert" },
    { message = ".*", group = "<!-- 7 -->💼 Other" },
]
# Exclude commits that are not matched by any commit parser.
filter_commits = false
# An array of link parsers for extracting external references, and turning them into URLs, using regex.
link_parsers = []
# Include only the tags that belong to the current branch.
use_branch_tags = false
# Order releases topologically instead of chronologically.
topo_order = false
# Order releases topologically instead of chronologically.
topo_order_commits = true
# Order of commits in each group/release within the changelog.
# Allowed values: newest, oldest
sort_commits = "oldest"
# Process submodules commits
recurse_submodules = false