👷 [open-zaak/open-zaak#1649] Job to check if docs changed

.github/workflows/ci.yml

@@ -64,7 +64,7 @@ jobs:
       - name: Publish coverage report
         uses: codecov/codecov-action@v3
 
-  docs:
+  check-envvar-docs:
     runs-on: ubuntu-latest
     name: Documentation build
 
@@ -75,6 +75,17 @@ jobs:
           python-version: '3.11'
       - name: Install dependencies
         run: pip install -r requirements/dev.txt pytest
+      - name: Generate environment variable documentation using OAf and check if it was updated
+        run: |
+          bin/generate_envvar_docs.sh
+          changes=$(git diff docs/installation/config.rst)
+          if [ ! -z "$changes" ]; then
+              echo $changes
+              echo "Please update the environment documentation by running \`bin/generate_envvar_docs.sh\`"
+              exit 1
+          fi
+        env:
+          DJANGO_SETTINGS_MODULE: nrc.conf.ci
       - name: Build and test docs
         run: cd docs && pytest check_sphinx.py -v --tb=auto
 

bin/generate_envvar_docs.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+# Generates the documentation for environment variables
+src/manage.py generate_envvar_docs --file docs/installation/configuration/env_config.rst