Update README.md and trigger build for testing add linter (#12)

Signed-off-by: Nicholas Walter Knize <[email protected]>

.github/workflows/lint-test.yaml

@@ -0,0 +1,52 @@
+# See https://github.com/helm/chart-testing-action
+name: Lint and Test Charts
+
+on: [pull_request, workflow_dispatch]
+
+jobs:
+  lint-test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        k8s: ["1.19.16", "1.21.14", "1.22.9", "1.23.12", "1.24.7", "1.25.2"]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Install Helm
+        uses: azure/[email protected]
+        # as of 2022/12 the set-output still not fixed in this action
+        # https://github.com/Azure/setup-helm/issues/103
+        with:
+          version: v3.7.0
+
+      - uses: actions/setup-python@v2
+        with:
+          python-version: '3.8'
+
+      - name: Install chart-testing
+        uses: helm/[email protected]
+
+      - name: Run chart-testing (list-changed)
+        id: list-changed
+        run: |
+          changed=$(ct list-changed --config ct.yaml)
+          if [[ -n "$changed" ]]; then
+            echo "CHART_CHANGED=true" >> $GITHUB_ENV
+          fi
+
+      - name: Run chart-testing (lint)
+        run: ct lint --config ct.yaml
+
+      - name: Create kind cluster
+        uses: helm/[email protected]
+        with:
+          node_image: kindest/node:v${{ matrix.k8s }}
+          kubectl_version: v${{ matrix.k8s }}
+        if: ${{ env.CHART_CHANGED == 'true' }}
+
+      # See https://github.com/helm/chart-testing/blob/main/doc/ct_install.md
+      - name: Run chart-testing (install)
+        run: ct install --config ct.yaml --debug

README.md

@@ -1,3 +1,11 @@
+<img src="https://lucenia.io/wp-content/uploads/2024/07/Asset_38Lucenia_H_LB_NS.png" height="84px">
+
+- [Lucenia Helm-Charts](#lucenia-helm-charts)
+- [Status](#status)
+- [Version and Branching](#version-and-branching)
+- [Installation](#installation)
+
+
 # Lucenia Helm Charts
 
 This repository contains the Helm charts for Lucenia's products.
@@ -6,6 +14,48 @@ This repository contains the Helm charts for Lucenia's products.
 
 The [Lucenia Helm chart](./lucenia) defines resources for deploying Lucenia on Kubernetes. See the [Lucenia documentation](./lucenia/README.md) and [values](./lucenia/values.yaml) for more information on configuring and deploying Lucenia.
 
+## Status
+
+[![Lint and Test Charts](https://github.com/lucenia/helm-charts/actions/workflows/lint-test.yaml/badge.svg)](https://github.com/lucenia/helm-charts/actions/workflows/lint-test.yaml)
+ [![Release Charts](https://github.com/lucenia/helm-charts/actions/workflows/release.yaml/badge.svg)](https://github.com/lucenia/helm-charts/actions/workflows/release.yaml)
+
+## Version and Branching
+As of now, this helm-charts repository maintains two branches:
+* _main_ (Version is 0.x.x for both `version` and `appVersion` in `Chart.yaml`)
+* _gh-pages_ (Reserved branch for publishing helm-charts through github pages)
+<br>
+
+Contributors should choose the corresponding branch(es) when commiting their change(s):
+* If you have a change for a specific version, only open PR to specific branch
+* If you have a change for all available versions, first open a PR on `main`, then open a backport PR with `[backport 1.x]` in the title, with label `backport 1.x`, etc.
+* No changes should be commited to `gh-pages` by any contributor, as this branch should be only changed by github actions `chart-releaser` 
+
+## Kubernetes Version Support
+* This helm-chart repository is tested with kubernetes version 1.19 and above
+
+## Installation
+
+To install the Lucene Helm charts, execute the following commands:
+
+```shell
+helm repo add lucenia https://lucenia.github.io/helm-charts/
+helm repo update
+```
+
+Once the charts repository reference is added, you can run the following command to see the charts.
+
+```shell
+helm search repo lucenia
+```
+
+You can now deploy charts with this command.
+
+```shell
+helm install my-deployment lucenia/<chart name>
+```
+
+Please see the `README.md` in the [Lucenia](charts/lucenia) directory for installation instructions.
+
 ## Kafka
 
 Kafka can be accessed by consumers via port 9092 on the following DNS name from within your cluster:

charts/lucenia/Chart.yaml

@@ -17,7 +17,7 @@ type: application
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
 version: 0.1.0
 
-# This is the version number of the application being deployed. This version number should be
+# This is the version number of Lucenia being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to
 # follow Semantic Versioning. They should reflect the version the application is using.
 # It is recommended to use it with quotes.

ct.yaml

@@ -0,0 +1,3 @@
+# See https://github.com/helm/chart-testing#configuration
+target-branch: main
+helm-extra-args: --timeout 1000s