release: 24.11.1 (#903)

* release 24.11.1

Signed-off-by: Andrew Kenworthy <andrew.kenworthy@stackable.de>

* fix build action: replace cargo set-version with sed for release PRs

---------

Signed-off-by: Andrew Kenworthy <andrew.kenworthy@stackable.de>

Author: adwk67

.github/workflows/build.yml

@@ -350,13 +350,15 @@ jobs:
         run: cargo set-version --offline --workspace 0.0.0-pr${{ github.event.pull_request.number }}
       - name: Update version if PR against non-main branch
         # For PRs to be merged against a release branch, use the version that has already been set in the calling script.
+        # We can't rely on cargo set-version here as we will break semver rules when changing the version to make it
+        # specific to this PR e.g. 1.2.0 --> 1.2.0-pr678, so set it manually.
         if: ${{ github.event_name == 'pull_request' && github.ref != 'refs/heads/main' }}
         env:
           PR_NUMBER: ${{ github.event.pull_request.number }}
         run: |
           MANIFEST_VERSION=$(cargo metadata --format-version 1 --no-deps | jq -r '.packages[0].version')
           PR_VERSION="${MANIFEST_VERSION}-pr${PR_NUMBER}"
-          cargo set-version --offline --workspace "$PR_VERSION"
+          sed -i "s/version = \"${MANIFEST_VERSION}\"/version = \"${PR_VERSION}\"/" Cargo.toml
 
       # Recreate charts and publish charts and docker image. The "-e" is needed as we want to override the
       # default value in the makefile if called from this action, but not otherwise (i.e. when called locally).
@@ -425,13 +427,15 @@ jobs:
         run: cargo set-version --offline --workspace 0.0.0-pr${{ github.event.pull_request.number }}
       - name: Update version if PR against non-main branch
         # For PRs to be merged against a release branch, use the version that has already been set in the calling script.
+        # We can't rely on cargo set-version here as we will break semver rules when changing the version to make it
+        # specific to this PR e.g. 1.2.0 --> 1.2.0-pr678, so set it manually.
         if: ${{ github.event_name == 'pull_request' && github.ref != 'refs/heads/main' }}
         env:
           PR_NUMBER: ${{ github.event.pull_request.number }}
         run: |
           MANIFEST_VERSION=$(cargo metadata --format-version 1 --no-deps | jq -r '.packages[0].version')
           PR_VERSION="${MANIFEST_VERSION}-pr${PR_NUMBER}"
-          cargo set-version --offline --workspace "$PR_VERSION"
+          sed -i "s/version = \"${MANIFEST_VERSION}\"/version = \"${PR_VERSION}\"/" Cargo.toml
       - name: Build manifest list
         run: |
           # Creating manifest list

CHANGELOG.md

@@ -4,6 +4,8 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
+## [24.11.1] - 2025-01-10
+
 ## [24.11.1-rc2] - 2024-12-12
 
 ## [24.11.1-rc1] - 2024-12-06

Cargo.lock

@@ -3,7 +3,7 @@ members = ["rust/crd", "rust/operator-binary"]
 resolver = "2"
 
 [workspace.package]
-version = "24.11.1-rc2"
+version = "24.11.1"
 authors = ["Stackable GmbH <info@stackable.tech>"]
 license = "OSL-3.0"
 edition = "2021"

Cargo.nix

@@ -1,8 +1,8 @@
 ---
 apiVersion: v2
 name: zookeeper-operator
-version: "24.11.1-rc2"
-appVersion: "24.11.1-rc2"
+version: "24.11.1"
+appVersion: "24.11.1"
 description: The Stackable Operator for Apache ZooKeeper
 home: https://github.com/stackabletech/zookeeper-operator
 maintainers:

Cargo.toml

@@ -28,20 +28,20 @@ helm repo update
 
 echo "Installing Operators with Helm"
 # tag::helm-install-operators[]
-helm install --wait commons-operator stackable-stable/commons-operator --version 24.11.1-rc2
-helm install --wait secret-operator stackable-stable/secret-operator --version 24.11.1-rc2
-helm install --wait listener-operator stackable-stable/listener-operator --version 24.11.1-rc2
-helm install --wait zookeeper-operator stackable-stable/zookeeper-operator --version 24.11.1-rc2
+helm install --wait commons-operator stackable-stable/commons-operator --version 24.11.1
+helm install --wait secret-operator stackable-stable/secret-operator --version 24.11.1
+helm install --wait listener-operator stackable-stable/listener-operator --version 24.11.1
+helm install --wait zookeeper-operator stackable-stable/zookeeper-operator --version 24.11.1
 # end::helm-install-operators[]
 ;;
 "stackablectl")
 echo "installing Operators with stackablectl"
 # tag::stackablectl-install-operators[]
 stackablectl operator install \
-  commons=24.11.1-rc2 \
-  secret=24.11.1-rc2 \
-  listener=24.11.1-rc2 \
-  zookeeper=24.11.1-rc2
+  commons=24.11.1 \
+  secret=24.11.1 \
+  listener=24.11.1 \
+  zookeeper=24.11.1
 # end::stackablectl-install-operators[]
 ;;
 *)
@@ -70,7 +70,7 @@ zkCli_ls() {
 # tag::zkcli-ls[]
 kubectl run my-pod \
   --stdin --tty --quiet --restart=Never \
-  --image docker.stackable.tech/stackable/zookeeper:3.9.2-stackable24.11.1-rc2 -- \
+  --image docker.stackable.tech/stackable/zookeeper:3.9.2-stackable24.11.1 -- \
   bin/zkCli.sh -server simple-zk-server-default:2282 ls / > /dev/null && \
   kubectl logs my-pod && \
   kubectl delete pods my-pod

deploy/helm/zookeeper-operator/Chart.yaml

@@ -1,4 +1,4 @@
-Installed commons=24.11.1-rc2 operator
-Installed secret=24.11.1-rc2 operator
-Installed listener=24.11.1-rc2 operator
-Installed zookeeper=24.11.1-rc2 operator
+Installed commons=24.11.1 operator
+Installed secret=24.11.1 operator
+Installed listener=24.11.1 operator
+Installed zookeeper=24.11.1 operator

docs/modules/zookeeper/examples/getting_started/code/getting_started.sh

@@ -3,7 +3,7 @@ helm:
   repo_name: stackable-stable
   repo_url: https://repo.stackable.tech/repository/helm-stable/
 versions:
-  commons: 24.11.1-rc2
-  secret: 24.11.1-rc2
-  listener: 24.11.1-rc2
-  zookeeper: 24.11.1-rc2
+  commons: 24.11.1
+  secret: 24.11.1
+  listener: 24.11.1
+  zookeeper: 24.11.1

docs/modules/zookeeper/examples/getting_started/code/install_output.txt

@@ -7,10 +7,10 @@ releases:
     description: Integration test
     products:
       commons:
-        operatorVersion: 24.11.1-rc2
+        operatorVersion: 24.11.1
       secret:
-        operatorVersion: 24.11.1-rc2
+        operatorVersion: 24.11.1
       listener:
-        operatorVersion: 24.11.1-rc2
+        operatorVersion: 24.11.1
       zookeeper:
-        operatorVersion: 24.11.1-rc2
+        operatorVersion: 24.11.1