From 462653f64871368c3ff1607127662de0dac91534 Mon Sep 17 00:00:00 2001
From: Andrew Duffy <andreweduffy@gmail.com>
Date: Mon, 5 Aug 2024 11:22:03 -0400
Subject: [PATCH] setup automated releases with release-plz

---
 .github/workflows/release-plz.yml | 34 +++++++++++++++++++++++++++++++
 encodings/alp/Cargo.toml          |  4 ++--
 release-plz.toml                  | 20 ++++++++++++++++++
 vortex-array/Cargo.toml           |  2 +-
 vortex-buffer/Cargo.toml          |  1 +
 5 files changed, 58 insertions(+), 3 deletions(-)
 create mode 100644 .github/workflows/release-plz.yml
 create mode 100644 release-plz.toml

diff --git a/.github/workflows/release-plz.yml b/.github/workflows/release-plz.yml
new file mode 100644
index 0000000000..7847e5a8fe
--- /dev/null
+++ b/.github/workflows/release-plz.yml
@@ -0,0 +1,34 @@
+name: Release-plz
+
+permissions:
+  pull-requests: write
+  contents: write
+
+on:
+  push:
+    branches:
+      - develop
+
+jobs:
+  release-plz:
+    name: Release-plz
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          # Needed to pull full commit history for release version number inference
+          fetch-depth: 0
+
+      - uses: ./.github/actions/cleanup
+
+      - name: Install Protoc
+        uses: arduino/setup-protoc@v3
+
+      - uses: ./.github/actions/setup-rust
+      - uses: ./.github/actions/setup-python
+
+      - name: Run release-plz
+        uses: MarcoIeni/release-plz-action@v0.5
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
diff --git a/encodings/alp/Cargo.toml b/encodings/alp/Cargo.toml
index 0c9b154610..ef0e435525 100644
--- a/encodings/alp/Cargo.toml
+++ b/encodings/alp/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "vortex-alp"
-version = { workspace = true }
 description = "Vortex ALP array"
+version = { workspace = true }
 homepage = { workspace = true }
 repository = { workspace = true }
 authors = { workspace = true }
@@ -28,4 +28,4 @@ divan = { workspace = true }
 
 [[bench]]
 name = "alp_compress"
-harness = false
\ No newline at end of file
+harness = false
diff --git a/release-plz.toml b/release-plz.toml
new file mode 100644
index 0000000000..d7e7047231
--- /dev/null
+++ b/release-plz.toml
@@ -0,0 +1,20 @@
+[workspace]
+# set the path of all the crates to the changelog to the root of the repository
+changelog_path = "./CHANGELOG.md"
+
+# This uses the single-changelog template from https://release-plz.ieni.dev/docs/extra/single-changelog
+[changelog]
+body = """
+
+## `{{ package }}` - [{{ version | trim_start_matches(pat="v") }}]{%- if release_link -%}({{ release_link }}){% endif %} - {{ timestamp | date(format="%Y-%m-%d") }}
+{% for group, commits in commits | group_by(attribute="group") %}
+### {{ group | upper_first }}
+{% for commit in commits %}
+{%- if commit.scope -%}
+- *({{commit.scope}})* {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message }}{%- if commit.links %} ({% for link in commit.links %}[{{link.text}}]({{link.href}}) {% endfor -%}){% endif %}
+{% else -%}
+- {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message }}
+{% endif -%}
+{% endfor -%}
+{% endfor -%}
+"""
diff --git a/vortex-array/Cargo.toml b/vortex-array/Cargo.toml
index 76a51bd5be..e0d0f46ea8 100644
--- a/vortex-array/Cargo.toml
+++ b/vortex-array/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "vortex-array"
-version = { workspace = true }
 description = "Vortex in memory columnar data format"
+version = { workspace = true }
 homepage = { workspace = true }
 repository = { workspace = true }
 authors = { workspace = true }
diff --git a/vortex-buffer/Cargo.toml b/vortex-buffer/Cargo.toml
index ce9f00ea9d..48bf440ace 100644
--- a/vortex-buffer/Cargo.toml
+++ b/vortex-buffer/Cargo.toml
@@ -1,5 +1,6 @@
 [package]
 name = "vortex-buffer"
+description = "A byte buffer implementation for Vortex"
 version.workspace = true
 homepage.workspace = true
 repository.workspace = true