From 5b614f7d3573d4854e25f6608d38d5e1e705c0e5 Mon Sep 17 00:00:00 2001 From: Kaushal Vora Date: Mon, 13 May 2024 15:35:55 +0530 Subject: [PATCH] Updated workflow to ignore readme file --- .github/workflows/chart-release.yaml | 2 ++ README.md | 25 +++++++++++++++++-------- 2 files changed, 19 insertions(+), 8 deletions(-) diff --git a/.github/workflows/chart-release.yaml b/.github/workflows/chart-release.yaml index 7a8578c..8d8556a 100644 --- a/.github/workflows/chart-release.yaml +++ b/.github/workflows/chart-release.yaml @@ -4,6 +4,8 @@ on: push: branches: - main + paths-ignore: + - '**/README.md' jobs: release: diff --git a/README.md b/README.md index 6ff4e19..3f5eb2c 100644 --- a/README.md +++ b/README.md @@ -12,14 +12,23 @@ Nopo11y is a collection of multiple open-source components charts. It includes f - kiali-server v1.83.0 - jaeger v1.0.0 -# How to configure? +# Usage -All the sub-charts have their configuration with documentation in `values.yaml` file. +[Helm](https://helm.sh) must be installed to use the charts. Please refer to +Helm's [documentation](https://helm.sh/docs) to get started. -# How to install? +Once Helm has been set up correctly, add the repo as follows: -1. Update the `values.yaml` file as per your requirement. -2. Install the chart using below command, -```bash -helm upgrade --install nopo11y-stack . -n -``` \ No newline at end of file + helm repo add https://.github.io/helm-charts + +If you had already added this repo earlier, run `helm repo update` to retrieve +the latest versions of the packages. You can then run `helm search repo +` to see the charts. + +To install the chart: + + helm install my- / + +To uninstall the chart: + + helm delete my- \ No newline at end of file