Add simple release process and info for custom helm repo. (redhat-ai-dev#20)

* Remove 0.1.0 directory

* Add info for custom helm repo

* Add release process information

* Replace release workflow

* Specify chart version info

* Remove relative path

* Address docs feedback

* Add pipelines route as webhook url

* Add correction to Github App naming

* Revert note for webhook url

* Update gitSourceRepo description

* Fix values json description

* Remove special chars from values.json

Author: thepetk

Diff for: .github/workflows/chart-releaser.yaml

@@ -0,0 +1,40 @@
+name: Release Helm Chart Package
+
+on:
+  push:
+    tags:
+      - "v*"
+permissions:
+  contents: write
+
+jobs:
+  release-package:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        chart:
+          - path: charts/ai-software-templates/chatbot
+            package: chatbot-ai-software-template
+    steps:
+      - name: Checkout
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          fetch-depth: 0
+
+      - name: Install Helm
+        uses: azure/setup-helm@fe7b79cd5ee1e45176fcad797de68ecaf3ca4814 # v4.2.0
+        with:
+          version: 3.12.1
+
+      - name: Generate Helm Package
+        run: |
+          RELEASE_VERSION=${GITHUB_REF#refs/*/}
+          CHART_PATH=${{matrix.chart.path}}
+          helm package $CHART_PATH
+          echo "RELEASE_VERSION=${RELEASE_VERSION//v}" >> $GITHUB_ENV
+
+      - name: Add packages to Release
+        uses: softprops/action-gh-release@de2c0eb89ae2a093876385947365aca7b0e5f844 # v0.1.15
+        with:
+          draft: false
+          files: ${{matrix.chart.package}}-${{env.RELEASE_VERSION}}.tgz

Diff for: .github/workflows/release.yaml

@@ -19,3 +19,15 @@ The helm chart mainly uses the tekton pipelines under [rhdh-pipelines](https://g
 - The [.tekton/docker-push.yaml](/pac/pipelineRuns/.tekton/docker-push.yaml) PipelineRun used to manage `push` events received from the github app webhook.
 - The [update-deployment.yaml](/pac/tasks/update-deployment.yaml) Task which is used to update the application deployment whenever a new image is pushed to the image registry.
 - The [docker-build-ai-software-templates-chart.yaml](./pac/pipelines/docker-build-ai-software-templates-chart.yaml) Pipeline, again used for the application deployment update.
+
+## Testing with a Custom Helm Repository
+
+To test your updates by importing the `ai-lab-helm-charts` fork as a custom Helm chart repository, you can follow the instructions [here](./docs/SETUP_CUSTOM_HELM_REPO.md)
+
+## Release Process
+
+The ai-lab-helm-charts are created on demand.
+
+- A `tag` should be created with the version of the release as the name. `ai-lab-helmcharts` follows the v{major}.{minor}.{bugfix} format (e.g v0.1.0).
+- Before proceeding, make sure that all the `version` fields within `Chart.yaml` have this tag as the value. For example in the case where the tag is `v0.1.0`, the `version` should be `0.1.0`.
+- After the new release is published, the updated Helm packages will be pinned on the release.

Diff for: README.md

@@ -9,7 +9,7 @@ The deployment flow, will create an application instance, a model server and a g
 - You have a Github APP created with sufficient permissions for the organization that the application repository will be created. Detailed instructions for the github application creation can be found [here](https://github.com/redhat-ai-dev/ai-rhdh-installer/blob/main/docs/APP-SETUP.md#github-app).
 - You need to have access to a cluster for each operation with OpenShift 4, like deploying and testing.
 - The Namespace that your application will run is already created in your cluster.
-- Your cluster should have [Openshift Pipelines Operator](https://www.redhat.com/en/technologies/cloud-computing/openshift/pipelines) installed and should be connected to your Github APP's webhook. In case your cluster is not configured yet, check the ["Pipelines Configuration Guide"](../../../../docs/PIPELINES_CONFIGURATION.md) for further instructions.
+- Your cluster should have [Openshift Pipelines Operator](https://www.redhat.com/en/technologies/cloud-computing/openshift/pipelines) installed and should be connected to your Github App's webhook. In case your cluster is not configured yet, check the ["Pipelines Configuration Guide"](https://github.com/redhat-ai-dev/ai-lab-helm-charts/blob/main/docs/PIPELINES_CONFIGURATION.md) for further instructions.
 - A `key/value` Secret is already created in the Namespace that you are planning to install your helm release, containing a [Github Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic) with sufficient access to the given Github Organization. You can find the exact permissions [here](https://github.com/redhat-ai-dev/ai-rhdh-installer/blob/main/docs/APP-SETUP.md#procedure). Your Secret's name and the Key of the github token will be provided as values to the helm chart.
 
 ## Background
@@ -61,11 +61,11 @@ Below is a table of each value used to configure this chart. Note:
 
 ### Gitops
 
-| Value                      | Description                                                                                            | Default                            | Additional Information |
-| -------------------------- | ------------------------------------------------------------------------------------------------------ | ---------------------------------- | ---------------------- |
-| `gitops.gitSecretName`     | The name of the Secret containing the required Github token.                                           | `git-secrets`                      |                        |
-| `gitops.gitSecretKeyToken` | The name of the Secret's key with the Github token value.                                              | `GITHUB_TOKEN`                     |                        |
-| `gitops.githubOrgName`     | `[REQUIRED]` The Github Organization name that the chatbot application repository will be created into |                                    |                        |
-| `gitops.gitSourceRepo`     | The Github Repository with the contents of the chatbot application.                                    | `"thepetk/chatbot-test-chart-repo` |                        |
-| `gitops.gitDefaultBranch`  | The default branch for the chatbot application Github repository.                                      | `main`                             |                        |
-| `gitops.quayAccountName`   | `[REQUIRED]` The quay.io account that the application image will be pushed.                            |                                    |                        |
+| Value                      | Description                                                                                                                                         | Default                        | Additional Information |
+| -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | ---------------------- |
+| `gitops.gitSecretName`     | The name of the Secret containing the required Github token.                                                                                        | `git-secrets`                  |                        |
+| `gitops.gitSecretKeyToken` | The name of the Secret's key with the Github token value.                                                                                           | `GITHUB_TOKEN`                 |                        |
+| `gitops.githubOrgName`     | `[REQUIRED]` The Github Organization name that the chatbot application repository will be created into                                              |                                |                        |
+| `gitops.gitSourceRepo`     | The Github Repository with the contents of the ai-lab sample chatbot application. It must be either the `redhat-ai-dev/ai-lab-samples` or its fork. | `redhat-ai-dev/ai-lab-samples` |
+| `gitops.gitDefaultBranch`  | The default branch for the chatbot application Github repository.                                                                                   | `main`                         |                        |
+| `gitops.quayAccountName`   | `[REQUIRED]` The quay.io account that the application image will be pushed.                                                                         |                                |                        |

Diff for: charts/ai-software-templates/chatbot/0.1.0/Chart.yaml renamed to charts/ai-software-templates/chatbot/Chart.yaml

@@ -66,7 +66,7 @@
                 },
                 "gitSourceRepo": {
                     "type": "string",
-                    "description": "The Github Repository with the contents of the chatbot application. If blank it defaults to 'redhat-ai-dev/ai-lab-samples'.",
+                    "description": "The Github Repository with the contents of the ai-lab sample chatbot application. It must be either the 'redhat-ai-dev/ai-lab-samples' or its fork. If blank it defaults to 'redhat-ai-dev/ai-lab-samples'.",
                     "default": "redhat-ai-dev/ai-lab-samples"
                 },
                 "gitDefaultBranch": {

Diff for: charts/ai-software-templates/chatbot/0.1.0/README.md renamed to charts/ai-software-templates/chatbot/README.md

@@ -4,7 +4,7 @@ The OpenShift Pipelines configuration is a requirement in order to support CI/CD
 
 1. Install the [Openshift Pipelines Operator](https://docs.redhat.com/en/documentation/openshift_container_platform/4.6/html/pipelines/installing-pipelines#installing-pipelines).
 
-2. Ensure that the `pipeline-as-code-controller` is up by getting its route:
+2. Ensure that the `pipeline-as-code-controller` is up by getting its route.
 
 ```
 kubectl get route -n openshift-pipelines pipelines-as-code-controller

Diff for: charts/ai-software-templates/chatbot/0.1.0/templates/NOTES.txt renamed to charts/ai-software-templates/chatbot/templates/NOTES.txt

@@ -0,0 +1,45 @@
+## Testing with a Custom Helm Repository
+
+To setup a custom Helm repository on your fork and be able to import and test the `ai-lab-helm-charts` repo on your OCP cluster, you can follow the steps below:
+
+### Setup gh-pages
+
+- Create a new branch (`gh-pages` could be a good candidate) in your fork.
+
+- Go to your fork's `settings` > `Pages` > `Build and Deployment`.
+
+- Select `Deploy from a branch` & choose your new as the branch we will be deploying from.
+
+### Add Helm Package and Index
+
+- Package the Helm chart you want to test:
+
+```
+# from project root dir
+helm package <path-of-the-helm-chart-dir>
+
+# example
+helm package charts/ai-software-templates/chatbot/
+```
+
+- Create the `index.yaml`:
+
+```
+# from project root dir
+helm repo index .
+```
+
+- Push to your branch. A deployment will start after the push event.
+
+- On your OCP cluster you can create a custom Helm repo by applying this yaml file:
+
+```
+apiVersion: helm.openshift.io/v1beta1
+kind: HelmChartRepository
+metadata:
+  name: 'ai-lab-helm-charts'
+spec:
+  connectionConfig:
+    url: '<your-gh-pages-url>'
+
+```