amber-api 2.0.0

Rust client for Amber Electric's API
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

#:schema https://www.schemastore.org/any.json
# git-cliff ~ default configuration file
# https://git-cliff.org/docs/configuration

[changelog]
# template for the changelog header
header = """
# Changelog\n
All notable changes to this project will be documented in this file.

<!-- markdownlint-disable -->

"""
# template for the changelog body
# 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 -%}
{% for group, commits in commits | group_by(attribute="group") -%}
    ### {{ group | striptags | trim | upper_first }}

    {% for commit in commits -%}
        -   {% if commit.scope %}_({{ commit.scope }})_ {% endif -%}
            {% if commit.breaking %}[**breaking**] {% endif -%}
            {{ commit.message | upper_first }}
    {% endfor %}
{% endfor -%}
{% if github.contributors -%}\
    ### Contributors

    {% for contributor in github.contributors -%}\
        {% if not contributor.username or contributor.username is ending_with("[bot]") %}{% continue %}{% endif -%}
        -   @{{ contributor.username }}
    {% endfor %}
{% endif -%}
"""
# template for the changelog footer
footer = """
<!-- generated by git-cliff on {{ now() | date(format="%Y-%m-%d") }}-->
"""
# remove the leading and trailing s
trim = true
# postprocessors
postprocessors = []
# render body even when there are no releases to process
# render_always = true
# output file path
output = "CHANGELOG.md"

[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 = [
  # Remove the PR number added by GitHub when merging PR in UI
  { pattern = '\s*\(#([0-9]+)\)$', replace = "" },
  # Check spelling of the commit with https://github.com/crate-ci/typos
  { pattern = '.*', replace_command = 'typos --write-changes -' },
]
# regex for parsing and grouping commits
commit_parsers = [
  # Ignore deps commits from the changelog
  { message = "^(chore|fix)\\(deps.*\\)", skip = true },
  # Group commits by type
  { group = "<!-- 00 -->๐Ÿš€ Features", message = "^feat" },
  { group = "<!-- 01 -->๐Ÿ› Bug Fixes", message = "^fix" },
  { group = "<!-- 50 -->๐Ÿšœ Refactor", message = "^refactor" },
  { group = "<!-- 51 -->โšก Performance", message = "^perf" },
  { group = "<!-- 52 -->๐ŸŽจ Styling", message = "^style" },
  { group = "<!-- 60 -->๐Ÿ“š Documentation", message = "^docs" },
  { group = "<!-- 80 -->๐Ÿงช Testing", message = "^test" },
  { group = "<!-- 98 -->โ—€๏ธ Revert", message = "^revert" },
  { group = "<!-- 99 -->โš™๏ธ Miscellaneous Tasks", message = "^chore" },
  { group = "<!-- 99 -->๏ฟฝ Other", message = ".*" },
]
# filter out the commits that are not matched by commit parsers
filter_commits = false
# sort the tags topologically
topo_order = false
# sort the commits inside sections by oldest/newest order
sort_commits = "oldest"

[remote.github]
owner = "JP-Ellis"
repo  = "amber-api"