diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 22cde4dd..245c248d 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -102,6 +102,31 @@ jobs: - name: Publish coverage report uses: codecov/codecov-action@v3 + check-envvar-docs: + runs-on: ubuntu-latest + name: Documentation build + + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-python@v5 + with: + python-version: '3.11' + cache: 'pip' + cache-dependency-path: 'requirements/*.txt' + - name: Install dependencies + run: pip install -r requirements/ci.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: openklant.conf.ci + docker: needs: tests name: Build Docker image diff --git a/bin/generate_envvar_docs.sh b/bin/generate_envvar_docs.sh new file mode 100755 index 00000000..8502ba12 --- /dev/null +++ b/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/config.rst --exclude-group Celery