markdown-inline-editor-vscode/cliff.toml at main · appsoftwareltd/markdown-inline-editor-vscode · 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

[remote.github]
owner = "SeardnaSchmid"
repo = "markdown-inline-editor-vscode"

[changelog]
# A Tera template to be rendered as the changelog's footer.
# See https://keats.github.io/tera/docs/#introduction
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).
"""
# A Tera template to be rendered for each release in the changelog.
# See https://keats.github.io/tera/docs/#introduction
# Format follows Keep a Changelog: https://keepachangelog.com/en/1.0.0/
body = """

{% if version %}\
    {% if previous.version %}\
        ## [{{ version | trim_start_matches(pat="v") }}]($REPO/compare/{{ previous.version }}..{{ version }}) - {{ timestamp | date(format="%Y-%m-%d") }}
    {% else %}\
        ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
    {% endif %}\
{% else %}\
    ## [Unreleased]
{% endif %}\
{% for group, commits in commits | group_by(attribute="group") %}
    ### {{ group | striptags | trim | upper_first }}
    {% for commit in commits
    | filter(attribute="scope")
    | sort(attribute="scope") %}
        - {% if commit.scope %}**({{commit.scope}})** {% endif %}{% if commit.breaking %}[**breaking**] {% endif %}\
            {{ commit.message }}{% if commit.id %} - ([{{ commit.id | truncate(length=7, end="") }}]($REPO/commit/{{ commit.id }})){% endif %}
    {%- endfor -%}
    {% raw %}\n{% endraw %}\
    {%- for commit in commits %}
        {%- if not commit.scope -%}
            - {% if commit.breaking %}[**breaking**] {% endif %}\
                {{ commit.message }}{% if commit.id %} - ([{{ commit.id | truncate(length=7, end="") }}]($REPO/commit/{{ commit.id }})){% endif %}
        {% endif -%}
    {% endfor -%}
{% endfor %}
"""

# Remove leading and trailing whitespaces from the changelog's body.
trim = true
postprocessors = [
    # Replace the placeholder `<REPO>` with a URL.
    { pattern = '\$REPO', replace = "https://github.com/SeardnaSchmid/markdown-inline-editor-vscode" }, # replace repository URL
    { pattern = '\$GH', replace = "https://github.com" },                                               # replace repository URL
]


[git]
# Parse commits according to the conventional commits specification.
# See https://www.conventionalcommits.org
conventional_commits = true
# Exclude commits that do not match the conventional commits specification.
filter_unconventional = true
# Split commits on newlines, treating each line as an individual commit.
split_commits = false
# 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 = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](https://github.com/SeardnaSchmid/markdown-inline-editor-vscode/issues/${2}))" },
]
# An array of regex based parsers for extracting data from the commit message.
# Assigns commits to groups following Keep a Changelog format:
# Added, Changed, Fixed, Removed, Deprecated, Security
commit_parsers = [
    { message = "^feat", group = "Added" },
    { message = "^fix", group = "Fixed" },
    { message = "^docs?", group = "Changed" },
    { message = "^perf", group = "Changed" },
    { message = "^refactor", group = "Changed" },
    { message = "^style", group = "Changed" },
    { message = "^revert", group = "Changed" },
    { message = "^test", group = "Changed" },
    { message = "^chore\\(release\\)", skip = true },
    { message = "^chore", group = "Changed" },
]
# Exclude commits that are not matched by any commit parser.
filter_commits = false
# Order releases topologically instead of chronologically.
topo_order = false
# Order of commits in each group/release within the changelog.
# Allowed values: newest, oldest
sort_commits = "oldest"