feat: update helm-docs workflow

.github/helm-docs/_templates.gotmpl

@@ -0,0 +1,10 @@
+{{ define "extra.installation" -}}
+
+## Installation
+
+```bash
+helm repo add nethermind https://nethermindeth.github.io/charts
+helm install {{ template "chart.name" . }} nethermind/{{ template "chart.name" . }}
+```
+
+{{- end }}

.github/workflows/helm-docs.yaml

@@ -1,26 +1,30 @@
-name: Helm Docs Check
+name: Helm Docs
 
 on: pull_request
 
+permissions:
+  contents: write
+  pull-requests: write
+
 jobs:
-  helm-docs-validation:
+  helm-docs:
     runs-on: ubuntu-latest
-
     steps:
       - name: Checkout repository
         uses: actions/checkout@v3
+        with:
+          persist-credentials: false # otherwise, the token used is the GITHUB_TOKEN, instead of your personal token
+          fetch-depth: 0
 
       - name: Set up Docker
         uses: docker/setup-buildx-action@v2
 
       - name: Run helm-docs
-        run: docker run --rm --volume "$(pwd):/helm-docs" -u "$(id -u)" jnorwood/helm-docs:latest
+        run: docker run --rm --volume "$(pwd):/helm-docs" -u "$(id -u)" jnorwood/helm-docs:v1.14.2 --chart-search-root=. --template-files=./.github/helm-docs/_templates.gotmpl --template-files=README.md.gotmpl
 
-      - name: Check for unstaged changes
-        run: |
-          if [ -n "$(git status --porcelain)" ]; then
-            echo "Unstaged changes detected. Please update the Helm chart documentation in your PR."
-            exit 1
-          else
-            echo "No unstaged changes detected. Documentation is up-to-date."
-          fi
+      - name: Commit & Push changes
+        uses: actions-js/push@master
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          branch: ${{ github.event.pull_request.head.ref }}
+          message: "docs: auto-generate chart docs"

CONTRIBUTING.md

@@ -11,10 +11,12 @@ When contributing to this repository, please first discuss the change you wish t
 1. Create a new branch from `main`.
 2. Make changes to a single chart in the `charts/` directory only (CI will fail if you try to update more than one chart).
 3. Update the chart version in the `Chart.yaml` file, along with any other changes you want to make. Mind the [semantic versioning](https://semver.org/) rules.
-4. Run `make docs` to update the `README.md` file using the `helm-docs` tool.
-5. Run `make lint` to lint the chart.
-6. Push your changes and create a pull request. The pull request should include a description of the changes made and the reason for the changes. The pull request title must follow the `[<chart-name>] <short-description>` format.
-7. The pull request will be reviewed by the maintainers. If the pull request is approved, it will be merged into the `main` branch and new chart version will be released with tag `<chart-name>-<chart-version>`.
+4. Run `make lint` to lint the chart.
+5. Push your changes and create a pull request. The pull request should include a description of the changes made and the reason for the changes. The pull request title must follow the `[<chart-name>] <short-description>` format.
+6. The pull request will be reviewed by the maintainers. If the pull request is approved, it will be merged into the `main` branch and new chart version will be released with tag `<chart-name>-<chart-version>`.
+
+> [!NOTE]
+> Documentation is automatically generated and pushed to the Pull Request head branch.
 
 ## Branch Naming
 

charts/aztec-prover/README.md

@@ -1,3 +1,4 @@
+
 # aztec-prover
 
 ![Version: 0.1.1](https://img.shields.io/badge/Version-0.1.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)

charts/cert-manager/README.md

@@ -1,3 +1,4 @@
+
 # cert-manager
 
 ![Version: v1.12.4](https://img.shields.io/badge/Version-v1.12.4-informational?style=flat-square) ![AppVersion: v1.12.4](https://img.shields.io/badge/AppVersion-v1.12.4-informational?style=flat-square)
@@ -185,4 +186,4 @@ Kubernetes: `>= 1.22.0-0`
 | webhook.volumes | list | `[]` |  |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.12.0](https://github.com/norwoodj/helm-docs/releases/v1.12.0)
+Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)

charts/common/README.md

@@ -1,3 +1,4 @@
+
 # common
 
 ![Version: 1.0.1](https://img.shields.io/badge/Version-1.0.1-informational?style=flat-square) ![Type: library](https://img.shields.io/badge/Type-library-informational?style=flat-square) ![AppVersion: 1.0.0](https://img.shields.io/badge/AppVersion-1.0.0-informational?style=flat-square)
@@ -18,4 +19,4 @@ A Library Helm Chart for grouping common logic between stakewise charts. This ch
 | exampleValue | string | `"common-chart"` |  |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.12.0](https://github.com/norwoodj/helm-docs/releases/v1.12.0)
+Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)

charts/dirk/README.md

@@ -1,3 +1,4 @@
+
 # dirk
 
 ![Version: 1.1.1](https://img.shields.io/badge/Version-1.1.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v22.10.0](https://img.shields.io/badge/AppVersion-v22.10.0-informational?style=flat-square)
@@ -89,4 +90,4 @@ A Helm chart for installing and configuring large scale ETH staking infrastructu
 | tolerations | object | `{}` | Tolerations for pod assignment ref: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/  |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.12.0](https://github.com/norwoodj/helm-docs/releases/v1.12.0)
+Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)

charts/ethereum-node/README.md

@@ -1,3 +1,4 @@
+
 # ethereum-node
 
 ![Version: 0.0.20](https://img.shields.io/badge/Version-0.0.20-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
@@ -87,4 +88,4 @@ This chart acts as an umbrella chart and allows to run a ethereum execution and
 | prysm.resources.requests.memory | string | `"2Gi"` |  |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.12.0](https://github.com/norwoodj/helm-docs/releases/v1.12.0)
+Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)

charts/ethereum-node/charts/nethermind/README.md

@@ -1,4 +1,5 @@
 
+
 # nethermind
 
 ![Version: 1.0.9](https://img.shields.io/badge/Version-1.0.9-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)

charts/ethereum-node/charts/prysm/README.md

@@ -1,4 +1,5 @@
 
+
 # prysm
 
 ![Version: 1.1.1](https://img.shields.io/badge/Version-1.1.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)

charts/execution-beacon/README.md

@@ -1,3 +1,4 @@
+
 # execution-beacon
 
 ![Version: 1.1.0](https://img.shields.io/badge/Version-1.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.0.1](https://img.shields.io/badge/AppVersion-0.0.1-informational?style=flat-square)
@@ -201,4 +202,4 @@ Kubernetes: `^1.23.0-0`
 | serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template  |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.12.0](https://github.com/norwoodj/helm-docs/releases/v1.12.0)
+Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)

charts/external-dns/README.md

@@ -1,3 +1,4 @@
+
 # external-dns
 
 ![Version: 1.13.1](https://img.shields.io/badge/Version-1.13.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.13.5](https://img.shields.io/badge/AppVersion-0.13.5-informational?style=flat-square)
@@ -101,4 +102,4 @@ ExternalDNS synchronizes exposed Kubernetes Services and Ingresses with DNS prov
 | txtSuffix | string | `""` |  |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.12.0](https://github.com/norwoodj/helm-docs/releases/v1.12.0)
+Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)

charts/juno-node/README.md

@@ -1,3 +1,4 @@
+
 # juno-chart
 
 ![Version: 0.1.5](https://img.shields.io/badge/Version-0.1.5-informational?style=flat-square) ![AppVersion: 1](https://img.shields.io/badge/AppVersion-1-informational?style=flat-square)
@@ -27,17 +28,24 @@ A Helm chart for deploying Juno service
 | args.--ws | string | `"true"` |  |
 | args.--ws-host | string | `"0.0.0.0"` |  |
 | args.--ws-port | string | `"6061"` |  |
-| backupJunoDataJob.backupSchedule | string | `"*/20 * * * *"` |  |
-| backupJunoDataJob.cleanupSchedule | string | `"*/40 * * * *"` |  |
+| backupJunoDataJob.backupSchedule | string | `"0 3 * * *"` |  |
+| backupJunoDataJob.bucketName | string | `"juno-snapshot"` |  |
+| backupJunoDataJob.cleanupSchedule | string | `"0 10 * * *"` |  |
 | backupJunoDataJob.dataSource | string | `"juno-sepolia-pv-ssd-juno-sepolia-0"` |  |
+| backupJunoDataJob.enableRetention | bool | `false` |  |
 | backupJunoDataJob.enabled | bool | `true` |  |
-| backupJunoDataJob.endpoint | string | `"https://12345543.r2.cloudflarestorage.com"` |  |
-| backupJunoDataJob.key | string | `"key-1234"` |  |
+| backupJunoDataJob.junoFreeEndpoint | string | `"https://free-rpc-staging.nethermind.dev"` |  |
 | backupJunoDataJob.network | string | `"sepolia"` |  |
-| backupJunoDataJob.secret | string | `"secret-12345"` |  |
-| backupJunoDataJob.storageSize | string | `"200Gi"` |  |
+| backupJunoDataJob.retentionLimit | int | `10` |  |
+| backupJunoDataJob.storageSize | string | `"250Gi"` |  |
 | batchjob.enabled | bool | `false` |  |
 | batchjob.schedule | string | `"* */1 * * *"` |  |
+| cache.enabled | bool | `false` |  |
+| cache.image | string | `"us-east1-docker.pkg.dev/juno-stg-nth/juno-cache/cache:2.0"` |  |
+| cache.resources.limits.cpu | string | `"100m"` |  |
+| cache.resources.limits.memory | string | `"512Mi"` |  |
+| cache.resources.requests.cpu | string | `"100m"` |  |
+| cache.resources.requests.memory | string | `"100Mi"` |  |
 | deployment.healthCheck.enabled | bool | `false` |  |
 | deployment.healthCheck.livenessProbe.failureThreshold | int | `6` |  |
 | deployment.healthCheck.livenessProbe.initialDelaySeconds | int | `9600` |  |
@@ -78,18 +86,27 @@ A Helm chart for deploying Juno service
 | pgo.resources.limits.memory | string | `"4Gi"` |  |
 | pgo.resources.requests.cpu | string | `"1"` |  |
 | pgo.resources.requests.memory | string | `"2Gi"` |  |
-| cache.enabled | bool | `false` |  |
-| cache.image | string | `"us-east1-docker.pkg.dev/juno-stg-nth/juno-cache/cache:2.0"` |  |
-| cache.resources.limits.cpu | string | `"100m"` |  |
-| cache.resources.limits.memory | string | `"512Mi"` |  |
-| cache.resources.requests.cpu | string | `"100m"` |  |
-| cache.resources.requests.memory | string | `"100Mi"` |  |
 | pvc.datasource | string | `""` |  |
 | pvc.enabled | bool | `true` |  |
 | pvc.mount[0].mountPath | string | `"/var/lib/juno"` |  |
 | pvc.mount[0].pvName | string | `"pv"` |  |
 | pvc.mount[0].storageSize | string | `"250Gi"` |  |
 | pvc.storageClassName | string | `"standard"` |  |
+| secret.data.dataFromKey | string | `"secret-store"` |  |
+| secret.data.refreshInterval | string | `"10m"` |  |
+| secret.data.secretStoreKind | string | `"ClusterSecretStore"` |  |
+| secret.data.secretStoreName | string | `"juno-store"` |  |
+| secret.data.targetCreationPolicy | string | `"Owner"` |  |
+| secret.data.targetName | string | `"juno-sepolia-common"` |  |
+| secret.feederGateway.key | string | `"feeder-gateway"` |  |
+| secret.feederGateway.property | string | `"testnet"` |  |
+| secret.feederGateway.refreshInterval | string | `"10m"` |  |
+| secret.feederGateway.secretKey | string | `"testnet"` |  |
+| secret.feederGateway.secretStoreKind | string | `"ClusterSecretStore"` |  |
+| secret.feederGateway.secretStoreName | string | `"juno-store"` |  |
+| secret.feederGateway.targetCreationPolicy | string | `"Owner"` |  |
+| secret.feederGateway.targetName | string | `"juno-goerli"` |  |
+| secret.feederGateway.version | string | `"1"` |  |
 | serviceAccount.enabled | bool | `false` |  |
 | serviceAccount.gcpServiceAccount | string | `"[email protected]"` |  |
 | serviceAccount.name | string | `"juno-pgo"` |  |
@@ -165,4 +182,4 @@ A Helm chart for deploying Juno service
 | taintsToleration.tolerations.network | string | `"juno"` |  |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
+Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)

charts/kong/README.md

@@ -1,3 +1,4 @@
+
 # kong
 
 ![Version: 2.26.6](https://img.shields.io/badge/Version-2.26.6-informational?style=flat-square) ![AppVersion: 3.3](https://img.shields.io/badge/AppVersion-3.3-informational?style=flat-square)
@@ -267,4 +268,4 @@ The Cloud-Native Ingress and API-management
 | waitImage | object | `{"enabled":true,"pullPolicy":"IfNotPresent"}` | --------------------------------------------------------------------------- |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.12.0](https://github.com/norwoodj/helm-docs/releases/v1.12.0)
+Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)

charts/kube-prometheus-stack/README.md

@@ -1,3 +1,4 @@
+
 # kube-prometheus-stack
 
 ![Version: 48.4.1](https://img.shields.io/badge/Version-48.4.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v0.66.0](https://img.shields.io/badge/AppVersion-v0.66.0-informational?style=flat-square)
@@ -1002,4 +1003,4 @@ Kubernetes: `>=1.16.0-0`
 | windowsMonitoring.job | string | `"prometheus-windows-exporter"` |  |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.12.0](https://github.com/norwoodj/helm-docs/releases/v1.12.0)
+Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)

charts/lodestar/README.md

@@ -1,3 +1,4 @@
+
 # lodestar
 
 ![Version: 0.1.2](https://img.shields.io/badge/Version-0.1.2-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
@@ -11,7 +12,7 @@ A Helm chart to deploy the Lodestar Consensus Client using Kubernetes
 | matilote |  |  |
 | aivarasko |  |  |
 | stdevMac |  |  |
-| refl3ction |  |  |
+| 0xDones |  |  |
 
 ## Values
 

charts/loki/README.md

@@ -1,3 +1,4 @@
+
 # loki
 
 ![Version: 2.11.2](https://img.shields.io/badge/Version-2.11.2-informational?style=flat-square) ![AppVersion: v2.5.0](https://img.shields.io/badge/AppVersion-v2.5.0-informational?style=flat-square)
@@ -137,4 +138,4 @@ Kubernetes: `^1.10.0-0`
 | useExistingAlertingGroup.enabled | bool | `false` |  |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.12.0](https://github.com/norwoodj/helm-docs/releases/v1.12.0)
+Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)

charts/mev-boost/README.md

@@ -1,3 +1,4 @@
+
 # mev-boost
 
 ![Version: 1.0.2](https://img.shields.io/badge/Version-1.0.2-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.7.1](https://img.shields.io/badge/AppVersion-1.7.1-informational?style=flat-square)

charts/mysql/README.md

@@ -1,3 +1,4 @@
+
 # my-mysql-chart
 
 ![Version: 1.0.1](https://img.shields.io/badge/Version-1.0.1-informational?style=flat-square) ![AppVersion: 5.7](https://img.shields.io/badge/AppVersion-5.7-informational?style=flat-square)
@@ -22,4 +23,4 @@ A Helm chart for deploying MySQL with StatefulSet, Service, Secret, and PVC.
 | storageSize | string | `"100Gi"` |  |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.12.0](https://github.com/norwoodj/helm-docs/releases/v1.12.0)
+Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)