From bf9a5d866495ea5c92a36d5e6095307a7f22dd26 Mon Sep 17 00:00:00 2001
From: Jack <jack.green@hazelcast.com>
Date: Thu, 6 Nov 2025 21:57:17 +0000
Subject: [PATCH 1/3] Partially automate release - tagging and documentation
 generation

_Partially_ automates the steps in https://hazelcast.atlassian.net/wiki/spaces/HZC/pages/129810774/C+Client+Release+Process

Specifically:
- Git tagging
- Doxygen

By scripting and chaining the steps, the (manual) release work is reduced and consistency is improved.
Tagging logic based on [approach in `hazelcast-docker`](https://github.com/hazelcast/hazelcast-docker/blob/master/.github/workflows/retag.yml).

Of note - the instructions call for an "annotated tag" (`tag -a`). While this [seems more sensible](https://stackoverflow.com/q/4971746), it's not [how we make tags elsewhere](https://github.com/search?q=org%3Ahazelcast%20%22git%20tag%22&type=code) (most notablly - [in the release pipeline](https://github.com/hazelcast/hazelcast-pipeline-library/blob/43882a84b3715e2ac74f84c92f3c3d170504f2ab/src/com/hazelcast/qe/pipeline/git/Branch.groovy#L122-L127)), so for consistency I've changed to lightweight tags.

Testing:
- [example execution](https://github.com/JackPGreen/hazelcast-cpp-client/actions/runs/19150806835)
- [tag created](https://github.com/JackPGreen/hazelcast-cpp-client/releases/tag/v5.5.3)
- [documentation PR raised](https://github.com/JackPGreen/hazelcast-cpp-client/pull/4)

Post-merge actions:
- [ ] update docs
---
 .github/workflows/release.yml | 87 +++++++++++++++++++++++++++++++++++
 1 file changed, 87 insertions(+)
 create mode 100644 .github/workflows/release.yml

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
new file mode 100644
index 000000000..96b8f3ffa
--- /dev/null
+++ b/.github/workflows/release.yml
@@ -0,0 +1,87 @@
+name: Release
+
+on:
+  workflow_dispatch:
+    inputs:
+      BRANCH_NAME:
+        description: The branch to work with, if not implicit
+        required: false
+
+jobs:
+  prepare:
+    name: Prepare
+    runs-on: ubuntu-latest
+    outputs:
+      branch_name: ${{ inputs.BRANCH_NAME || github.ref_name }}
+      tag_name: v${{ inputs.BRANCH_NAME || github.ref_name }}
+    steps:
+      - run: exit 0
+
+  tag:
+    name: Tag and delete branch
+    runs-on: ubuntu-latest
+    needs: prepare
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          ref: ${{ needs.prepare.outputs.branch_name }}
+          fetch-depth: 0
+
+      - name: Tag `${{ needs.prepare.outputs.branch_name }}` as `${{ needs.prepare.outputs.tag_name }}`
+        run: |
+          git tag ${{ needs.prepare.outputs.tag_name }} origin/${{ needs.prepare.outputs.branch_name }}
+          git push origin ${{ needs.prepare.outputs.tag_name }}
+
+      - name: Delete `${{ needs.prepare.outputs.branch_name }}`
+        run: |
+          git push origin --delete ${{ needs.prepare.outputs.branch_name }}
+
+  pages:
+    name: Publish docs
+    runs-on: ubuntu-latest
+    needs:
+      - tag
+      - prepare
+    env:
+        GH_PAGES_BRANCH: gh-pages
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          path: repo
+          ref: ${{ needs.prepare.outputs.tag_name }}
+
+      - uses: actions/checkout@v5
+        with:
+          ref: ${{ env.GH_PAGES_BRANCH}}
+          path: ${{ env.GH_PAGES_BRANCH}}
+
+      - name: Install Doxygen
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y doxygen
+
+      - name: Generate Doxygen documentation
+        run: |
+          doxygen repo/Doxyfile
+
+      - name: Post-process docs
+        run: |
+          mv docs/html ${GH_PAGES_BRANCH}/${{ needs.prepare.outputs.branch_name }}
+
+          # doc-index.html
+          sed -i \
+            "/Development Branch/a\<li><a href=\"https://github.com/${GITHUB_REPOSITORY}/blob/${{ needs.prepare.outputs.tag_name }}/Reference_Manual.md\">${{ needs.prepare.outputs.branch_name }}</a></li>" \
+            "${GH_PAGES_BRANCH}/doc-index.html"
+
+          # api-index.html
+          sed -i \
+            "/<ul>/a\  <li><a href=\"${{ needs.prepare.outputs.branch_name }}/index.html\">${{ needs.prepare.outputs.branch_name }}</a></li>" \
+            "${GH_PAGES_BRANCH}/api-index.html"
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v7
+        with:
+          branch: ${{ needs.prepare.outputs.tag_name }}_doc_update_run_${{ github.run_id }}
+          title: Add the new C++ client release (`${{ needs.prepare.outputs.tag_name }}`) documentation
+          body: ""
+          path: ${{ env.GH_PAGES_BRANCH}}

From 08ef2281c8cc498198f7f7616f79b4872a358af6 Mon Sep 17 00:00:00 2001
From: Jack <jack.green@hazelcast.com>
Date: Fri, 7 Nov 2025 11:25:56 +0000
Subject: [PATCH 2/3] Removed dynamic branch detection

---
 .github/workflows/release.yml | 23 +++++++++++------------
 1 file changed, 11 insertions(+), 12 deletions(-)

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index 96b8f3ffa..ee20f6b79 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -4,16 +4,15 @@ on:
   workflow_dispatch:
     inputs:
       BRANCH_NAME:
-        description: The branch to work with, if not implicit
-        required: false
+        description: The branch to work with
+        required: true
 
 jobs:
   prepare:
     name: Prepare
     runs-on: ubuntu-latest
     outputs:
-      branch_name: ${{ inputs.BRANCH_NAME || github.ref_name }}
-      tag_name: v${{ inputs.BRANCH_NAME || github.ref_name }}
+      tag_name: v${{ inputs.BRANCH_NAME }}
     steps:
       - run: exit 0
 
@@ -24,17 +23,17 @@ jobs:
     steps:
       - uses: actions/checkout@v5
         with:
-          ref: ${{ needs.prepare.outputs.branch_name }}
+          ref: ${{ inputs.BRANCH_NAME }}
           fetch-depth: 0
 
-      - name: Tag `${{ needs.prepare.outputs.branch_name }}` as `${{ needs.prepare.outputs.tag_name }}`
+      - name: Tag `${{ inputs.BRANCH_NAME }}` as `${{ needs.prepare.outputs.tag_name }}`
         run: |
-          git tag ${{ needs.prepare.outputs.tag_name }} origin/${{ needs.prepare.outputs.branch_name }}
+          git tag ${{ needs.prepare.outputs.tag_name }} origin/${{ inputs.BRANCH_NAME }}
           git push origin ${{ needs.prepare.outputs.tag_name }}
 
-      - name: Delete `${{ needs.prepare.outputs.branch_name }}`
+      - name: Delete `${{ inputs.BRANCH_NAME }}`
         run: |
-          git push origin --delete ${{ needs.prepare.outputs.branch_name }}
+          git push origin --delete ${{ inputs.BRANCH_NAME }}
 
   pages:
     name: Publish docs
@@ -66,16 +65,16 @@ jobs:
 
       - name: Post-process docs
         run: |
-          mv docs/html ${GH_PAGES_BRANCH}/${{ needs.prepare.outputs.branch_name }}
+          mv docs/html ${GH_PAGES_BRANCH}/${{ inputs.BRANCH_NAME }}
 
           # doc-index.html
           sed -i \
-            "/Development Branch/a\<li><a href=\"https://github.com/${GITHUB_REPOSITORY}/blob/${{ needs.prepare.outputs.tag_name }}/Reference_Manual.md\">${{ needs.prepare.outputs.branch_name }}</a></li>" \
+            "/Development Branch/a\<li><a href=\"https://github.com/${GITHUB_REPOSITORY}/blob/${{ needs.prepare.outputs.tag_name }}/Reference_Manual.md\">${{ inputs.BRANCH_NAME }}</a></li>" \
             "${GH_PAGES_BRANCH}/doc-index.html"
 
           # api-index.html
           sed -i \
-            "/<ul>/a\  <li><a href=\"${{ needs.prepare.outputs.branch_name }}/index.html\">${{ needs.prepare.outputs.branch_name }}</a></li>" \
+            "/<ul>/a\  <li><a href=\"${{ inputs.BRANCH_NAME }}/index.html\">${{ inputs.BRANCH_NAME }}</a></li>" \
             "${GH_PAGES_BRANCH}/api-index.html"
 
       - name: Create Pull Request

From f021d9f2327da4973d516203dbcc20f5241ab5ce Mon Sep 17 00:00:00 2001
From: Jack <jack.green@hazelcast.com>
Date: Fri, 7 Nov 2025 11:31:37 +0000
Subject: [PATCH 3/3] Fix Doxygen generation

---
 .github/workflows/release.yml | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index ee20f6b79..5eaeb1430 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -60,12 +60,13 @@ jobs:
           sudo apt-get install -y doxygen
 
       - name: Generate Doxygen documentation
+        working-directory: repo
         run: |
-          doxygen repo/Doxyfile
+          doxygen
 
       - name: Post-process docs
         run: |
-          mv docs/html ${GH_PAGES_BRANCH}/${{ inputs.BRANCH_NAME }}
+          mv repo/docs/html ${GH_PAGES_BRANCH}/${{ inputs.BRANCH_NAME }}
 
           # doc-index.html
           sed -i \