From db0cbdd14e96453e68caf6281ec797932b4f34de Mon Sep 17 00:00:00 2001 From: Steven Bal Date: Tue, 23 Jul 2024 15:27:47 +0200 Subject: [PATCH] :construction_worker: [open-zaak/open-zaak#1649] Job to check if docs changed --- .github/workflows/ci.yml | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 791b8eb..1bee7f0 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -111,6 +111,31 @@ jobs: with: token: ${{ secrets.CODECOV_TOKEN }} + 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: | + python src/manage.py generate_envvar_docs --file docs/installation/config.rst --exclude-group Celery + changes=$(git diff docs/installation/config.rst) + if [ ! -z "$changes" ]; then + echo $changes + echo "Please update the environment documentation by running \`python src/manage.py generate_envvar_docs --file docs/installation/config.rst --exclude-group Celery\`" + exit 1 + fi + env: + DJANGO_SETTINGS_MODULE: referentielijsten.conf.ci + docker: needs: tests name: Docker image build