Generate and commit schema.json file (#472)

Generate and commit values.schema.json file
ngrok · Oct 29, 2024 · 4e3428a · 4e3428a
1 parent 703b6a3
commit 4e3428a
Show file tree

Hide file tree

Showing 7 changed files with 445 additions and 17 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -10,3 +10,6 @@ api/**/zz_generated*go linguist-generated=true
 helm/ngrok-operator/templates/crds/** linguist-generated=true
 helm/ngrok-operator/templates/rbac/role.yaml linguist-generated=true
 manifest-bundle.yaml linguist-generated=true
+
+# Generated by the helm readme-generator
+helm/ngrok-operator/values.schema.json linguist-generated=true
diff --git a/.github/workflows/generate-chart-readme.yaml b/.github/workflows/generate-chart-readme.yaml
@@ -25,8 +25,8 @@ jobs:
       - name: Execute readme-generator-for-helm
         working-directory: helm/ngrok-operator
         run: |
-          readme-generator --values "values.yaml" --readme "README.md" --schema "/tmp/schema.json"
+          make update-readme
       - name: Push changes
         uses: stefanzweifel/git-auto-commit-action@v4
         with:
-          commit_message: Update README.md with readme-generator-for-helm
+          commit_message: Update README.md and values.schema.json with readme-generator-for-helm
diff --git a/helm/ngrok-operator/Makefile b/helm/ngrok-operator/Makefile
@@ -22,4 +22,4 @@ update-snapshots: ## Update helm unittest snapshots
 
 .PHONY: update-readme
 update-readme: ## Updates the README.md file with the chart values
-	readme-generator --values "values.yaml" --readme "README.md" --schema "/tmp/schema.json"
+	readme-generator --values "values.yaml" --readme "README.md" --schema "values.schema.json"
diff --git a/helm/ngrok-operator/README.md b/helm/ngrok-operator/README.md
@@ -81,8 +81,8 @@ To uninstall the chart:
 | `priorityClassName`                  | Priority class for pod scheduling                                                         | `""`    |
 | `lifecycle`                          | an object containing lifecycle configuration                                              | `{}`    |
 | `podDisruptionBudget.create`         | Enable a Pod Disruption Budget creation                                                   | `false` |
+| `podDisruptionBudget.maxUnavailable` | Maximum number/percentage of pods that may be made unavailable                            | `""`    |
 | `podDisruptionBudget.minAvailable`   | Minimum number/percentage of pods that should remain scheduled                            | `""`    |
-| `podDisruptionBudget.maxUnavailable` | Maximum number/percentage of pods that may be made unavailable                            | `1`     |
 | `resources.limits`                   | The resources limits for the container                                                    | `{}`    |
 | `resources.requests`                 | The requested resources for the container                                                 | `{}`    |
 | `extraVolumes`                       | An array of extra volumes to add to the controller.                                       | `[]`    |
@@ -102,11 +102,11 @@ To uninstall the chart:
 
 ### Credentials configuration
 
-| Name                      | Description                                                                                                           | Value |
-| ------------------------- | --------------------------------------------------------------------------------------------------------------------- | ----- |
-| `credentials.secret.name` | The name of the secret the credentials are in. If not provided, one will be generated using the helm release name.    | `""`  |
-| `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.  | `""`  |
+| Name                      | Description                                                                                                        | Value |
+| ------------------------- | ------------------------------------------------------------------------------------------------------------------ | ----- |
+| `credentials.secret.name` | The name of the secret the credentials are in. If not provided, one will be generated using the helm release name. | `""`  |
+| `credentials.apiKey`      | Your ngrok API key. If provided, it will be written to the secret and the authtoken must be provided as well.      | `""`  |
+| `credentials.authtoken`   | Your ngrok authtoken. If provided, it will be written to the secret and the apiKey must be provided as well.       | `""`  |
 
 ### Kubernetes Ingress feature configuration
 

diff --git a/helm/ngrok-operator/tests/controller-pdb_test.yaml b/helm/ngrok-operator/tests/controller-pdb_test.yaml
@@ -27,8 +27,8 @@ tests:
   set:
     podDisruptionBudget:
       create: true
-      minAvailable: 1
-      maxUnavailable: ""
+      minAvailable: "1"
+      maxUnavailable: null
   asserts:
   - equal:
       path: spec.minAvailable