refactor: Improve code formatting (#283)

Author: pantierra

.github/workflows/ci.yml

@@ -0,0 +1,37 @@
+name: CI
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+env:
+  HELM_VERSION: v3.15.2
+  PGO_VERSION: 5.7.4
+
+jobs:
+  validate:
+    name: Lint checks
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install uv
+        run: |
+          curl -LsSf https://astral.sh/uv/install.sh | sh
+          echo "$HOME/.cargo/bin" >> "$GITHUB_PATH"
+
+      - name: Install Helm
+        uses: azure/setup-helm@v3
+        with:
+          version: ${{ env.HELM_VERSION }}
+
+      - name: Run linters
+        run: |
+          export PATH="$HOME/.cargo/bin:$PATH"
+          make lint

.github/workflows/helm-tests.yml

@@ -5,7 +5,6 @@ on:
     branches: [ "main" ]
   pull_request:
     branches: [ "main" ]
-    types: [ opened, reopened, synchronize, labeled ]
 
 env:
   HELM_VERSION: v3.15.2
@@ -46,10 +45,7 @@ jobs:
           docker-enabled: true
 
       - name: Set release name
-        run: |
-          SHORT_SHA="${{ github.sha }}"
-          SHORT_SHA="${SHORT_SHA::8}"
-          echo "RELEASE_NAME=eoapi-$SHORT_SHA" >> "$GITHUB_ENV"
+        run: echo "RELEASE_NAME=eoapi-$(echo "${{ github.sha }}" | cut -c1-8)" >> "$GITHUB_ENV"
 
       - name: Deploy eoAPI
         id: deploy
@@ -112,6 +108,10 @@ jobs:
           echo "===== Relevant ConfigMaps ====="
           kubectl get configmaps | grep -E "initdb|pgstac" || echo "No relevant configmaps found"
 
+          # Check for any related events
+          echo "===== Related Kubernetes Events ====="
+          kubectl get events | grep -E "pgstac|initdb" || echo "No relevant events found"
+
           exit 1
 
       - name: Run integration tests
@@ -126,14 +126,10 @@ jobs:
         run: |
           echo "=== Final Deployment Status ==="
           kubectl get pods -o wide
-          kubectl get services
+          kubectl get jobs -o wide
+          kubectl get services -o wide
           kubectl get ingress
 
-      - name: Debug on failure
-        if: failure()
-        run: |
-          echo "=== Additional failure debugging (integration script provides comprehensive debugging) ==="
-          kubectl get events --sort-by='.lastTimestamp' | tail -20 || true
 
       - name: Cleanup
         if: always()

.github/workflows/pr.yaml

@@ -1,4 +1,3 @@
-
 name: PR Checks
 on:
   pull_request:

.github/workflows/stac-browser.yml

@@ -32,10 +32,12 @@ jobs:
 
       - name: Set environment variables
         run: |
-          echo VERSION=${TAG_NAME#v} >> $GITHUB_ENV
-          echo IMAGE_NAME=$REGISTRY/$(echo ${GITHUB_REPOSITORY,,})/stac-browser >> $GITHUB_ENV
-          echo COMMITED_AT=$(git show -s --format=%cI `git rev-parse HEAD`) >> $GITHUB_ENV
-          echo REVISION=$(git rev-parse --short HEAD) >> $GITHUB_ENV
+          {
+            echo "VERSION=${TAG_NAME#v}"
+            echo "IMAGE_NAME=$REGISTRY/${GITHUB_REPOSITORY,,}/stac-browser"
+            echo "COMMITED_AT=$(git show -s --format=%cI "$(git rev-parse HEAD)")"
+            echo "REVISION=$(git rev-parse --short HEAD)"
+          } >> "$GITHUB_ENV"
 
       - name: Collect Docker image metadata
         id: meta

.github/workflows/tests/test_stac.py

@@ -74,12 +74,12 @@ def test_stac_custom_path(stac_endpoint):
     """test stac with custom ingress path."""
     # If we're using a custom path (e.g., /api instead of /stac)
     base_path = stac_endpoint.split("://")[1]
-    
+
     # Landing page
     resp = client.get(stac_endpoint)
     assert resp.status_code == 200
     landing = resp.json()
-    
+
     # All links should use the custom path
     for link in landing["links"]:
         if link["href"].startswith("/"):
@@ -90,7 +90,7 @@ def test_stac_custom_path(stac_endpoint):
     resp = client.get(f"{stac_endpoint}/collections")
     assert resp.status_code == 200
     collections = resp.json()["collections"]
-    
+
     for collection in collections:
         for link in collection["links"]:
             if link["href"].startswith("/"):
@@ -101,7 +101,7 @@ def test_stac_custom_path(stac_endpoint):
     resp = client.get(f"{stac_endpoint}/collections/noaa-emergency-response/items")
     assert resp.status_code == 200
     items = resp.json()
-    
+
     # Item links should also use the custom path
     for feature in items["features"]:
         for link in feature["links"]:

.pre-commit-config.yaml

@@ -0,0 +1,62 @@
+# Pre-commit configuration for eoAPI Kubernetes charts
+# Fast, essential checks only - heavy validation moved to CI
+
+repos:
+  # Basic file formatting and validation
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+        args: ['--allow-multiple-documents']
+        exclude: ^charts/.+/templates/
+      - id: check-added-large-files
+
+  # YAML linting
+  - repo: https://github.com/adrienverge/yamllint
+    rev: v1.37.1
+    hooks:
+      - id: yamllint
+        files: \.(yaml|yml)$
+        exclude: ^charts/.+/templates/
+
+  # Shell script validation
+  - repo: https://github.com/shellcheck-py/shellcheck-py
+    rev: v0.11.0.1
+    hooks:
+      - id: shellcheck
+        args: ['-e', 'SC1091']
+
+  # GitHub Actions linting
+  - repo: https://github.com/rhysd/actionlint
+    rev: v1.7.7
+    hooks:
+      - id: actionlint
+
+  # Fast Helm syntax check only
+  - repo: local
+    hooks:
+      - id: helm-lint-syntax
+        name: Helm Syntax Check
+        entry: >
+          bash -c 'for chart in charts/*/; do
+          if [ -f "$chart/Chart.yaml" ]; then
+          if grep -q "dependencies:" "$chart/Chart.yaml" 2>/dev/null; then
+          if [ -d "$chart/charts" ] && [ -n "$(find "$chart/charts" -name "*.tgz" 2>/dev/null)" ]; then
+          echo "Linting $chart (dependencies available)...";
+          helm lint "$chart" --strict || exit 1;
+          else echo "Skipping $chart (dependencies not built - run make deploy or scripts/helm-setup.sh first)";
+          fi; else echo "Linting $chart (no dependencies)...";
+          helm lint "$chart" --strict || exit 1; fi; fi; done'
+        language: system
+        files: ^charts/.+\.(yaml|yml)$
+        pass_filenames: false
+
+# Exclude directories
+exclude: |
+  (?x)^(
+      \.git/.*|
+      charts/.+/charts/.*|
+      charts/.+/tmpcharts.*/.*
+  )$

.yamllint.yaml

@@ -0,0 +1,56 @@
+# yamllint configuration for Kubernetes/Helm YAML files
+# See https://yamllint.readthedocs.io/en/stable/configuration.html
+
+extends: default
+
+rules:
+  # Allow longer lines for Kubernetes manifests (image names, URLs, etc.)
+  line-length:
+    max: 180
+    level: warning
+
+  # Allow multiple documents in single files (common in K8s)
+  document-start: disable
+
+  # Relax indentation rules - K8s manifests can have complex nesting
+  indentation:
+    spaces: consistent
+    indent-sequences: consistent
+    check-multi-line-strings: false
+
+  # Allow empty values (common in Helm templates)
+  empty-values:
+    forbid-in-block-mappings: false
+    forbid-in-flow-mappings: false
+
+  # Allow truthy values like "yes", "no", "on", "off" (common in K8s)
+  truthy:
+    allowed-values: ['true', 'false', 'yes', 'no', 'on', 'off']
+    check-keys: false
+
+  # Be more lenient with comments
+  comments:
+    min-spaces-from-content: 1
+    require-starting-space: true
+
+  # Allow quoted strings (often necessary for Helm templating)
+  quoted-strings:
+    quote-type: any
+    required: false
+
+  # Allow brackets for flow sequences/mappings
+  brackets:
+    min-spaces-inside: 0
+    max-spaces-inside: 1
+
+  # Allow braces for flow mappings
+  braces:
+    min-spaces-inside: 0
+    max-spaces-inside: 1
+
+# Ignore certain files/patterns
+ignore: |
+  charts/*/charts/
+  charts/*/tmpcharts/
+  charts/*/templates/
+  .github/workflows/tests/

CHANGELOG.md

@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - Enforcement of `CHANGELOG.md` entries for PRs and Conventional Commits for PR titles [#288](https://github.com/developmentseed/eoapi-k8s/pull/288)
+- Added code formatting and linting with pre-commit hooks [#283](https://github.com/developmentseed/eoapi-k8s/pull/283)
 
 ## [0.7.8] - 2025-09-10
 

Makefile

@@ -5,7 +5,7 @@ HELM_REPO_URL=https://devseed.com/eoapi-k8s/
 HELM_CHART_NAME=eoapi/eoapi
 PGO_CHART_VERSION=5.7.4
 
-.PHONY: all deploy minikube ingest test-integration tests help
+.PHONY: all deploy minikube ingest tests integration lint help
 
 # Default target
 all: deploy
@@ -41,11 +41,21 @@ integration:
 	@command -v bash >/dev/null 2>&1 || { echo "bash is required but not installed"; exit 1; }
 	@./scripts/test.sh integration
 
+lint:
+	@echo "Running linting and code quality checks..."
+	@if [ ! -f .git/hooks/pre-commit ]; then \
+		echo "Installing pre-commit..."; \
+		uv pip install pre-commit yamllint shellcheck-py || pip3 install --user pre-commit yamllint shellcheck-py; \
+		pre-commit install; \
+	fi
+	@pre-commit run --all-files
+
 help:
 	@echo "Makefile commands:"
 	@echo "  make deploy         -  Deploy eoAPI to the configured Kubernetes cluster."
 	@echo "  make minikube       -  Install eoAPI on minikube."
 	@echo "  make ingest         -  Ingest STAC collections and items into the database."
 	@echo "  make integration    -  Run integration tests on connected Kubernetes cluster."
 	@echo "  make tests          -  Run lint + unit tests."
+	@echo "  make lint           -  Run linting and code quality checks."
 	@echo "  make help           -  Show this help message."

charts/eoapi-support/README.md

@@ -2,4 +2,4 @@
 
 observability, monitoring and some custom metrics for autoscaling
 
-(please see documentation about `helm install` and configuration at ../../docs/autoscaling.md)
+(please see documentation about `helm install` and configuration at ../../docs/autoscaling.md)