flavorcli 1.0.1

A command line interface to interact with FlavorTown
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

# git-cliff ~ configuration file

# https://git-cliff.org/docs/configuration



[changelog]

# A Tera template to be rendered as the changelog's header.

# See https://keats.github.io/tera/docs/#introduction

header = """
# Changelog\n
All notable changes to this project will be documented in this file.\n
"""

# 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 %}\

{% if previous %}\

    {% if previous.commit_id and commit_id %}
        [{{ previous.commit_id | truncate(length=7, end="") }}]({{ previous.commit_id }})...\

            [{{ commit_id | truncate(length=7, end="") }}]({{ commit_id }})
    {% endif %}\

{% endif %}\

{% for group, commits in commits | group_by(attribute="group") %}
    ### {{ group | upper_first }}
    {% for commit in commits %}
        - {{ commit.message | split(pat="\n") | first | upper_first | trim }} ([{{ commit.id | truncate(length=7, end="") }}]({{ commit.id }}))\

          {% if commit.footers %}\

            {% for footer in commit.footers -%}
                , {{ footer.token }}{{ footer.separator }}{{ footer.value }}\

            {% endfor %}\

          {% endif %}\

    {% endfor %}
{% endfor %}\n
"""

# A Tera template to be rendered as the changelog's footer.

# See https://keats.github.io/tera/docs/#introduction

footer = """
<!-- generated by git-cliff -->
"""

# Remove leading and trailing whitespaces from the changelog's body.

trim = true



[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 = false

# 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.

commit_parsers = [

    { message = "^feat", group = "Features" },

    { message = "^fix", group = "Bug Fixes" },

    { message = "^doc", group = "Documentation" },

    { message = "^perf", group = "Performance" },

    { message = "^refactor", group = "Refactor" },

    { message = "^style", group = "Styling" },

    { message = "^test", group = "Testing" },

    { message = "^chore\\(deps.*\\)", skip = true },

    { message = "^chore\\(pr\\)", skip = true },

    { message = "^chore\\(pull\\)", skip = true },

    { message = "^chore\\(release\\)", skip = true },

    { message = "^chore|^ci", group = "Miscellaneous Tasks" },

    { body = ".*security", group = "Security" },

]

# 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"