chore: Add git-cliff as a changelog generation tool

Changelogs will be generated using commit messages by
`scripts/release.py`.

Both the commit message and the PR title should follow https://conventionalcommits.org. E.g. start with 'feat:' (for Features / Changes), 'fix:' (for Fixes), 'api:' (for API-Changes), 'api!:' for breaking API-Changes) 'refactor:' (for Refactor), 'perf:' (for Performance), 'test:' (for Tests), 'style:' (for Styling), 'chore:' (for Miscellaneous Tasks)

.github/mergeable.yml

@@ -3,24 +3,13 @@ mergeable:
   - when: pull_request.*
     name: "Changelog check"
     validate:
-      - do: or
+      - do: title
-        validate:
+        begins_with:
-          - do: description
+          match: ['feat', 'fix', 'api', 'refactor', 'perf', 'test', 'style', 'chore']
-            must_include:
+
-              regex: "#skip-changelog"
-          - do: and
-            validate:
-              - do: dependent
-                changed:
-                  file: "src/**"
-                  required: ["CHANGELOG.md"]
-              - do: dependent
-                changed:
-                  file: "deltachat-ffi/src/**"
-                  required: ["CHANGELOG.md"]
     fail:
       - do: checks
         status: "action_required"
         payload:
-          title: Changelog might need an update
+          title: PR title should follow conventional commits
-          summary: "Check if CHANGELOG.md needs an update or add #skip-changelog to the PR description."
+          summary: "PR title should follow https://conventionalcommits.org. E.g. start with 'feat:' (for Features / Changes), 'fix:' (for Fixes), 'api:' (for API-Changes), 'api!:' (for breaking API-Changes) 'refactor:' (for Refactor), 'perf:' (for Performance), 'test:' (for Tests), 'style:' (for Styling), 'chore:' (for Miscellaneous Tasks)"

cliff.toml

@@ -0,0 +1,72 @@
+# configuration file for git-cliff
+# see https://github.com/orhun/git-cliff#configuration-file
+
+
+[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 = "^feat", group = "Features / Changes"},
+    { message = "^fix", group = "Fixes"},
+    { message = "^api", group = "API-Changes" },
+    { message = "^refactor", group = "Refactor"},
+    { message = "^perf", group = "Performance"},
+    { message = "^test", group = "Tests"},
+    { message = "^style", group = "Styling"},
+    { message = "^chore\\(release\\): prepare for", skip = true},
+    { message = "^chore", group = "Miscellaneous Tasks"},
+#    { body = ".*security", group = "Security"},
+]
+# protect breaking changes from being skipped due to matching a skipping commit_parser
+protect_breaking_commits = true
+# filter out the commits that are not matched by commit parsers
+filter_commits = false
+# glob pattern 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
+
+
+[changelog]
+# changelog header
+header = """
+# Changelog\n
+"""
+# template for the changelog body
+# https://tera.netlify.app/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 | upper_first }}
+    {% for commit in commits %}
+        - {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }}\
+    {% endfor %}
+{% endfor %}\n
+"""
+# remove the leading and trailing whitespace from the template
+trim = true
+# changelog footer
+footer = """
+<!-- generated by git-cliff -->
+"""

scripts/release.py

@@ -0,0 +1,39 @@
+#!/usr/bin/env python3
+
+import sys
+import subprocess
+import set_core_version
+from argparse import ArgumentParser
+
+
+# update the version
+parser = ArgumentParser(prog="release")
+parser.add_argument("newversion")
+
+try:
+    newversion = parser.parse_args().newversion
+except SystemExit:
+    newversion = None
+set_core_version.set_version(newversion)
+
+tag = "v" + newversion
+
+# TODO would be nice to automatically checkout the correct branch
+
+# update the changelog
+print(f"Updating CHANGELOG.md using git cliff --unreleased --tag {newversion} --prepend CHANGELOG.md")
+changelog = subprocess.run(["git", "cliff", "--unreleased", "--tag", newversion, "--prepend", "CHANGELOG.md"]).stdout.strip()
+subprocess.run(["git", "add", "-A"])
+subprocess.run(["git", "commit", "-m", f"chore(release): prepare for {tag}"])
+subprocess.run(["git", "show"])
+
+# create a tag
+subprocess.run(
+    [
+        "git", "tag", "-a", tag, "-m", f"Release {tag}", "-m", changelog
+    ]
+)
+subprocess.run(["git", "tag", "-v", tag])
+
+print("Done!")
+print(f"Now push the commit (git push origin {tag}).")

scripts/set_core_version.py

@@ -9,7 +9,14 @@ import subprocess
 from argparse import ArgumentParser
 
 rex = re.compile(r'version = "(\S+)"')
-
+json_list = ["package.json", "deltachat-jsonrpc/typescript/package.json"]
+toml_list = [
+    "Cargo.toml",
+    "deltachat-ffi/Cargo.toml",
+    "deltachat-jsonrpc/Cargo.toml",
+    "deltachat-rpc-server/Cargo.toml",
+    "deltachat-repl/Cargo.toml",
+]
 
 def regex_matches(relpath, regex=rex):
     p = pathlib.Path(relpath)
@@ -60,22 +67,8 @@ def update_package_json(relpath, newversion):
         json.dump(json_data, f, sort_keys=True, indent=2)
         f.write("\n")
 
-
+def set_version(newversion):
-def main():
+    if newversion is None:
-    parser = ArgumentParser(prog="set_core_version")
-    parser.add_argument("newversion")
-
-    json_list = ["package.json", "deltachat-jsonrpc/typescript/package.json"]
-    toml_list = [
-        "Cargo.toml",
-        "deltachat-ffi/Cargo.toml",
-        "deltachat-jsonrpc/Cargo.toml",
-        "deltachat-rpc-server/Cargo.toml",
-        "deltachat-repl/Cargo.toml",
-    ]
-    try:
-        opts = parser.parse_args()
-    except SystemExit:
         print()
         for x in toml_list:
             print(f"{x}: {read_toml_version(x)}")
@@ -84,7 +77,6 @@ def main():
         print()
         raise SystemExit("need argument: newversion, example: 1.25.0")
 
-    newversion = opts.newversion
     if newversion.count(".") < 2:
         raise SystemExit("need at least two dots in version")
 
@@ -134,6 +126,17 @@ def main():
     print(f"   git push origin v{newversion}")
     print("")
 
+def main():
+    parser = ArgumentParser(prog="set_core_version")
+    parser.add_argument("newversion")
+
+    try:
+        newversion = parser.parse_args().newversion
+    except SystemExit:
+        newversion = None
+
+    set_version(newversion)
+
 
 if __name__ == "__main__":
     main()