Skip to content

Commit

Permalink
[#2424] Check that config-setup documentation is up-to-date in CI
Browse files Browse the repository at this point in the history
  • Loading branch information
pi-sigma committed Jul 16, 2024
1 parent 0002256 commit f912a13
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ jobs:
with:
name: ${{ matrix.test-type }}
path: .coverage*

upload_coverage:
needs: tests
name: Upload coverage information to codecov
Expand Down Expand Up @@ -183,6 +183,9 @@ jobs:
DB_PASSWORD: ''
E2E_DRIVER: ${{ matrix.browser }}

#
# Docs
#
docs:
name: Build and check documentation
runs-on: ubuntu-latest
Expand All @@ -203,6 +206,26 @@ jobs:
export OPENSSL_CONF=$(pwd)/openssl.conf
pytest check_sphinx.py -v --tb=auto
working-directory: docs

setup-config-docs:
name: Check that documentation for configuration steps is up-to-date
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
with:
submodules: 'true'
- name: Set up backend environment
uses: maykinmedia/setup-django-backend@v1
with:
apt-packages: 'libxml2-dev libxmlsec1-dev libxmlsec1-openssl gettext libgdal-dev gdal-bin graphviz'
python-version: '3.11'
setup-node: 'no'

- name: Build docs for django-setup-configuration steps
run: |
python src/manage.py generate_config_docs --dry-run
#
# Docker
#
Expand Down

0 comments on commit f912a13

Please sign in to comment.