aide 0.15.1

A code-first API documentation library
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

# configuration file for git-cliff (0.1.0)

[changelog]
header = """
# Changelog\n
"""
# template for the changelog body
# https://tera.netlify.app/docs/#introduction
body = """
{% if version %}\
    ## {{ version | trim_start_matches(pat="release-aide-") }} - {{ timestamp | date(format="%Y-%m-%d") }}
{% else %}\
    ## unreleased
{% endif %}\
{% if previous %}\
    {% if previous.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 | upper_first }} ([{{ commit.id | truncate(length=7, end="") }}]({{ commit.id }}))\
          {% for footer in commit.footers -%}
            , {{ footer.token }}{{ footer.separator }}{{ footer.value }}\
          {% endfor %}\
    {% endfor %}
{% endfor %}\n
"""
# remove the leading and trailing whitespace from the template
trim = true
# changelog footer
footer = """
<!-- generated by git-cliff -->
"""

[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 = [
    { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](https://github.com/tamasfe/aide/issues/${2}))" },
]
# regex for parsing and grouping commits
commit_parsers = [
    { message = '^feat\([^)]*(aide|\*)[^)]*\)', group = "Features" },
    { message = '^fix\([^)]*(aide|\*)[^)]*\)', group = "Bug Fixes" },
    { message = '^doc\([^)]*(aide|\*)[^)]*\)', group = "Documentation" },
    { message = '^perf\([^)]*(aide|\*)[^)]*\)', group = "Performance" },
    { message = '^refactor\([^)]*(aide|\*)[^)]*\)', group = "Refactor" },
    { message = '^style\([^)]*(aide|\*)[^)]*\)', group = "Styling" },
    { message = '^test\([^)]*(aide|\*)[^)]*\)', group = "Testing" },
    { message = '^chore.*version\s*bump.*', skip = true },
    { message = '^chore.*:\s*version\s*$', skip = true },
    { message = '^chore.*changelog.*', skip = true },
    { message = '^chore\([^)]*(aide|\*)[^)]*\)', group = "Miscellaneous Tasks" },
    { body = '.*security', group = "Security" },
]
# filter out the commits that are not matched by commit parsers
filter_commits = true
# glob pattern for matching git tags
tag_pattern = "release-aide-[0-9]*"
# regex for skipping tags
skip_tags = "v0.1.0-beta.1"
# regex for ignoring tags
ignore_tags = ""
# sort the tags chronologically
date_order = false
# sort the commits inside sections by oldest/newest order
sort_commits = "oldest"