From e56f9425d30b554a76184bcccb3be2471967e00b Mon Sep 17 00:00:00 2001 From: Mayank Shah Date: Thu, 31 Oct 2024 16:22:29 +0530 Subject: [PATCH 1/5] add step to ensure docs are up-to-date Signed-off-by: Mayank Shah --- .github/workflows/everest-pr-checks.yaml | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/.github/workflows/everest-pr-checks.yaml b/.github/workflows/everest-pr-checks.yaml index 1b4792bc..be75c12a 100644 --- a/.github/workflows/everest-pr-checks.yaml +++ b/.github/workflows/everest-pr-checks.yaml @@ -11,6 +11,20 @@ jobs: uses: actions/checkout@v4 with: fetch-depth: 0 + sparse-checkout: | + .github/ + charts/everest + + - name: Check docs + run: | + cd charts/everest + make docs-gen + if git diff --quiet; then + echo "Docs are up to date." + else + echo "Docs are out of date. Please run 'make docs-gen' and commit the changes." + exit 1 + fi - name: Set up Helm uses: azure/setup-helm@v4.2.0 From 9a277d564d3f48ffb3e608e165f68b6b9ad6731c Mon Sep 17 00:00:00 2001 From: Mayank Shah Date: Thu, 31 Oct 2024 16:26:05 +0530 Subject: [PATCH 2/5] test commit Signed-off-by: Mayank Shah --- charts/everest/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/charts/everest/README.md b/charts/everest/README.md index ad776d47..36ff9e86 100644 --- a/charts/everest/README.md +++ b/charts/everest/README.md @@ -1,5 +1,6 @@ # Percona Everest +###### This helm chart deploys Percona Everest. Useful links: From a2164d0b9c7ec5fd99cec9f971dc2da74cb6a3f7 Mon Sep 17 00:00:00 2001 From: Mayank Shah Date: Thu, 31 Oct 2024 16:26:59 +0530 Subject: [PATCH 3/5] Update docs Signed-off-by: Mayank Shah --- charts/everest/README.md | 1 - charts/everest/charts/common/README.md | 11 ++++++++++- charts/everest/charts/everest-db-namespace/README.md | 11 ++++++++++- 3 files changed, 20 insertions(+), 3 deletions(-) diff --git a/charts/everest/README.md b/charts/everest/README.md index 36ff9e86..ad776d47 100644 --- a/charts/everest/README.md +++ b/charts/everest/README.md @@ -1,6 +1,5 @@ # Percona Everest -###### This helm chart deploys Percona Everest. Useful links: diff --git a/charts/everest/charts/common/README.md b/charts/everest/charts/common/README.md index 79cf2f7f..40208e92 100644 --- a/charts/everest/charts/common/README.md +++ b/charts/everest/charts/common/README.md @@ -1,8 +1,17 @@ # common -![Version: 0.0.1](https://img.shields.io/badge/Version-0.0.1-informational?style=flat-square) ![Type: library](https://img.shields.io/badge/Type-library-informational?style=flat-square) ![AppVersion: 0.0.1](https://img.shields.io/badge/AppVersion-0.0.1-informational?style=flat-square) +![Version: 0.0.2](https://img.shields.io/badge/Version-0.0.2-informational?style=flat-square) ![Type: library](https://img.shields.io/badge/Type-library-informational?style=flat-square) ![AppVersion: 0.0.2](https://img.shields.io/badge/AppVersion-0.0.2-informational?style=flat-square) A library chart for Everest containing common resources. +## Maintainers + +| Name | Email | Url | +| ---- | ------ | --- | +| mayankshah1607 | | | +| oksana-grishchenko | | | +| recharte | | | +| michal-kralik | | | + ---------------------------------------------- Autogenerated from chart metadata using [helm-docs v1.9.1](https://github.com/norwoodj/helm-docs/releases/v1.9.1) diff --git a/charts/everest/charts/everest-db-namespace/README.md b/charts/everest/charts/everest-db-namespace/README.md index f3261bf9..e1c7d33d 100644 --- a/charts/everest/charts/everest-db-namespace/README.md +++ b/charts/everest/charts/everest-db-namespace/README.md @@ -4,11 +4,20 @@ A sub-chart for provisioning Everest DB namespaces. +## Maintainers + +| Name | Email | Url | +| ---- | ------ | --- | +| mayankshah1607 | | | +| oksana-grishchenko | | | +| recharte | | | +| michal-kralik | | | + ## Requirements | Repository | Name | Version | |------------|------|---------| -| file://../common | common | 0.0.1 | +| file://../common | common | 0.0.* | ## Values From b6f61acdae398c1ed6a2b5a9f10f9a55ed2ed71f Mon Sep 17 00:00:00 2001 From: Mayank Shah Date: Thu, 31 Oct 2024 16:32:32 +0530 Subject: [PATCH 4/5] bump version Signed-off-by: Mayank Shah --- charts/everest/Chart.lock | 6 +++--- charts/everest/charts/common/Chart.yaml | 2 +- charts/everest/charts/everest-db-namespace/Chart.lock | 6 +++--- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/charts/everest/Chart.lock b/charts/everest/Chart.lock index fed704e9..f52847fd 100644 --- a/charts/everest/Chart.lock +++ b/charts/everest/Chart.lock @@ -1,9 +1,9 @@ dependencies: - name: common repository: file://charts/common - version: 0.0.2 + version: 0.0.3 - name: everest-db-namespace repository: file://charts/everest-db-namespace version: 0.0.0 -digest: sha256:c640ee1595ced2f8d4024f9f37b38d6ca685bc4edba9d451f9bcd56edc22ee23 -generated: "2024-10-31T11:35:48.801214+05:30" +digest: sha256:99b7426a3f8df9d34dbdc6be2934e6bbde5351b5aa8f0ce4ce78ec18451c8b55 +generated: "2024-10-31T16:32:12.88258+05:30" diff --git a/charts/everest/charts/common/Chart.yaml b/charts/everest/charts/common/Chart.yaml index 34b1a033..75273147 100644 --- a/charts/everest/charts/common/Chart.yaml +++ b/charts/everest/charts/common/Chart.yaml @@ -2,7 +2,7 @@ apiVersion: v2 name: common description: A library chart for Everest containing common resources. type: library -version: 0.0.2 +version: 0.0.3 appVersion: "0.0.2" maintainers: - name: mayankshah1607 diff --git a/charts/everest/charts/everest-db-namespace/Chart.lock b/charts/everest/charts/everest-db-namespace/Chart.lock index eb50b79f..207a34a2 100644 --- a/charts/everest/charts/everest-db-namespace/Chart.lock +++ b/charts/everest/charts/everest-db-namespace/Chart.lock @@ -1,6 +1,6 @@ dependencies: - name: common repository: file://../common - version: 0.0.2 -digest: sha256:e26bbcf7da416e9ea599f57a116c90e4a8b38bb7293945ef17a4f5243043cd99 -generated: "2024-10-31T11:35:45.12716+05:30" + version: 0.0.3 +digest: sha256:9c473ddc333f399701ca42304b7c24defb59270a6e04d75254be0ccf6eec438a +generated: "2024-10-31T16:32:16.267628+05:30" From c829e824d44c0939673c6913b0fb511668d8012f Mon Sep 17 00:00:00 2001 From: Mayank Shah Date: Thu, 31 Oct 2024 16:35:45 +0530 Subject: [PATCH 5/5] update docs Signed-off-by: Mayank Shah --- charts/everest/charts/common/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/charts/everest/charts/common/README.md b/charts/everest/charts/common/README.md index 40208e92..5977626f 100644 --- a/charts/everest/charts/common/README.md +++ b/charts/everest/charts/common/README.md @@ -1,6 +1,6 @@ # common -![Version: 0.0.2](https://img.shields.io/badge/Version-0.0.2-informational?style=flat-square) ![Type: library](https://img.shields.io/badge/Type-library-informational?style=flat-square) ![AppVersion: 0.0.2](https://img.shields.io/badge/AppVersion-0.0.2-informational?style=flat-square) +![Version: 0.0.3](https://img.shields.io/badge/Version-0.0.3-informational?style=flat-square) ![Type: library](https://img.shields.io/badge/Type-library-informational?style=flat-square) ![AppVersion: 0.0.2](https://img.shields.io/badge/AppVersion-0.0.2-informational?style=flat-square) A library chart for Everest containing common resources.