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 4a6bb59 commit d8fd2a8
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,35 @@ 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
file_changed=$(git diff --name-only docs/installation/config.rst)
if [ ! -z "$file_changed" ]; then
echo "Please update the environment documentation by running \`python src/manage.py generate_envvar_docs --file docs/installation/config.rst\`"
exit 1
fi
env:
DJANGO_SETTINGS_MODULE: objects.conf.ci
- name: Build and test docs
run: |
export OPENSSL_CONF=$(pwd)/openssl.conf
pytest check_sphinx.py -v --tb=auto
working-directory: docs

docker:
needs: tests

Expand Down

0 comments on commit d8fd2a8

Please sign in to comment.