25.1 GA (#1061)

Co-authored-by: Joyce Fee <[email protected]>
Co-authored-by: Joyce Fee <[email protected]>
Co-authored-by: Kat Batuigas <[email protected]>
Co-authored-by: Michele Cyran <[email protected]>
Co-authored-by: Martin Schneppenheim <[email protected]>
Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com>
Co-authored-by: David Yu <[email protected]>
Co-authored-by: Angela Simms <[email protected]>
Co-authored-by: Rogger Vasquez <[email protected]>
Co-authored-by: Yaniv Ben Hemo <[email protected]>
Co-authored-by: Paulo Borges <[email protected]>
Co-authored-by: Bill Chambers <[email protected]>
Co-authored-by: Stephan Dollberg <[email protected]>
Co-authored-by: Andrew Stucki <[email protected]>
Co-authored-by: Chris Seto <[email protected]>
Co-authored-by: Suslik Da-Rete <[email protected]>

Author: 16 people

.github/workflows/build.yml

@@ -4,7 +4,7 @@
 name: Build Production Site
 on:
   push:
-    branches: [main, 'v/*', shared, api, site-search, 'v-WIP/*']
+    branches: ['v/*', shared, api, site-search]
 jobs:
   dispatch:
     runs-on: ubuntu-latest

.github/workflows/fetch-acceptance-tests.yml

@@ -1,5 +1,5 @@
 ---
-  name: Fetch and Save K8s Acceptance Tests
+  name: Fetch and Save Kubernetes Acceptance Tests
   on:
     workflow_dispatch:  # Allows manual trigger of the workflow
     repository_dispatch:  # Allows other repositories to trigger this workflow
@@ -55,4 +55,3 @@
             title: "auto-docs: Update K8s acceptance tests"
             body: "This PR auto-updates the acceptance tests we use as examples in our Kubernetes docs."
             labels: auto-docs
-            reviewers: JakeSCahill

.github/workflows/generate-crd.yml

@@ -1,8 +1,11 @@
----
-name: Generate CRD Reference Docs
+name: Generate Kubernetes Reference Docs
 on:
-  workflow_dispatch:  # Allows manual trigger of the workflow
-  repository_dispatch:  # Allows other repositories to trigger this workflow
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: 'The Operator release tag for which to generate the docs'
+        required: true
+  repository_dispatch:
     types: [generate-crd-docs]
 jobs:
   trigger:
@@ -11,40 +14,123 @@ jobs:
       id-token: write
       contents: read
     steps:
+      - name: Determine operator tag
+        id: set_operator_tag
+        shell: bash
+        run: |
+          if [ -n "${{ github.event.inputs.tag }}" ]; then
+            TAG="${{ github.event.inputs.tag }}"
+          else
+            TAG="${{ github.event.release.tag_name }}"
+          fi
+          # Check if the tag has the expected prefix.
+          if [[ "$TAG" =~ ^operator/ ]]; then
+            echo "OPERATOR_TAG=$TAG" >> $GITHUB_ENV
+          else
+            echo "Tag does not have the operator/ prefix. Skipping workflow."
+            exit 0
+          fi
+
+      # Configure AWS credentials to get the secret for the Redpanda GitHub bot.
       - uses: aws-actions/configure-aws-credentials@v4
         with:
           aws-region: ${{ vars.RP_AWS_CRED_REGION }}
           role-to-assume: arn:aws:iam::${{ secrets.RP_AWS_CRED_ACCOUNT_ID }}:role/${{ vars.RP_AWS_CRED_BASE_ROLE_NAME }}${{ github.event.repository.name }}
+
       - uses: aws-actions/aws-secretsmanager-get-secrets@v2
         with:
           secret-ids: |
             ,sdlc/prod/github/actions_bot_token
           parse-json-secrets: true
-      # Checkout the specified branch from redpanda repository.
-      - name: Checkout redpanda repository
+
+      - name: Get latest docs version
+        id: antora_version
+        shell: bash
+        run: |
+          ANTORA_VERSION=$(curl -s https://raw.githubusercontent.com/redpanda-data/docs/main/antora.yml | grep '^version:' | sed -E 's/version: *//')
+          echo "Latest docs version is: $ANTORA_VERSION"
+          echo "ANTORA_VERSION=$ANTORA_VERSION" >> $GITHUB_ENV
+
+      - name: Determine docs branch
+        id: set_docs_branch
+        shell: bash
+        run: |
+          TAG="${OPERATOR_TAG}"
+          echo "Original operator tag: $TAG"
+
+          # Filter the tag to include only the vmajor.minor version.
+          # This will remove any "operator/" prefix and any patch version information.
+          FILTERED_TAG=$(echo "$TAG" | sed -E 's/^(operator\/)?(v[0-9]+\.[0-9]+).*/\2/')
+          echo "Filtered tag (vmajor.minor): $FILTERED_TAG"
+
+          if [[ "$FILTERED_TAG" == "v2.4" ]]; then
+            echo "Filtered tag is v2.4. Checking docs version."
+            if [[ "$ANTORA_VERSION" == "25.1" ]]; then
+              echo "Docs main branch version is 25.1, using docs branch 'main'."
+              DOCS_BRANCH="main"
+            else
+              echo "Using docs branch v/24.3 for filtered tag v2.4."
+              if git ls-remote --exit-code --heads https://github.com/redpanda-data/docs.git refs/heads/v/24.3; then
+                DOCS_BRANCH="v/24.3"
+              else
+                echo "Docs branch v/24.3 not found. Skipping."
+                exit 0
+              fi
+            fi
+          else
+            echo "Filtered tag is: $FILTERED_TAG"
+            # For other tags, if the filtered tag matches the latest docs version, then use the main branch.
+            if [[ "$FILTERED_TAG" == "v${ANTORA_VERSION}" ]]; then
+              DOCS_BRANCH="main"
+            else
+              # Otherwise, derive the docs branch from the filtered tag.
+              DOCS_BRANCH="v/${FILTERED_TAG#v}"
+              if ! git ls-remote --exit-code --heads https://github.com/redpanda-data/docs.git refs/heads/"$DOCS_BRANCH"; then
+                echo "Docs branch $DOCS_BRANCH not found."
+                exit 0
+              fi
+            fi
+          fi
+          echo "DOCS_BRANCH=$DOCS_BRANCH" >> $GITHUB_ENV
+          echo "Using docs branch: $DOCS_BRANCH"
+
+      # Checkout the operator repository at the specified tag.
+      - name: Checkout redpanda operator repository
         uses: actions/checkout@v4
         with:
           repository: redpanda-data/redpanda-operator
-          ref: main
+          ref: ${{ env.OPERATOR_TAG }}
           path: redpanda
           token: ${{ env.ACTIONS_BOT_TOKEN }}
-      # Checkout the redpanda-docs repository based on the FORMATTED_BRANCH.
-      - name: Checkout this repository
+
+      # Checkout the docs repository using the determined docs branch.
+      - name: Checkout redpanda-docs repository
         uses: actions/checkout@v4
         with:
-          ref: main
           repository: redpanda-data/docs
+          ref: ${{ env.DOCS_BRANCH }}
           path: redpanda-docs
           token: ${{ env.ACTIONS_BOT_TOKEN }}
-      # Download crd-ref-docs utility for doc generation.
+
       - name: Download crd-ref-docs
         run: |
           curl -fLO https://github.com/elastic/crd-ref-docs/releases/download/v0.1.0/crd-ref-docs_0.1.0_Linux_x86_64.tar.gz
           tar -xzf crd-ref-docs_0.1.0_Linux_x86_64.tar.gz
           chmod +x crd-ref-docs
           sudo mv crd-ref-docs /usr/local/bin/
-      # Generate Operator CRD documentation.
-      - name: Generate Operator CRD Docs
+
+      - name: Download helm-docs
+        run: |
+          curl -sL https://github.com/norwoodj/helm-docs/releases/download/v1.11.0/helm-docs_1.11.0_Linux_x86_64.tar.gz | tar xz
+          echo "helm-docs" >> $GITHUB_PATH
+          sudo mv helm-docs /usr/local/bin/
+
+      # Install pandoc, a tool to convert between different markup formats.
+      - name: Install pandoc
+        run: |
+          sudo apt-get install pandoc
+
+      - name: Generate Operator CRD docs
         run: |
           crd-ref-docs \
             --source-path=./redpanda/operator/api/redpanda/v1alpha2 \
@@ -53,26 +139,47 @@ jobs:
             --config=./redpanda/operator/crd-ref-docs-config.yaml \
             --renderer=asciidoctor \
             --output-path=./redpanda-docs/modules/reference/pages/k-crd.adoc
-      # Check for any changes made in the documentation.
-      - name: Check if changes were made
-        id: check_changes
+
+      - name: Generate Helm docs
         run: |
-          cd ./redpanda-docs
-          changes=$(git status --porcelain)
-          if [ -z "$changes" ]; then
-            echo "has_changes=false" >> $GITHUB_ENV
-          else
-            echo "has_changes=true" >> $GITHUB_ENV
-          fi
-      # If changes were detected, commit those changes.
-      - name: Commit changes
-        if: env.has_changes == 'true'
+          helm-docs
+        working-directory: ./redpanda
+
+      # Convert the generated Markdown Helm documentation to AsciiDoc format using pandoc.
+      - name: Convert Markdown to AsciiDoc
+        run: |
+          pandoc ./helm-charts/charts/redpanda/README.md -t asciidoc -o ./redpanda-docs/modules/reference/pages/k-redpanda-helm-spec.adoc
+          pandoc ./helm-charts/charts/console/README.md -t asciidoc -o ./redpanda-docs/modules/reference/pages/k-console-helm-spec.adoc
+          pandoc ./helm-charts/charts/operator/README.md -t asciidoc -o ./redpanda-docs/modules/reference/pages/k-operator-helm-spec.adoc
+      - name: Modify third-level headings format
         run: |
-          cd ./redpanda-docs
-          git config --global user.email "[email protected]"
-          git config --global user.name "vbotbuildovich"
-          git add .
-          git commit -m "auto-docs: Update CRD reference doc"
-          git push origin main
-        env:
-          ACCESS_TOKEN: ${{ env.ACTIONS_BOT_TOKEN }}
+          sed -i 's/\(\[[0-9]*\)\]\./\1\\]\./g' ./redpanda-docs/modules/reference/pages/k-redpanda-helm-spec.adoc
+          sed -i 's/\(\[[0-9]*\)\]\./\1\\]\./g' ./redpanda-docs/modules/reference/pages/k-console-helm-spec.adoc
+          sed -i 's/\(\[[0-9]*\)\]\]/\1\\]\]/g' ./redpanda-docs/modules/reference/pages/k-operator-helm-spec.adoc
+          sed -i 's/=== \(http\([^[]\|\%5[BbDd]\)*\)\[\([^]]*\)\]/=== link:++\1++\[\3\]/' ./redpanda-docs/modules/reference/pages/k-redpanda-helm-spec.adoc
+          sed -i 's/=== \(http\([^[]\|\%5[BbDd]\)*\)\[\([^]]*\)\]/=== link:++\1++\[\3\]/' ./redpanda-docs/modules/reference/pages/k-console-helm-spec.adoc
+          sed -i 's/=== \(http\([^[]\|\%5[BbDd]\)*\)\[\([^]]*\)\]/=== link:++\1++\[\3\]/' ./redpanda-docs/modules/reference/pages/k-operator-helm-spec.adoc
+      - name: Correct AsciiDoc format
+        run: |
+          # Correct the title format
+          sed -i 's/^== # \(.*\)/= \1/' ./redpanda-docs/modules/reference/pages/k-redpanda-helm-spec.adoc
+          sed -i 's/^== # \(.*\)/= \1/' ./redpanda-docs/modules/reference/pages/k-console-helm-spec.adoc
+          sed -i 's/^== # \(.*\)/= \1/' ./redpanda-docs/modules/reference/pages/k-operator-helm-spec.adoc
+          # Correct the description format
+          sed -i 's/^== description: \(.*\)/:description: \1/' ./redpanda-docs/modules/reference/pages/k-redpanda-helm-spec.adoc
+          sed -i 's/^== description: \(.*\)/:description: \1/' ./redpanda-docs/modules/reference/pages/k-console-helm-spec.adoc
+          sed -i 's/^== description: \(.*\)/:description: \1/' ./redpanda-docs/modules/reference/pages/k-operator-helm-spec.adoc
+
+      # If changes were detected, open a pull request against the determined docs branch.
+      - name: Create pull request
+        uses: peter-evans/create-pull-request@v6
+        with:
+          commit-message: "auto-docs: Update CRD reference doc for release ${{ env.OPERATOR_TAG }}"
+          token: ${{ env.ACTIONS_BOT_TOKEN }}
+          path: redpanda-docs
+          branch: auto-docs/update-${{ env.OPERATOR_TAG }}
+          base: ${{ env.DOCS_BRANCH }}
+          title: "auto-docs: Update CRD reference doc for release ${{ env.OPERATOR_TAG }}"
+          body: |
+            This PR updates the CRD reference documentation for operator release ${{ env.OPERATOR_TAG }}.
+          labels: auto-docs