Merge pull request #30 from coreydaley/2025-01-16-complete-helm-chart…

…-testing DEVAI-196: Helm Chart Linting
redhat-ai-dev · Jan 19, 2025 · e14adc1 · e14adc1
2 parents 795ef03 + 0d4277b
commit e14adc1
Show file tree

Hide file tree

Showing 12 changed files with 92 additions and 38 deletions.
diff --git a/.ct/config.yaml b/.ct/config.yaml
@@ -0,0 +1,5 @@
+chart-dirs:
+  - charts/ai-software-templates
+validate-maintainers: false
+remote: origin
+target-branch: main
diff --git a/.github/workflows/generate.yaml b/.github/workflows/generate.yaml
@@ -0,0 +1,52 @@
+name: Generate
+
+on:
+  pull_request:
+    paths:
+      - "charts/**"
+
+jobs:
+  check-readme:
+    runs-on: ubuntu-latest
+    env:
+      GO111MODULE: on
+    steps:
+      - name: Checkout
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # pin@v3
+
+      - uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # pin@v4
+        with:
+          python-version: 3.12
+
+      - uses: actions/setup-go@41dfa10bad2bb2ae585af6ee5bb4d7d973ad74ed # pin@v3
+        with:
+          go-version: ^1
+
+      - name: Setup helm-docs
+        run: go install github.com/norwoodj/helm-docs/cmd/helm-docs@latest
+
+      - name: Run pre-commit
+        uses: pre-commit/action@2c7b3805fd2a0fd8c1884dcaebf91fc102a13ecd # [email protected]
+        with:
+          extra_args: helm-docs --all-files
+
+  check-jsonschema-dereference:
+    runs-on: ubuntu-latest
+    env:
+      GO111MODULE: on
+    steps:
+      - name: Checkout
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # pin@v3
+
+      - uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # pin@v4
+        with:
+          python-version: 3.12
+
+      - uses: actions/setup-go@41dfa10bad2bb2ae585af6ee5bb4d7d973ad74ed # pin@v3
+        with:
+          go-version: ^1
+
+      - name: Run pre-commit
+        uses: pre-commit/action@2c7b3805fd2a0fd8c1884dcaebf91fc102a13ecd
+        with:
+          extra_args: jsonschema-dereference --all-files
diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml
@@ -1,52 +1,30 @@
-name: Lint Charts
+name: Lint
 
 on:
   pull_request:
     paths:
       - "charts/**"
 
 jobs:
-  check-readme:
+  charts:
     runs-on: ubuntu-latest
-    env:
-      GO111MODULE: on
     steps:
       - name: Checkout
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # pin@v3
-
-      - uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # pin@v4
         with:
-          python-version: 3.12
+          fetch-depth: 0
 
-      - uses: actions/setup-go@41dfa10bad2bb2ae585af6ee5bb4d7d973ad74ed # pin@v3
+      - name: Set up Helm
+        uses: azure/setup-helm@fe7b79cd5ee1e45176fcad797de68ecaf3ca4814 # [email protected]
         with:
-          go-version: ^1
-
-      - name: Setup helm-docs
-        run: go install github.com/norwoodj/helm-docs/cmd/helm-docs@latest
-
-      - name: Run pre-commit
-        uses: pre-commit/action@2c7b3805fd2a0fd8c1884dcaebf91fc102a13ecd # [email protected]
-        with:
-          extra_args: helm-docs --all-files
-
-  check-jsonschema-dereference:
-    runs-on: ubuntu-latest
-    env:
-      GO111MODULE: on
-    steps:
-      - name: Checkout
-        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # pin@v3
+          version: v3.10.0
 
       - uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # pin@v4
         with:
           python-version: 3.12
 
-      - uses: actions/setup-go@41dfa10bad2bb2ae585af6ee5bb4d7d973ad74ed # pin@v3
-        with:
-          go-version: ^1
+      - name: Set up chart-testing
+        uses: helm/chart-testing-action@e6669bcd63d7cb57cb4380c33043eebe5d111992 # [email protected]
 
-      - name: Run pre-commit
-        uses: pre-commit/action@2c7b3805fd2a0fd8c1884dcaebf91fc102a13ecd
-        with:
-            extra_args: jsonschema-dereference --all-files
+      - name: Run chart-testing (lint)
+        run: ct lint --config .ct/config.yaml
diff --git a/charts/ai-software-templates/chatbot/Chart.yaml b/charts/ai-software-templates/chatbot/Chart.yaml
@@ -3,7 +3,7 @@ apiVersion: v2
 # The name of the chart (required)
 name: chatbot-ai-sample
 # A SemVer 2 version (required)
-version: 0.1.1
+version: 0.1.2
 # A SemVer range of compatible Kubernetes versions (optional)
 kubeVersion: ">= 1.27.0-0"
 # A single-sentence description of this project (optional)
@@ -14,7 +14,7 @@ type: application
 keywords:
   - chatbot
   - llama.cpp
-  - ai-lab 
+  - ai-lab
 # The URL of this projects home page (optional)
 home: https://github.com/redhat-ai-dev/ai-lab-helm-charts
 # A list of URLs to source code for this project (optional)
@@ -29,7 +29,7 @@ maintainers:
 # A URL to an SVG or PNG image to be used as an icon (optional)
 # icon: ""
 # The version of the app that this contains (optional). Needn't be SemVer. Quotes recommended.
-# appVersion: 
+# appVersion:
 # Whether this chart is deprecated (optional, boolean)
 deprecated: false
 # A list of annotations keyed by name (optional)

diff --git a/charts/ai-software-templates/chatbot/README.md b/charts/ai-software-templates/chatbot/README.md
@@ -1,7 +1,7 @@
 
 
 # Chatbot AI Sample Helm Chart
-![Version: 0.1.1](https://img.shields.io/badge/Version-0.1.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
+![Version: 0.1.2](https://img.shields.io/badge/Version-0.1.2-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
 
 This Helm Chart deploys a Large Language Model (LLM)-enabled [chat bot application](https://github.com/redhat-ai-dev/ai-lab-samples/tree/main/chatbot).
 

diff --git a/charts/ai-software-templates/chatbot/README.md.gotmpl b/charts/ai-software-templates/chatbot/README.md.gotmpl
@@ -1,3 +1,4 @@
+
 {{ template "chart.deprecationWarning" . }}
 # Chatbot AI Sample Helm Chart
 {{ template "chart.badgesSection" . }}

diff --git a/charts/ai-software-templates/pipeline-install/Chart.yaml b/charts/ai-software-templates/pipeline-install/Chart.yaml
@@ -5,4 +5,4 @@ annotations:
 description: A Helm chart for installing the OpenShift Pipelines Operator, ensuring requisite features for our samples are enabled, as well as providing GitHub Application credentials to Pipelines As Code.
 name: ops-ai-labs-install
 tags: tekton,pipelines,operator
-version: 0.1.0
+version: 0.1.1
diff --git a/charts/ai-software-templates/pipeline-install/README.md b/charts/ai-software-templates/pipeline-install/README.md
@@ -1,5 +1,9 @@
 
+
 # OpenShift Pipelines Installation / Configuration for Devtools AI Sample Applications.
+![Version: 0.1.1](https://img.shields.io/badge/Version-0.1.1-informational?style=flat-square)
+
+A Helm chart for installing the OpenShift Pipelines Operator, ensuring requisite features for our samples are enabled, as well as providing GitHub Application credentials to Pipelines As Code.
 
 This repo is a Helm chart that a user with Cluster Admin level privileges would run to set up OpenShift Pipelines for the Devtools AI sample applications. For more information about helm charts see the official [Helm Charts Documentation](https://helm.sh/).
 

diff --git a/charts/ai-software-templates/pipeline-install/README.md.gotmpl b/charts/ai-software-templates/pipeline-install/README.md.gotmpl
@@ -1,4 +1,9 @@
+
+{{ template "chart.deprecationWarning" . }}
 # OpenShift Pipelines Installation / Configuration for Devtools AI Sample Applications.
+{{ template "chart.badgesSection" . }}
+
+{{ template "chart.description" . }}
 
 This repo is a Helm chart that a user with Cluster Admin level privileges would run to set up OpenShift Pipelines for the Devtools AI sample applications. For more information about helm charts see the official [Helm Charts Documentation](https://helm.sh/).
 

diff --git a/charts/ai-software-templates/pipeline-setup/Chart.yaml b/charts/ai-software-templates/pipeline-setup/Chart.yaml
@@ -5,4 +5,4 @@ annotations:
 description: A Helm chart for integrating the Git and Quay configuration for Pipelines in the user's application namespace.
 name: ops-ai-labs-setup
 tags: tekton,pipelines,operator,ai-lab
-version: 0.1.0
+version: 0.1.1
diff --git a/charts/ai-software-templates/pipeline-setup/README.md b/charts/ai-software-templates/pipeline-setup/README.md
@@ -1,5 +1,9 @@
 
+
 # OpenShift Pipelines Application Namespace setup for Devtools AI Sample Applications.
+![Version: 0.1.1](https://img.shields.io/badge/Version-0.1.1-informational?style=flat-square)
+
+A Helm chart for integrating the Git and Quay configuration for Pipelines in the user's application namespace.
 
 This repo is a Helm chart that a user admin level privileges to his application namespace would run to set up OpenShift Pipelines for the Devtools AI sample applications. For more information about helm charts see the official [Helm Charts Documentation](https://helm.sh/).
 

diff --git a/charts/ai-software-templates/pipeline-setup/README.md.gotmpl b/charts/ai-software-templates/pipeline-setup/README.md.gotmpl
@@ -1,4 +1,9 @@
+
+{{ template "chart.deprecationWarning" . }}
 # OpenShift Pipelines Application Namespace setup for Devtools AI Sample Applications.
+{{ template "chart.badgesSection" . }}
+
+{{ template "chart.description" . }}
 
 This repo is a Helm chart that a user admin level privileges to his application namespace would run to set up OpenShift Pipelines for the Devtools AI sample applications. For more information about helm charts see the official [Helm Charts Documentation](https://helm.sh/).