chore: Update readme-generator (#466)

ngrok · Oct 24, 2024 · efaa247 · efaa247
1 parent 0fde978
commit efaa247
Show file tree

Hide file tree

Showing 2 changed files with 1 addition and 10 deletions.
diff --git a/.github/workflows/generate-chart-readme.yaml b/.github/workflows/generate-chart-readme.yaml
@@ -15,7 +15,7 @@ jobs:
     timeout-minutes: 10
     steps:
       - name: Install readme-generator-for-helm
-        run: npm install -g @bitnami/readme-generator-for-helm@2.4.2
+        run: npm install -g @bitnami/readme-generator-for-helm@2.6.1
       - name: Checkout repo
         uses: actions/checkout@v3
         with:

diff --git a/helm/ngrok-operator/README.md b/helm/ngrok-operator/README.md
@@ -43,7 +43,6 @@ To uninstall the chart:
 | `commonLabels`      | Labels to add to all deployed objects                              | `{}`                                      |
 | `commonAnnotations` | Annotations to add to all deployed objects                         | `{}`                                      |
 
-
 ### Image configuration
 
 | Name                | Description                                                                       | Value                  |
@@ -54,7 +53,6 @@ To uninstall the chart:
 | `image.pullPolicy`  | The ngrok operator image pull policy.                                             | `IfNotPresent`         |
 | `image.pullSecrets` | An array of imagePullSecrets to be used when pulling the image.                   | `[]`                   |
 
-
 ### ngrok configuration
 
 | Name            | Description                                                                                                           | Value               |
@@ -67,7 +65,6 @@ To uninstall the chart:
 | `ngrokMetadata` | This is a map of key=value,key=value pairs that will be added as metadata to all ngrok api resources created          | `{}`                |
 | `clusterDomain` | Configure the default cluster base domain for your kubernetes cluster DNS resolution                                  | `svc.cluster.local` |
 
-
 ### Operator Manager parameters
 
 | Name                                 | Description                                                                               | Value   |
@@ -95,7 +92,6 @@ To uninstall the chart:
 | `serviceAccount.name`                | The name of the ServiceAccount to use.                                                    | `""`    |
 | `serviceAccount.annotations`         | Additional annotations to add to the ServiceAccount                                       | `{}`    |
 
-
 ### Logging configuration
 
 | Name                  | Description                                                   | Value   |
@@ -104,7 +100,6 @@ To uninstall the chart:
 | `log.stacktraceLevel` | The level to report stacktrace logs one of 'info' or 'error'. | `error` |
 | `log.format`          | The log format to use. One of console, json.                  | `json`  |
 
-
 ### Credentials configuration
 
 | Name                      | Description                                                                                                           | Value |
@@ -113,7 +108,6 @@ To uninstall the chart:
 | `credentials.apiKey`      | Your ngrok API key. If provided, it will be will be written to the secret and the authtoken must be provided as well. | `""`  |
 | `credentials.authtoken`   | Your ngrok authtoken. If provided, it will be will be written to the secret and the apiKey must be provided as well.  | `""`  |
 
-
 ### Kubernetes Ingress feature configuration
 
 | Name                           | Description                                                     | Value                              |
@@ -130,7 +124,6 @@ To uninstall the chart:
 | `ingress.watchNamespace`       | The namespace to watch for ingress resources (default all)      | `""`                               |
 | `ingress.controllerName`       | The name of the controller to look for matching ingress classes | `k8s.ngrok.com/ingress-controller` |
 
-
 ### Agent configuration
 
 | Name                               | Description                                                         | Value  |
@@ -141,15 +134,13 @@ To uninstall the chart:
 | `agent.serviceAccount.name`        | The name of the ServiceAccount to use for the agent.                | `""`   |
 | `agent.serviceAccount.annotations` | Additional annotations to add to the agent ServiceAccount           | `{}`   |
 
-
 ### Kubernetes Gateway feature configuration
 
 | Name                        | Description                              | Value   |
 | --------------------------- | ---------------------------------------- | ------- |
 | `useExperimentalGatewayApi` | DEPRECATED: Use gateway.enabled instead  |         |
 | `gateway.enabled`           | When true, enable the Gateway controller | `false` |
 
-
 ### Kubernetes Bindings feature configuration
 
 | Name                          | Description                                                                          | Value                       |