From 4787de930ba6f6c17d915948f4483b5107a90f34 Mon Sep 17 00:00:00 2001
From: Callum Dunster <cdunster@users.noreply.github.com>
Date: Tue, 21 Nov 2023 14:06:43 +0100
Subject: [PATCH] chore(ci): add support for release-plz

---
 .github/workflows/release-plz.yaml | 32 ++++++++++++
 cliff.toml                         | 84 ++++++++++++++++++++++++++++++
 release-plz.toml                   |  4 ++
 3 files changed, 120 insertions(+)
 create mode 100644 .github/workflows/release-plz.yaml
 create mode 100644 cliff.toml
 create mode 100644 release-plz.toml

diff --git a/.github/workflows/release-plz.yaml b/.github/workflows/release-plz.yaml
new file mode 100644
index 0000000000..35d158ba7f
--- /dev/null
+++ b/.github/workflows/release-plz.yaml
@@ -0,0 +1,32 @@
+name: Release-plz
+
+permissions:
+  pull-requests: write
+  contents: write
+
+on:
+  push:
+    branches:
+      - release/rocsys-rust
+
+jobs:
+  release-plz:
+    name: Release-plz
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Install Rust toolchain
+        uses: dtolnay/rust-toolchain@stable
+      - name: Printing PWD
+        run: pwd && ls -l
+      - name: Run release-plz
+        uses: MarcoIeni/release-plz-action@v0.5
+        with:
+          registry: rocsys-rust
+          project_manifest: embassy-executor/Cargo.toml
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          CARGO_REGISTRIES_ROCSYS_RUST_TOKEN: ${{ secrets.CLOUDSMITH_CI_API_KEY }}
diff --git a/cliff.toml b/cliff.toml
new file mode 100644
index 0000000000..b211aa341c
--- /dev/null
+++ b/cliff.toml
@@ -0,0 +1,84 @@
+# https://git-cliff.org/docs/configuration
+
+[changelog]
+header = """
+# Changelog\n
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\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
+    | filter(attribute="scope")
+    | sort(attribute="scope") %}
+        - {% if commit.breaking %}[**BREAKING**] {% endif %}*({{commit.scope}})* {{ commit.message | upper_first }}
+        {%- if commit.breaking and commit.breaking_description != commit.message %}
+        {% raw %}  {% endraw %}- **Breaking Change**: {{ commit.breaking_description | upper_first }}
+        {%- endif -%}
+    {%- endfor -%}
+    {% raw %}\n{% endraw %}\
+    {%- for commit in commits %}
+        {%- if commit.scope -%}
+        {% else -%}
+            - {% if commit.breaking %}[**BREAKING**] {% endif %}{{ commit.message | upper_first }}
+            {% if commit.breaking and commit.breaking_description != commit.message -%}
+            {% raw %}  {% endraw %}- **Breaking Change**: {{ commit.breaking_description | upper_first }}
+            {% endif -%}
+        {% endif -%}
+    {% endfor -%}
+    {% raw %}\n{% endraw %}\
+{% endfor %}\n
+"""
+# remove the leading and trailing whitespace from the template
+trim = true
+# changelog footer
+footer = ""
+
+[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 = '\(#(\d+)\)', replace = "([#$1](https://dev.azure.com/rocsys/Cake/_workitems/edit/$1))" },
+]
+# regex for parsing and grouping commits
+commit_parsers = [
+  { message = "^fixup!", skip = true },
+  { message = "^feat", group = "Features" },
+  { message = "^fix", group = "Bug Fixes" },
+  { message = "^doc", group = "Documentation" },
+  { message = "^perf", group = "Performance" },
+  { message = "^refactor", group = "Refactor" },
+  { message = "^style", group = "Styling" },
+  { message = "^test", group = "Testing" },
+  { message = "^chore\\(release\\): prepare for", skip = true },
+  { message = "^chore: release", 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]+\\.[0-9]+\\.[0-9]+"
+# regex for skipping tags
+# skip_tags = ""
+# regex for ignoring tags
+ignore_tags = "v[0-9]+\\.[0-9]+\\.[0-9]+[-+].+"
+# sort the tags chronologically
+date_order = false
+# sort the commits inside sections by oldest/newest order
+sort_commits = "oldest"
diff --git a/release-plz.toml b/release-plz.toml
new file mode 100644
index 0000000000..39151a5c69
--- /dev/null
+++ b/release-plz.toml
@@ -0,0 +1,4 @@
+[workspace]
+changelog_config = "cliff.toml" # Path to the git-cliff configuration file
+git_release_enable = false      # Do not create GitHub releases with the release-plz flow
+publish = false