Automate adding new operands and generating documentation (#2156)

* Automate adding new operands and generating documentation * Update README.md Co-authored-by: Vittorio Rigamonti <[email protected]> --------- Co-authored-by: Vittorio Rigamonti <[email protected]>
infinispan · Oct 1, 2024 · 233f3d5 · 233f3d5
1 parent e1eb70d
commit 233f3d5
Show file tree

Hide file tree

Showing 21 changed files with 428 additions and 215 deletions.
diff --git a/.github/workflows/add_operand.yml b/.github/workflows/add_operand.yml
@@ -0,0 +1,73 @@
+name: Add Operand
+
+on:
+  workflow_call:
+    inputs:
+      image:
+        description: "The FQN of the Operand image"
+        required: true
+        type: string
+      version:
+        description: "The upstream-version of the Operand"
+        required: true
+        type: string
+      ref:
+        description: "The git reference to checkout"
+        required: false
+        default: main
+        type: string
+      repository:
+        description: "The git repository to checkout"
+        required: false
+        type: string
+
+  workflow_dispatch:
+    inputs:
+      image:
+        description: "The FQN of the Operand image"
+        required: true
+        type: string
+      version:
+        description: "The upstream-version of the Operand"
+        required: true
+        type: string
+      ref:
+        description: "The git reference to checkout"
+        required: false
+        default: main
+        type: string
+      repository:
+        description: "The git repository to checkout"
+        required: false
+        type: string
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ inputs.ref }}
+          repository: ${{ inputs.repository }}
+
+      - name: Add Operand
+        run: ./scripts/ci/add_operand.sh
+        env:
+          IMAGE: ${{ inputs.image }}
+          VERSION: ${{ inputs.version }}
+
+      - name: Commit changes and create tag
+        run: |
+          git config user.email "[email protected]"
+          git config user.name "Infinispan"
+          git add config/manager/manager.yaml documentation/asciidoc/topics/attributes/community-attributes.adoc documentation/asciidoc/topics/supported_operands/
+          git commit -m "Add Operand ${{ inputs.version }}"
+
+      - name: Push Git changes
+        uses: ad-m/github-push-action@master
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          branch: ${{ inputs.ref }}
+          repository: ${{ inputs.repository }}
diff --git a/README.md b/README.md
@@ -86,29 +86,29 @@ The bundle image can be created and pushed to a repository with:
 make bundle-build bundle-push VERSION=<latest-version> IMG=<operator-image> BUNDLE_IMG=<bundle-image>
 ```
 
+# Operator Version
+The next version of the Operator to be released is stored in the `./version.txt` at the root of the project. The content
+of this file are used to control the generation of documentation and other resources. This file must be updated after an
+Operator release.
+
+# Add a new Infinispan Operand
+1. Call the "Add Operand" GitHub Action
+
 # Release
 To create an Operator release perform the following:
-
-1. Update Operand references:
-   - `SERVER_TAGS` in `scripts/ci/kind.sh` to include the image tage all supported Operands
-   - `INFINISPAN_OPERAND_VERSIONS` json in `config/manager/manager.yaml` includes the latest Infinispan Server releases. Do not use the floating tags for an Operand image, e.g. `13.0`.
-   - `server_image_version` in `documentation/asciidoc/topics/attributes/community-attributes.adoc` to point to the latest Operand version
-   - `test/e2e/utils/common.go` VersionManager JSON to include the latest Operand
-   - `documentation/asciidoc/topics/ref_supported_versions.adoc` to include all supported Operands
-   - `documentation/asciidoc/topics/community-attributes.adoc` to use the latest supported Operand
-2. Commit changes with appropriate commit message, e.g "Releasing Operator <x.y.z>.Final"
-3. Tag the release `git tag <x.y.z>` and push to GitHub
-4. Create and push the multi-arch image using the created tag via the "Image Release" GitHub Action
-5. Remove the old bundle from local `rm -rf bundle`
-6. Create OLM bundle `make bundle VERSION=<x.y.z> CHANNELS=stable DEFAULT_CHANNEL=stable IMG=quay.io/infinispan/operator:<x.y.z>.Final`
-7. Copy contents of `bundle/` and issue PRs to:
+1. Tag the release `git tag <x.y.z>` and push to GitHub
+2. Create and push the multi-arch image using the created tag via the "Image Release" GitHub Action
+3. Remove the old bundle from local `rm -rf bundle`
+4. Create OLM bundle `make bundle VERSION=<x.y.z> CHANNELS=stable DEFAULT_CHANNEL=stable IMG=quay.io/infinispan/operator:<x.y.z>.Final`
+5. Copy contents of `bundle/` and issue PRs to:
     - https://github.com/k8s-operatorhub/community-operators
     - https://github.com/redhat-openshift-ecosystem/community-operators-prod
-8. Once PR in 5 has been merged and Operator has been released to OperatorHub, update the "replaces" field in `config/manifests/bases/infinispan-operator.clusterserviceversion.yaml`
+6. Once PR in 5 has been merged and Operator has been released to OperatorHub, update the "replaces" field in `config/manifests/bases/infinispan-operator.clusterserviceversion.yaml`
 to `replaces: infinispan-operator.v<x.y.z>`
-9. Update `scripts/ci/install-catalog-source.sh` `VERSION` field to the next release version
-10. Update `scripts/create-olm-catalog.sh` to include the just released version in `BUNDLE_IMGS` and the next release version in the update graph
-11. Commit changes with appropriate commit message, e.g "Next Version <x.y.z>"
+7. Update the `version.txt` file to the next release version
+8. Update `scripts/ci/install-catalog-source.sh` `VERSION` field to the next release version
+9. Update `scripts/create-olm-catalog.sh` to include the just released version in `BUNDLE_IMGS` and the next release version in the update graph
+10. Commit changes with appropriate commit message, e.g "Next Version <x.y.z>"
 
 # Testing
 

diff --git a/documentation/asciidoc/topics/attributes/community-attributes.adoc b/documentation/asciidoc/topics/attributes/community-attributes.adoc
@@ -26,8 +26,8 @@
 :lib_path: /opt/infinispan/server/lib
 :backup_path: /opt/infinispan/backups
 :server_image: quay.io/infinispan/server
-:server_image_version: 15.0.8
-:operand_version: 15.0.8
+:server_image_version: 16.0.1
+:operand_version: 16.0.1
 
 :ispn_operator: Infinispan Operator
 :ispn_operator_version: 2.4

diff --git a/documentation/asciidoc/topics/ref_supported_versions.adoc b/documentation/asciidoc/topics/ref_supported_versions.adoc
@@ -5,99 +5,4 @@
 Since version 2.3.0 {ispn_operator} supports multiple {brandname} Server versions.
 You can upgrade the version of your cluster between supported {brandname} versions:
 
-[%header,cols=2*]
-|===
-| {ispn_operator} version
-| {brandname} Server versions
-
-| 2.3.7
-|
-13.0.10
-14.0.1
-14.0.6
-14.0.9
-14.0.13
-14.0.17
-14.0.19
-14.0.20
-14.0.21
-14.0.24
-14.0.27
-| 2.4.0
-|
-13.0.10
-14.0.1
-14.0.6
-14.0.9
-14.0.13
-14.0.17
-14.0.19
-14.0.20
-14.0.21
-14.0.24
-14.0.27
-15.0.0
-| 2.4.1
-|
-13.0.10
-14.0.1
-14.0.6
-14.0.9
-14.0.13
-14.0.17
-14.0.19
-14.0.20
-14.0.21
-14.0.24
-14.0.27
-15.0.0
-| 2.4.2
-|
-13.0.10
-14.0.1
-14.0.6
-14.0.9
-14.0.13
-14.0.17
-14.0.19
-14.0.20
-14.0.21
-14.0.24
-14.0.27
-15.0.0
-15.0.3
-15.0.4
-| 2.4.3
-|
-14.0.1
-14.0.6
-14.0.9
-14.0.13
-14.0.17
-14.0.19
-14.0.20
-14.0.21
-14.0.24
-14.0.27
-15.0.0
-15.0.3
-15.0.4
-15.0.5
-| 2.4.4
-|
-14.0.1
-14.0.6
-14.0.9
-14.0.13
-14.0.17
-14.0.19
-14.0.20
-14.0.21
-14.0.24
-14.0.27
-14.0.32
-15.0.0
-15.0.3
-15.0.4
-15.0.8
-|===
+include::supported_operands/operand_table.adoc[]
diff --git a/documentation/asciidoc/topics/supported_operands/2_3_7.adoc b/documentation/asciidoc/topics/supported_operands/2_3_7.adoc
@@ -0,0 +1,15 @@
+////
+Auto-generated file, do not update this manually.
+To add additional Operands to this file, update the `INFINISPAN_OPERAND_VERSIONS` array in `config/manager/manager.yaml`.
+////
+13.0.10
+14.0.1
+14.0.6
+14.0.9
+14.0.13
+14.0.17
+14.0.19
+14.0.20
+14.0.21
+14.0.24
+14.0.27
diff --git a/documentation/asciidoc/topics/supported_operands/2_4_0.adoc b/documentation/asciidoc/topics/supported_operands/2_4_0.adoc
@@ -0,0 +1,16 @@
+////
+Auto-generated file, do not update this manually.
+To add additional Operands to this file, update the `INFINISPAN_OPERAND_VERSIONS` array in `config/manager/manager.yaml`.
+////
+13.0.10
+14.0.1
+14.0.6
+14.0.9
+14.0.13
+14.0.17
+14.0.19
+14.0.20
+14.0.21
+14.0.24
+14.0.27
+15.0.0
diff --git a/documentation/asciidoc/topics/supported_operands/2_4_1.adoc b/documentation/asciidoc/topics/supported_operands/2_4_1.adoc
@@ -0,0 +1,16 @@
+////
+Auto-generated file, do not update this manually.
+To add additional Operands to this file, update the `INFINISPAN_OPERAND_VERSIONS` array in `config/manager/manager.yaml`.
+////
+13.0.10
+14.0.1
+14.0.6
+14.0.9
+14.0.13
+14.0.17
+14.0.19
+14.0.20
+14.0.21
+14.0.24
+14.0.27
+= 15.0.0
diff --git a/documentation/asciidoc/topics/supported_operands/2_4_2.adoc b/documentation/asciidoc/topics/supported_operands/2_4_2.adoc
@@ -0,0 +1,18 @@
+////
+Auto-generated file, do not update this manually.
+To add additional Operands to this file, update the `INFINISPAN_OPERAND_VERSIONS` array in `config/manager/manager.yaml`.
+////
+13.0.10
+14.0.1
+14.0.6
+14.0.9
+14.0.13
+14.0.17
+14.0.19
+14.0.20
+14.0.21
+14.0.24
+14.0.27
+15.0.0
+15.0.3
+15.0.4
diff --git a/documentation/asciidoc/topics/supported_operands/2_4_3.adoc b/documentation/asciidoc/topics/supported_operands/2_4_3.adoc
@@ -0,0 +1,18 @@
+////
+Auto-generated file, do not update this manually.
+To add additional Operands to this file, update the `INFINISPAN_OPERAND_VERSIONS` array in `config/manager/manager.yaml`.
+////
+14.0.1
+14.0.6
+14.0.9
+14.0.13
+14.0.17
+14.0.19
+14.0.20
+14.0.21
+14.0.24
+14.0.27
+15.0.0
+15.0.3
+15.0.4
+15.0.5
diff --git a/documentation/asciidoc/topics/supported_operands/2_4_4.adoc b/documentation/asciidoc/topics/supported_operands/2_4_4.adoc
@@ -0,0 +1,19 @@
+////
+Auto-generated file, do not update this manually.
+To add additional Operands to this file, update the `INFINISPAN_OPERAND_VERSIONS` array in `config/manager/manager.yaml`.
+////
+14.0.1
+14.0.6
+14.0.9
+14.0.13
+14.0.17
+14.0.19
+14.0.20
+14.0.21
+14.0.24
+14.0.27
+14.0.32
+15.0.0
+15.0.3
+15.0.4
+15.0.8
diff --git a/documentation/asciidoc/topics/supported_operands/operand_table.adoc b/documentation/asciidoc/topics/supported_operands/operand_table.adoc
@@ -0,0 +1,32 @@
+////
+Auto-generated file, do not update this manually, instead update `scripts/ci/docs_generate_operator_operand_table.sh`
+////
+[%header,cols=2*]
+|===
+| {ispn_operator} version
+| {brandname} Server versions
+|
+2.3.7
+|
+include::2_3_7.adoc[]
+|
+2.4.0
+|
+include::2_4_0.adoc[]
+|
+2.4.1
+|
+include::2_4_1.adoc[]
+|
+2.4.2
+|
+include::2_4_2.adoc[]
+|
+2.4.3
+|
+include::2_4_3.adoc[]
+|
+2.4.4
+|
+include::2_4_4.adoc[]
+|===