git-chronicle 0.1.2

AI-powered commit annotation tool that captures reasoning and intent behind code changes
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

[changelog]
header = """
# Changelog

All notable changes to Chronicle will be documented in this file.\n
"""
body = """
{%- macro remote_url() -%}
  https://github.com/gotwalt/git-chronicle
{%- endmacro -%}

{% if version -%}
    ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
{% else -%}
    ## [Unreleased]
{% endif -%}

{% for group, commits in commits | group_by(attribute="group") %}
    ### {{ group | upper_first }}
    {% for commit in commits %}
        - {{ commit.message | split(pat="\n") | first | trim }}\
            {% if commit.scope %} *({{ commit.scope }})*{% endif %} \
            ([{{ commit.id | truncate(length=7, end="") }}]({{ self::remote_url() }}/commit/{{ commit.id }}))\
    {% endfor %}
{% endfor %}
"""
trim = true

[git]
conventional_commits = true
filter_unconventional = false
split_commits = false
commit_parsers = [
    { message = "^feat", group = "Features" },
    { message = "^fix", group = "Bug Fixes" },
    { message = "^refactor", group = "Refactoring" },
    { message = "^doc", group = "Documentation" },
    { message = "^perf", group = "Performance" },
    { message = "^test", group = "Testing" },
    { message = "^ci", group = "Build & CI" },
    { message = "^build", group = "Build & CI" },
    { message = "^style", group = "Styling" },
    { message = "^Add ", group = "Features" },
    { message = "^Replace ", group = "Refactoring" },
    { message = "^Simplify ", group = "Refactoring" },
    { message = "^Fix ", group = "Bug Fixes" },
    { message = "^Make ", group = "Other Changes" },
    { message = "^Update ", group = "Other Changes" },
    { message = "^Remove ", group = "Other Changes" },
    { message = "^chore\\(release\\)", skip = true },
    { message = "^chore", group = "Miscellaneous" },
]
filter_commits = false
tag_pattern = "v[0-9].*"
sort_commits = "newest"