Merge pull request #407 from percona/EVEREST-1513-ci-docs-check

EVEREST-1513 | [CI] Add step to PR check to ensure generated docs are up-to-date

.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/[email protected]

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"

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

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.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.
 
+## Maintainers
+
+| Name | Email | Url |
+| ---- | ------ | --- |
+| mayankshah1607 | <[email protected]> |  |
+| oksana-grishchenko | <[email protected]> |  |
+| recharte | <[email protected]> |  |
+| michal-kralik | <[email protected]> |  |
+
 ----------------------------------------------
 Autogenerated from chart metadata using [helm-docs v1.9.1](https://github.com/norwoodj/helm-docs/releases/v1.9.1)

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"

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 | <[email protected]> |  |
+| oksana-grishchenko | <[email protected]> |  |
+| recharte | <[email protected]> |  |
+| michal-kralik | <[email protected]> |  |
+
 ## Requirements
 
 | Repository | Name | Version |
 |------------|------|---------|
-| file://../common | common | 0.0.1 |
+| file://../common | common | 0.0.* |
 
 ## Values