netlinx.nvim/cliff.toml at master · Norgate-AV/netlinx.nvim · 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
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
141
142
143
144
145
146
147
148
# git-cliff ~ default configuration file
# https://git-cliff.org/docs/configuration
#
# Lines starting with "#" are comments.
# Configuration options are organized into tables and keys.
# See documentation for more information on available options.

[remote.github]
owner = "Norgate-AV"
repo = "netlinx.nvim"

[changelog]
# template for the changelog header
header = """
# Changelog

All notable changes to this project will be documented in this file.
"""
# template for the changelog body
# https://keats.github.io/tera/docs/#introduction
body = """
{%- macro remote_url() -%}
  https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}
{%- endmacro -%}

{%- macro print_commit(commit) -%}
- {% if commit.scope %}*({{ commit.scope }})* {% endif %}\
        {% if commit.breaking %}[**breaking**] {% endif %}\
        {{ commit.message | upper_first }} - \
        ([{{ commit.id | truncate(length=7, end="") }}]({{ self::remote_url() }}/commit/{{ commit.id }}))
{%- endmacro -%}


{% if version %}
    {%- if previous.version %}
## [{{ version | trim_start_matches(pat="v") }}]({{ self::remote_url() }}/compare/{{ previous.version }}..{{ version }}) - {{ timestamp | date(format="%Y-%m-%d") }}
    {%- else %}
## [{{ version | trim_start_matches(pat="v") }}]({{ self::remote_url() }}/tree/{{ version }}) - {{ timestamp | date(format="%Y-%m-%d") }}
    {%- endif -%}
{% endif -%}

{%- if previous.version -%}
    {%- for group, commits in commits | group_by(attribute="group") %}

### {{ group | striptags | trim | upper_first }}
        {%- for commit in commits | filter(attribute="scope") | sort(attribute="scope") %}

{{ self::print_commit(commit=commit) }}
        {%- endfor -%}
        {%- for commit in commits %}
            {%- if not commit.scope %}

{{ self::print_commit(commit=commit) }}
            {%- endif -%}
        {%- endfor -%}
    {%- endfor %}
{% else %}

### 🎉🎉 Initial Release

First release of netlinx.nvim.
{%- endif %}

{%- if github %}
    {%- set excluded_users = ["Norgate-AV", "damienbutt", "actions-user", "github-actions", "github-actions[bot]"] %}
    {%- set first_time_contributors = [] %}
    {%- for contributor in github.contributors %}
        {%- if contributor.is_first_time %}
            {%- if contributor.username not in excluded_users %}
                {%- set first_time_contributors = first_time_contributors | concat(with=[contributor]) %}
            {%- endif %}
        {%- endif %}
    {%- endfor %}
    {%- if first_time_contributors | length != 0 %}

## New Contributors ❤️
        {%- for contributor in first_time_contributors %}
* @{{ contributor.username }} made their first contribution
            {%- if contributor.pr_number %} in [#{{ contributor.pr_number }}]({{ self::remote_url() }}/pull/{{ contributor.pr_number }})
            {%- endif %}
        {%- endfor %}
    {%- endif %}
{%- endif %}
"""
# template for the changelog footer
footer = """
"""
# remove the leading and trailing s
trim = true
# postprocessors
postprocessors = [
    { pattern = '<REPO>', replace = "https://github.com/Norgate-AV/netlinx.nvim" }, # replace repository URL
]
# render body even when there are no releases to process
# render_always = true
# output file path
# output = "CHANGELOG.md"

[git]
# parse the commits based on https://www.conventionalcommits.org
conventional_commits = true
# filter out the commits that are not conventional
filter_unconventional = true
# process each line of a commit as an individual commit
split_commits = false
# regex for preprocessing the commit messages
commit_preprocessors = [
    # Replace issue numbers
    { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/issues/${2}))" },
    # Check spelling of the commit with https://github.com/crate-ci/typos
    # If the spelling is incorrect, it will be automatically fixed.
    { pattern = '.*', replace_command = 'typos --write-changes -' },
]
# regex for parsing and grouping commits
commit_parsers = [
    { message = "^feat", group = "<!-- 0 -->🚀 Features" },
    { message = "^fix", group = "<!-- 1 -->🐛 Bug Fixes" },
    { message = "^doc", group = "<!-- 3 -->📚 Documentation", skip = true },
    { message = "^perf", group = "<!-- 4 -->⚡ Performance" },
    { message = "^refactor", group = "<!-- 2 -->🚜 Refactor", skip = true },
    { message = "^style", group = "<!-- 5 -->🎨 Styling", skip = true },
    { message = "^test", group = "<!-- 6 -->🧪 Testing", skip = true },
    { message = "^chore\\(release\\): prepare for", skip = true },
    { message = "^chore\\(deps.*\\)", skip = true },
    { message = "^chore\\(pr\\)", skip = true },
    { message = "^chore\\(pull\\)", skip = true },
    { message = "^chore|^ci", group = "<!-- 7 -->⚙️ Miscellaneous Tasks", skip = true },
    { body = ".*security", group = "<!-- 8 -->🛡️ Security", skip = true },
    { message = "^revert", group = "<!-- 9 -->◀️ Revert", skip = true },
    { message = ".*", group = "<!-- 10 -->💼 Other", skip = true },
]
# protect breaking changes from being skipped due to matching a skipping commit_parser
protect_breaking_commits = true
# filter out the commits that are not matched by commit parsers
filter_commits = false
# regex for matching git tags
tag_pattern = "v?[0-9].*"
# regex for skipping tags
skip_tags = "beta|alpha"
# sort the tags topologically
topo_order = false
# sort the commits inside sections by oldest/newest order
sort_commits = "newest"

[bump]
features_always_bump_minor = true
breaking_always_bump_major = true
initial_tag = "0.1.0"