Merge pull request #1331 from consideRatio/pr/add-json-schema

Add schema.yaml for helm3 compliant chart validation

Author: yuvipanda

.github/workflows/publish.yml

@@ -80,4 +80,5 @@ jobs:
         env:
           GITHUB_REPOSITORY: "${{ github.repository }}"
         run: |
+          ./tools/generate-json-schema.py
           ./ci/publish

.github/workflows/test.yml

@@ -102,6 +102,17 @@ jobs:
             (cd helm-chart && chartpress)
             git --no-pager diff --color=always
 
+      - name: Generate values.schema.json from schema.yaml
+        if: matrix.test == 'helm'
+        run: |
+          tools/generate-json-schema.py
+
+      - name: "Helm template --validate (with lint-and-validate-values.yaml)"
+        if: matrix.test == 'helm'
+        run: |
+          helm template --validate binderhub-test helm-chart/binderhub \
+              --values tools/templates/lint-and-validate-values.yaml
+
       - name: Validate the chart against the k8s API
         if: matrix.test == 'helm'
         run: |

dev-requirements.txt

@@ -3,6 +3,7 @@ chartpress==1.0.*
 click
 codecov
 html5lib
+jsonschema
 jupyterhub
 pytest
 pytest-asyncio

helm-chart/.gitignore

@@ -1,3 +1,5 @@
+binderhub/values.schema.json
+
 ### macOS ###
 *.DS_Store
 .AppleDouble

helm-chart/binderhub/.helmignore

@@ -1,3 +1,13 @@
+# Anything within the root folder of the Helm chart, where Chart.yaml resides,
+# will be embedded into the packaged Helm chart. This is reasonable since only
+# when the templates render after the chart has been packaged and distributed,
+# will the templates logic evaluate that determines if other files were
+# referenced, such as our our files/hub/jupyterhub_config.py.
+#
+# Here are files that we intentionally ignore to avoid them being packaged,
+# because we don't want to reference them from our templates anyhow.
+schema.yaml
+
 # Patterns to ignore when building packages.
 # This supports shell glob matching, relative path matching, and
 # negation (prefixed with !). Only one pattern per line.