ffg 0.1.3

a golang version manager tool
Documentation 
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

# git-cliff ~ configuration file

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



[changelog]

# changelog header

header = """
# Changelog\n
All notable changes to this project will be documented in this file. See [conventional commits](https://www.conventionalcommits.org/) for commit guidelines.\n
"""

# template for the changelog body

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

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") %}
        - **({{commit.scope}})**{% if commit.breaking %} [**breaking**]{% endif %} \

            {{ commit.message|trim }} - ([{{ commit.id | truncate(length=7, end="") }}]($REPO/commit/{{ commit.id }})) - {{ commit.author.name }}
    {%- endfor -%}
    {% raw %}\n{% endraw %}\

    {%- for commit in commits %}
        {%- if commit.scope -%}
        {% else -%}
            - {% if commit.breaking %} [**breaking**]{% endif %}\

                {{ commit.message|trim }} - ([{{ commit.id | truncate(length=7, end="") }}]($REPO/commit/{{ commit.id }})) - {{ commit.author.name }}
        {% endif -%}
    {% endfor -%}
{% endfor %}\n
"""

# template for the changelog footer

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

# remove the leading and trailing whitespace from the templates

trim = true

# postprocessors

postprocessors = [

    { pattern = '\$REPO', replace = "https://github.com/tyrchen/geektime-rust-live-coding" }, # replace repository URL

]



[git]

# parse the commits based on https://www.conventionalcommits.org

conventional_commits = true

# filter out the commits that are not conventional

filter_unconventional = false

# process each line of a commit as an individual commit

split_commits = false

# regex for preprocessing the commit messages

commit_preprocessors = [

    # { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](https://github.com/orhun/git-cliff/issues/${2}))"}, # replace issue numbers

]

# regex for parsing and grouping commits

commit_parsers = [

    { message = "\\[skip", skip = true },

    { message = "\\p{Han}", skip = true },

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

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

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

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

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

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

    { message = "^revert", group = "Revert" },

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

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

    { message = "^chore", group = "Miscellaneous Chores" },

    { message = ".*", group = "Other" },

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

]

# protect breaking changes from being skipped due to matching a skipping commit_parser

protect_breaking_commits = false

# 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 = "v0.1.0-beta.1"

# regex for ignoring tags

ignore_tags = ""

# sort the tags topologically

topo_order = false

# sort the commits inside sections by oldest/newest order

sort_commits = "oldest"

# limit the number of commits included in the changelog.

# limit_commits = 42