feat(schema): AS-706 helm values schema

.github/workflows/pre-commit.yml

@@ -20,5 +20,7 @@ jobs:
       - name: Temporary SQLite/LZMA - Install missing libraries
         run: sudo apt install -y libsqlite3-dev libbz2-dev
       - name: install asdf & tools
-        uses: asdf-vm/actions/install@1902764435ca0dd2f3388eea723a4f92a4eb8302
+        uses: asdf-vm/actions/install@v4.0.0
+      - name: Install helm plugins
+        run: make helm-plugins
       - uses: pre-commit/action@v3.0.1

.github/workflows/test-docker-pulls.yml

@@ -27,7 +27,7 @@ jobs:
       - name: Temporary SQLite/LZMA - Install missing libraries
         run: sudo apt install -y libsqlite3-dev libbz2-dev
       - name: install asdf & tools
-        uses: asdf-vm/actions/install@1902764435ca0dd2f3388eea723a4f92a4eb8302
+        uses: asdf-vm/actions/install@v4.0.0
       - name: Login to Docker Hub
         uses: docker/login-action@v3
         with:

.github/workflows/test-docker.yml

@@ -18,7 +18,7 @@ jobs:
       - uses: actions/checkout@v4.2.2
       - uses: actions/setup-python@v5.6.0
       - name: install asdf & tools
-        uses: asdf-vm/actions/install@1902764435ca0dd2f3388eea723a4f92a4eb8302
+        uses: asdf-vm/actions/install@v4.0.0
       - name: Run unit tests
         shell: bash
         run: |
@@ -34,7 +34,7 @@ jobs:
       - name: Temporary SQLite/LZMA - Install missing libraries
         run: sudo apt install -y libsqlite3-dev libbz2-dev
       - name: install asdf & tools
-        uses: asdf-vm/actions/install@1902764435ca0dd2f3388eea723a4f92a4eb8302
+        uses: asdf-vm/actions/install@v4.0.0
       - name: Authenticate to Google Cloud
         id: auth
         uses: google-github-actions/auth@v2.1.7
@@ -71,7 +71,7 @@ jobs:
       - uses: actions/checkout@v4.2.2
       - uses: actions/setup-python@v5.6.0
       - name: install asdf & tools
-        uses: asdf-vm/actions/install@1902764435ca0dd2f3388eea723a4f92a4eb8302
+        uses: asdf-vm/actions/install@v4.0.0
       - name: Authenticate to Google Cloud
         id: auth
         uses: google-github-actions/auth@v2.1.7

.github/workflows/test-helm.yml

@@ -12,7 +12,7 @@ jobs:
       - name: Temporary SQLite/LZMA - Install missing libraries
         run: sudo apt install -y libsqlite3-dev libbz2-dev
       - name: install asdf & tools
-        uses: asdf-vm/actions/install@1902764435ca0dd2f3388eea723a4f92a4eb8302
+        uses: asdf-vm/actions/install@v4.0.0
       - name: Run unit tests
         shell: bash
         run: |

.markdownlint.yaml

@@ -4,3 +4,11 @@ default: true
 MD013:  # Line Length
   code_blocks: false
   tables: false
+
+# MD059/descriptive-link-text Link text should be descriptive
+# This rule marks things like:
+# `Example nginx configurations can be found [here](../)`
+# as errors.
+# The context comes before the link so this seems
+# like a fair rule to disable.
+MD059: false

.pre-commit-config.yaml

@@ -14,6 +14,8 @@ repos:
       - id: end-of-file-fixer
       - id: mixed-line-ending
       - id: pretty-format-json
+        # Ignore generated files
+        exclude: ^helm/fiftyone-teams-app/values.schema.json
       - id: trailing-whitespace
   - repo: https://github.com/Lucas-C/pre-commit-hooks
     rev: v1.5.5
@@ -30,11 +32,23 @@ repos:
         args:
           # Make the tool search for charts only under the `helm/fiftyone-teams-app` directory
           - --chart-search-root=helm/fiftyone-teams-app
-
           # A base filename makes it relative to each chart directory found
           - --template-files=README.md.gotmpl
+  - repo: https://github.com/dadav/helm-schema
+    rev: 0.18.1
+    hooks:
+      - id: helm-schema
+        args:
+          - --chart-search-root=./helm/fiftyone-teams-app
+          - --no-dependencies
+          - --add-schema-reference
+          - --skip-auto-generation=additionalProperties,required
+          - --append-newline
+          # This breaks type annotations
+          # - --helm-docs-compatibility-mode
+
   - repo: https://github.com/igorshubovych/markdownlint-cli
-    rev: v0.44.0
+    rev: v0.45.0
     hooks:
       - id: markdownlint
       - id: markdownlint-fix
@@ -96,7 +110,7 @@ repos:
           - --write
           - --simplify
   - repo: https://github.com/compilerla/conventional-pre-commit
-    rev: v4.1.0
+    rev: v4.2.0
     hooks:
       - id: conventional-pre-commit
         stages: [commit-msg]

CONTRIBUTING.md

@@ -32,6 +32,12 @@
         make asdf
         ```
 
+    1. Additionally, install the `helm` plugins we use:
+
+        ```shell
+        make helm-plugins
+        ```
+
 ## Quickstart to Skaffold in Minikube
 
 1. Auth with gcloud for the project `computer-vision-team`

Makefile

@@ -48,6 +48,34 @@ hooks:  ## Install git hooks (pre-commit)
 	# Install environments for all available hooks now (rather than when they are first executed)
 	@pre-commit install --install-hooks
 
+helm-plugins-diff:  ## Installs the helm diff plugin
+	@echo "Checking if helm-diff plugin is installed..."
+	@if helm plugin list | grep -qE '^\s*diff\s'; then \
+		echo "helm-diff is already installed."; \
+	else \
+		echo "Installing helm-diff plugin..."; \
+		helm plugin install https://github.com/databus23/helm-diff; \
+	fi
+
+helm-plugins-schema:  ## Installs the helm schema plugin
+	@echo "Checking if helm-schema plugin is installed..."
+	@if helm plugin list | grep -qE '^\s*schema\s'; then \
+		echo "helm-schema is already installed."; \
+	else \
+		echo "Installing helm-schema plugin..."; \
+		helm plugin install https://github.com/dadav/helm-schema; \
+	fi
+
+helm-plugins:  helm-plugins-diff helm-plugins-schema  ## Install the helm plugins we use
+
+helm-schema: ## Generates the `values.schema.json` using `helm schema`
+	@helm schema \
+		--chart-search-root=./helm/fiftyone-teams-app \
+		--no-dependencies \
+		--add-schema-reference \
+		--skip-auto-generation=additionalProperties,required \
+		--append-newline
+
 pre-commit:  ## Run pre-commit against all files
 	@pre-commit run -a