Skip to content

Commit

Permalink
👷 [open-zaak/open-zaak#1649] Job to check if docs changed
Browse files Browse the repository at this point in the history
  • Loading branch information
stevenbal committed Jul 23, 2024
1 parent 3abab81 commit a5fb7d8
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,31 @@ jobs:
- name: Publish coverage report
uses: codecov/codecov-action@v3

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: openklant.conf.ci

docker:
needs: tests
name: Build Docker image
Expand Down

0 comments on commit a5fb7d8

Please sign in to comment.