From 7afb089a5fe4e2d9983e4e301f3bebbdfe6c654f Mon Sep 17 00:00:00 2001
From: Thuan Vo <thuan.votann@gmail.com>
Date: Thu, 18 Jul 2024 11:22:20 -0700
Subject: [PATCH] ci(lint): reorganize workflows and add jobs to check readme
 diff (#179)

---
 .github/workflows/chart-lint.yml | 69 ++++++++++++++++++++++++++
 .github/workflows/chart-test.yml | 82 +++++++++++++++++++++++++++++++
 .github/workflows/ci.yml         | 83 --------------------------------
 .github/workflows/push-oci.yml   |  4 ++
 .github/workflows/submodule.yml  | 48 +++++++++---------
 .github/workflows/unittest.yml   | 41 ----------------
 charts/cryostat/README.md        | 50 ++++++++++++++++---
 7 files changed, 222 insertions(+), 155 deletions(-)
 create mode 100644 .github/workflows/chart-lint.yml
 create mode 100644 .github/workflows/chart-test.yml
 delete mode 100644 .github/workflows/ci.yml
 delete mode 100644 .github/workflows/unittest.yml

diff --git a/.github/workflows/chart-lint.yml b/.github/workflows/chart-lint.yml
new file mode 100644
index 00000000..eaebe99b
--- /dev/null
+++ b/.github/workflows/chart-lint.yml
@@ -0,0 +1,69 @@
+name: Lint Helm Chart
+
+concurrency:
+  group: ci-${{ github.run_id }}
+  cancel-in-progress: true
+
+on:
+  push:
+    branches:
+      - main
+      - v[0-9]+
+      - v[0-9]+.[0-9]+
+      - cryostat-v[0-9]+.[0-9]+
+
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+      - labeled
+      - unlabeled
+    branches:
+      - main
+      - v[0-9]+
+      - v[0-9]+.[0-9]+
+      - cryostat-v[0-9]+.[0-9]+
+
+jobs:
+  lint-chart:
+    runs-on: ubuntu-latest
+    env:
+      TARGET_BRANCH: ${{ github.event.pull_request.base.ref || github.ref_name }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Set up Helm
+        uses: azure/setup-helm@v4
+        with:
+          version: v3.14.4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+          check-latest: true
+      - name: Set up chart-testing
+        uses: helm/chart-testing-action@v2.6.1
+      - name: Lint chart
+        run: ct lint --target-branch ${TARGET_BRANCH} --lint-conf lintconf.yaml --config ct.yaml --chart-yaml-schema chart_schema.yaml
+
+  check-readme-diff:
+    runs-on: ubuntu-latest
+    env:
+      README_GENERATOR_VERSION: 2.5.2
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Check README diff
+        run: |
+          npx @bitnami/readme-generator-for-helm@$README_GENERATOR_VERSION \
+            --values charts/cryostat/values.yaml \
+            --readme charts/cryostat/README.md \
+            --schema charts/cryostat/values.schema.json
+
+          if ! git diff --exit-code; then
+            echo "README requires updating. To update, run:"
+            echo "npx @bitnami/readme-generator-for-helm@$README_GENERATOR_VERSION --values charts/cryostat/values.yaml --readme charts/cryostat/README.md --schema charts/cryostat/values.schema.json"
+            exit 1
+          fi
diff --git a/.github/workflows/chart-test.yml b/.github/workflows/chart-test.yml
new file mode 100644
index 00000000..fa699502
--- /dev/null
+++ b/.github/workflows/chart-test.yml
@@ -0,0 +1,82 @@
+name: Test Helm Chart
+
+concurrency:
+  group: ci-${{ github.run_id }}
+  cancel-in-progress: true
+
+on:
+  push:
+    branches:
+      - main
+      - v[0-9]+
+      - v[0-9]+.[0-9]+
+      - cryostat-v[0-9]+.[0-9]+
+
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+      - labeled
+      - unlabeled
+    branches:
+      - main
+      - v[0-9]+
+      - v[0-9]+.[0-9]+
+      - cryostat-v[0-9]+.[0-9]+
+
+jobs:
+  helm-test:
+    runs-on: ubuntu-latest
+    env:
+      TARGET_BRANCH: ${{ github.event.pull_request.base.ref || github.ref_name }}
+      TEST_NAMESPACE: helm-test
+    steps:
+      - name: Fail if safe-to-test label NOT applied
+        if: ${{ github.event_name == 'pull_request' && !contains(github.event.pull_request.labels.*.name, 'safe-to-test') }}
+        run: exit 1
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Set up Helm
+        uses: azure/setup-helm@v4
+        with:
+          version: v3.14.4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+          check-latest: true
+      - uses: helm/chart-testing-action@v2.6.1
+      - name: Set up Kind cluster
+        uses: helm/kind-action@v1
+        with:
+          cluster_name: ci-${{ github.run_id }}
+      - name: Install and test chart
+        run: |
+          # FIXME: Remove when chart-testing fixes the issue https://github.com/helm/chart-testing/issues/525
+
+          HELM_LOCATION="$(which helm)"
+          sudo mv $HELM_LOCATION "$(dirname $HELM_LOCATION)/.helm"
+          cat <(echo '#!/usr/bin/env bash') <(echo 'exec .helm "${@//--reuse-values/--reset-then-reuse-values}"') | sudo tee $HELM_LOCATION
+          sudo chmod +x $HELM_LOCATION
+
+          kubectl create ns $TEST_NAMESPACE
+          ct install --target-branch ${TARGET_BRANCH} --upgrade --namespace=$TEST_NAMESPACE --config ct.yaml --debug
+
+  helm-unittest:
+    runs-on: ubuntu-latest
+    steps:
+      - name: fail if safe-to-test label NOT applied
+        if: ${{ github.event_name == 'pull_request' && !contains(github.event.pull_request.labels.*.name, 'safe-to-test') }}
+        run: exit 1
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Set up Helm
+        uses: azure/setup-helm@v4
+        with:
+          version: v3.14.4
+      - name: Install unit test plugin
+        run: helm plugin install https://github.com/helm-unittest/helm-unittest.git --version v0.5.1
+      - name: Run Helm unit tests
+        run: helm unittest --debug ./charts/cryostat
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
deleted file mode 100644
index 2986688d..00000000
--- a/.github/workflows/ci.yml
+++ /dev/null
@@ -1,83 +0,0 @@
-name: CI
-
-concurrency:
-  group: ci-${{ github.run_id }}
-  cancel-in-progress: true
-
-on:
-  push:
-    branches:
-      - main
-      - v[0-9]+
-      - v[0-9]+.[0-9]+
-      - cryostat-v[0-9]+.[0-9]+
-
-  pull_request:
-    types:
-      - opened
-      - reopened
-      - synchronize
-      - labeled
-      - unlabeled
-    branches:
-      - main
-      - v[0-9]+
-      - v[0-9]+.[0-9]+
-      - cryostat-v[0-9]+.[0-9]+
-
-env:
-  TARGET_BRANCH: ${{ github.event.pull_request.base.ref || github.ref_name }}
-  TEST_NAMESPACE: helm-test
-
-jobs:
-  lint-chart:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-      - name: Set up Helm
-        uses: azure/setup-helm@v4
-        with:
-          version: v3.14.4
-      - uses: actions/setup-python@v5
-        with:
-          python-version: '3.x'
-          check-latest: true
-      - name: Set up chart-testing
-        uses: helm/chart-testing-action@v2.6.1
-      - name: Lint chart
-        run: ct lint --target-branch ${TARGET_BRANCH} --lint-conf lintconf.yaml --config ct.yaml --chart-yaml-schema chart_schema.yaml
-  test-chart:
-    runs-on: ubuntu-latest
-    steps:
-    - name: Fail if safe-to-test label NOT applied
-      if: ${{ github.event_name == 'pull_request' && !contains(github.event.pull_request.labels.*.name, 'safe-to-test') }}
-      run: exit 1
-    - uses: actions/checkout@v4
-      with:
-        fetch-depth: 0
-    - name: Set up Helm
-      uses: azure/setup-helm@v4
-      with:
-        version: v3.14.4
-    - uses: actions/setup-python@v5
-      with:
-        python-version: '3.x'
-        check-latest: true
-    - uses: helm/chart-testing-action@v2.6.1
-    - name: Set up Kind cluster
-      uses: helm/kind-action@v1
-      with:
-        cluster_name: ci-${{ github.run_id }}
-    - name: Install and test chart
-      run: |
-        # FIXME: Remove when chart-testing fixes the issue https://github.com/helm/chart-testing/issues/525
-        
-        HELM_LOCATION="$(which helm)"
-        sudo mv $HELM_LOCATION "$(dirname $HELM_LOCATION)/.helm"
-        cat <(echo '#!/usr/bin/env bash') <(echo 'exec .helm "${@//--reuse-values/--reset-then-reuse-values}"') | sudo tee $HELM_LOCATION
-        sudo chmod +x $HELM_LOCATION
-
-        kubectl create ns $TEST_NAMESPACE
-        ct install --target-branch ${TARGET_BRANCH} --upgrade --namespace=$TEST_NAMESPACE --config ct.yaml --debug
diff --git a/.github/workflows/push-oci.yml b/.github/workflows/push-oci.yml
index e16ab4da..dc7927b8 100644
--- a/.github/workflows/push-oci.yml
+++ b/.github/workflows/push-oci.yml
@@ -1,5 +1,9 @@
 name: Push Helm Chart to OCI Registry
 
+concurrency:
+  group: ci-${{ github.run_id }}
+  cancel-in-progress: true
+
 on:
   push:
     branches:
diff --git a/.github/workflows/submodule.yml b/.github/workflows/submodule.yml
index 64a45dbd..71018628 100644
--- a/.github/workflows/submodule.yml
+++ b/.github/workflows/submodule.yml
@@ -1,4 +1,4 @@
-name: submodule
+name: Update Submodule
 
 on:
   workflow_call:
@@ -19,26 +19,26 @@ jobs:
     if: ${{ github.repository_owner == 'cryostatio' }}
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
-      with:
-        repository: cryostatio/cryostatio.github.io
-        token: "${{ secrets.SUBMODULE_TOKEN }}"
-    - name: Import GPG key
-      uses: crazy-max/ghaction-import-gpg@v6
-      with:
-        gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }}
-        passphrase: ${{ secrets.GPG_PASSPHRASE }}
-        git_user_signingkey: true
-        git_commit_gpgsign: true
-    - name: Update submodule to latest commit
-      run: |
-        git submodule update --init
-        git submodule update --remote
-    - name: Commit and push submodule
-      run: |
-        git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
-        git config user.name "github-actions[bot]"
-        git add --all
-        git_hash="$(git rev-parse --short :helm-charts)"
-        git commit -S -m "build(helm-charts): update submodule to $git_hash" || echo "No changes to commit"
-        git push
+      - uses: actions/checkout@v4
+        with:
+          repository: cryostatio/cryostatio.github.io
+          token: "${{ secrets.SUBMODULE_TOKEN }}"
+      - name: Import GPG key
+        uses: crazy-max/ghaction-import-gpg@v6
+        with:
+          gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }}
+          passphrase: ${{ secrets.GPG_PASSPHRASE }}
+          git_user_signingkey: true
+          git_commit_gpgsign: true
+      - name: Update submodule to latest commit
+        run: |
+          git submodule update --init
+          git submodule update --remote
+      - name: Commit and push submodule
+        run: |
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git config user.name "github-actions[bot]"
+          git add --all
+          git_hash="$(git rev-parse --short :helm-charts)"
+          git commit -S -m "build(helm-charts): update submodule to $git_hash" || echo "No changes to commit"
+          git push
diff --git a/.github/workflows/unittest.yml b/.github/workflows/unittest.yml
deleted file mode 100644
index b89d990f..00000000
--- a/.github/workflows/unittest.yml
+++ /dev/null
@@ -1,41 +0,0 @@
-name: Helm unit tests
-
-on:
-  push:
-    branches:
-      - main
-      - v[0-9]+
-      - v[0-9]+.[0-9]+
-      - cryostat-v[0-9]+.[0-9]+
-  
-  pull_request:
-    types:
-      - opened
-      - reopened
-      - synchronize
-      - labeled
-      - unlabeled
-    branches:
-      - main
-      - v[0-9]+
-      - v[0-9]+.[0-9]+
-      - cryostat-v[0-9]+.[0-9]+
-
-jobs:
-  helm-unittests:
-    runs-on: ubuntu-latest
-    steps:
-      - name: fail if safe-to-test label NOT applied
-        if: ${{ github.event_name == 'pull_request' && !contains(github.event.pull_request.labels.*.name, 'safe-to-test') }}
-        run: exit 1
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-      - name: Set up Helm
-        uses: azure/setup-helm@v4
-        with:
-          version: v3.14.4
-      - name: Install unit test plugin
-        run: helm plugin install https://github.com/helm-unittest/helm-unittest.git --version v0.5.1
-      - name: Run Helm unit tests
-        run: helm unittest --debug ./charts/cryostat
diff --git a/charts/cryostat/README.md b/charts/cryostat/README.md
index 2db89326..7e273ce7 100644
--- a/charts/cryostat/README.md
+++ b/charts/cryostat/README.md
@@ -1,13 +1,49 @@
 # Cryostat Helm Chart
-A Helm chart for deploying [Cryostat](https://cryostat.io/) on Kubernetes and OpenShift
 
-## Installing
+![Version: 2.0.0-dev](https://img.shields.io/badge/Version-2.0.0--dev-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 4.0.0-dev](https://img.shields.io/badge/AppVersion-4.0.0--dev-informational?style=flat-square)
 
-The Cryostat Helm Chart is available to install from various locations:
-- `helm repo add cryostat https://cryostat.io/helm-charts ; helm search repo cryostat ; helm install cryostat cryostat/cryostat`
-- `helm install cryostat oci://ghcr.io/cryostatio/cryostat-helm --version $VERSION`
-- `git clone https://github.com/cryostatio/cryostat-helm ; cd cryostat-helm ; helm install cryostat ./charts/cryostat`
-- `helm repo add openshift-helm-charts https://charts.openshift.io ; helm search repo cryostat ; helm install cryostat openshift-helm-charts/redhat-cryostat`
+A Helm chart for deploying [Cryostat](https://cryostat.io/) on Kubernetes and OpenShift.
+
+## Requirements
+
+Kubernetes: `>= 1.25.0-0`
+
+## Installation
+
+### From Helm repository
+
+The chart is available at the following repositories:
+
+- https://cryostat.io/helm-charts
+- https://charts.openshift.io
+
+To install the chart, add the repository and install, for example:
+
+```bash
+helm repo add cryostat-charts https://cryostat.io/helm-charts
+helm repo update
+helm install cryostat cryostat-charts/cryostat
+```
+
+### From OCI container registry
+
+The chart is also available as an OCI image on GitHub Container Registry (`ghcr.io`).
+
+To install the chart, run:
+
+```bash
+helm install cryostat oci://ghcr.io/cryostatio/cryostat-helm --version $VERSION
+```
+
+### From source code
+
+To install the chart from source code, run:
+
+```bash
+git clone https://github.com/cryostatio/cryostat-helm
+cd cryostat-helm
+helm install cryostat ./charts/cryostat
+```
 
 ## Parameters