chore: lint .env file templates (#3507)

langgenius · Apr 16, 2024 · 066076b · 066076b
1 parent be27ac0
commit 066076b
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/.github/workflows/style.yml b/.github/workflows/style.yml
@@ -24,11 +24,14 @@ jobs:
           python-version: '3.10'
 
       - name: Python dependencies
-        run: pip install ruff
+        run: pip install ruff dotenv-linter
 
       - name: Ruff check
         run: ruff check ./api
 
+      - name: Dotenv check
+        run: dotenv-linter ./api/.env.example ./web/.env.example
+
       - name: Lint hints
         if: failure()
         run: echo "Please run 'dev/reformat' to fix the fixable linting errors."

diff --git a/dev/reformat b/dev/reformat
@@ -10,3 +10,11 @@ fi
 
 # run ruff linter
 ruff check --fix ./api
+
+# env files linting relies on `dotenv-linter` in path
+if ! command -v dotenv-linter &> /dev/null; then
+    echo "Installing dotenv-linter ..."
+    pip install dotenv-linter
+fi
+
+dotenv-linter ./api/.env.example ./web/.env.example