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 1f91ca3 commit 1beefdc
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,43 @@ 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 system packages
run: |
sudo apt-get update \
&& sudo apt-get install -y --no-install-recommends \
libgdal-dev \
gdal-bin
- 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 collectstatic --noinput --link
python src/manage.py generate_envvar_docs --file docs/installation/config.rst
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\`"
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 1beefdc

Please sign in to comment.