regd-testing 0.1.2

regd testing is a collection of utilities designed to simplify testing in regd projects.
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

[changelog]
header = """
<!---
  Licensed to the Apache Software Foundation (ASF) under one
  or more contributor license agreements.  See the NOTICE file
  distributed with this work for additional information
  regarding copyright ownership.  The ASF licenses this file
  to you under the Apache License, Version 2.0 (the
  "License"); you may not use this file except in compliance
  with the License.  You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing,
  software distributed under the License is distributed on an
  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  KIND, either express or implied.  See the License for the
  specific language governing permissions and limitations
  under the License.
-->
"""
body = """
{%- macro remote_url() -%}
  https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}
{%- endmacro -%}
# Changelog
{% if version %}
  ## [{{ version | trim_start_matches(pat="v") }}]({{ self::remote_url() }}/tree/{{ version | trim_start_matches(pat="v")}}) - {{ timestamp | date(format="%Y-%m-%d") }}
{% else %}
  ## [unreleased]
{% endif %}
### What's changed
{% for group, commits in commits | filter(attribute="merge_commit", value=false) | group_by(attribute="group") %}
  #### {{ group }}
  {% for commit in commits %}
    {%- if commit.remote.pr_title -%}
      {% set commit_message = commit.remote.pr_title %}
    {%- else -%}
      {% set commit_message = commit.message %}
    {%- endif -%}
    * {{ commit_message | split(pat="\n") | first | trim | trim_end_matches(pat=".") }}\
      {% if commit.remote.username %} by **@{{ commit.remote.username }}**{% endif %}\
      {% if commit.remote.pr_number %} in [#{{ commit.remote.pr_number }}]({{ self::remote_url() }}/pull/{{ commit.remote.pr_number }}){% endif %}    
  {% endfor -%}
{% endfor %}
{% if version %}
  {%- if previous.version -%}
    **Full Changelog**: {{ self::remote_url() }}/compare/{{ previous.version }}...{{ version }}
  {% endif -%}
{% endif %}
"""
footer = """
<!-- generated by git-cliff -->
"""
trim = true

[git]
conventional_commits = true
filter_unconventional = false
split_commits = false
# NOTE:
# When selecting `remote.pr_title` as the `field`, ^ does not match properly,
# so the following verbose regex is used as a workaround.
commit_parsers = [
  { message = "$^", skip = true },
  { field = "author.name", pattern = "github-actions", skip = true },
  { field = "author.email", pattern = "github-actions@github.com", skip = true },
  { field = "committer.name", pattern = "github-actions", skip = true },
  { field = "committer.email", pattern = "github-actions@github.com", skip = true },
  { field = "remote.pr_title", pattern = "feat\\s*(\\([^)]+\\))?\\s*:", group = "<!-- 00 -->🚀 Features" },
  { field = "remote.pr_title", pattern = "fix\\s*(\\([^)]+\\))?\\s*:", group = "<!-- 01 -->🐛 Bug Fixes" },
  { field = "remote.pr_title", pattern = "refactor\\s*(\\([^)]+\\))?\\s*:", group = "<!-- 02 -->🚜 Refactor" },
  { field = "remote.pr_title", pattern = "docs\\s*(\\([^)]+\\))?\\s*:", group = "<!-- 03 -->📚 Documentation" },
  { field = "remote.pr_title", pattern = "perf\\s*(\\([^)]+\\))?\\s*:", group = "<!-- 04 -->⚡ Performance" },
  { field = "remote.pr_title", pattern = "style\\s*(\\([^)]+\\))?\\s*:", group = "<!-- 05 -->🎨 Styling" },
  { field = "remote.pr_title", pattern = "test\\s*(\\([^)]+\\))?\\s*:", group = "<!-- 06 -->🧪 Testing" },
  { field = "remote.pr_title", pattern = "chore\\s*\\(\\s*release\\s*\\)\\s*:", skip = true },
  { field = "remote.pr_title", pattern = "chore\\s*\\(\\s*deps.*\\s*\\)\\s*:", skip = true },
  { field = "remote.pr_title", pattern = "chore\\s*\\(\\s*pr\\s*\\)\\s*:", skip = true },
  { field = "remote.pr_title", pattern = "chore\\s*\\(\\s*pull\\s*\\)\\s*:", skip = true },
  { field = "remote.pr_title", pattern = "chore\\s*(\\([^)]+\\))?\\s*:|ci\\s*(\\([^)]+\\))?\\s*:", group = "<!-- 07 -->⚙️ Miscellaneous Tasks" },
  { field = "remote.pr_title", pattern = "revert\\s*(\\([^)]+\\))?\\s*:", group = "<!-- 08 -->◀️ Revert" },
  { field = "remote.pr_title", pattern = ".*", group = "<!-- 09 -->💼 Other" },
]
protect_breaking_commits = false
filter_commits = true
topo_order = false
sort_commits = "oldest"

[remote.github]
owner = "regd-io"
repo = "testing"