(NEWS) adding generated NEWS.md file #1
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Check Documentation | |
| # This action runs: | |
| # - When this file changes | |
| # - When changes on documentation (doc) | |
| # - When changes on translation (locale) | |
| # - When the way the documentation build changes (CMakeLists.txt, doc/CMakeLists.txt, doc/conf.py.in) | |
| # | |
| # documentation is tested only on: | |
| # - ubuntu-latest | |
| # - default postgres installed on ubuntu-latest | |
| on: | |
| workflow_dispatch: | |
| push: | |
| paths: | |
| - '.github/workflows/documentation.yml' | |
| - 'doc/**' | |
| - 'locale/**' | |
| - 'CMakeLists.txt' | |
| branches-ignore: | |
| - 'gh-pages' | |
| tags: [] | |
| pull_request: | |
| paths: | |
| - '.github/workflows/documentation.yml' | |
| - 'doc/**' | |
| - 'locale/**' | |
| - 'CMakeLists.txt' | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| permissions: | |
| contents: read | |
| env: | |
| release: Release | |
| os: ubuntu-latest | |
| jobs: | |
| check-documentation: | |
| name: documentation | |
| runs-on: ubuntu-latest | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| language: [en] | |
| os: [ubuntu-latest] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 2 | |
| - name: check modified files | |
| id: check_files | |
| run: | | |
| # allways processing english, no matter what the change was | |
| if [[ "${{ matrix.language }}" == "en" ]]; then echo "PROCESS=true" >> $GITHUB_ENV; echo "CHK_LINK=true" >> $GITHUB_ENV; exit 0; fi | |
| if [[ "${{ matrix.language }}" == "zh_Hans" && "${{ github.repository_owner }}" != "pgRouting" ]]; then echo "PROCESS=false" >> $GITHUB_ENV; exit 0; fi | |
| # when this file changes all languages are tested | |
| if git diff --name-only HEAD^ HEAD | grep -q '.github/workflows/documentation.yml' ; then echo "PROCESS=true" >> $GITHUB_ENV; exit 0; fi | |
| # when there is a change on the way the build is done all languages are tested | |
| if git diff --name-only HEAD^ HEAD | grep -q '^CMakeLists.txt' ; then echo "PROCESS=true" >> $GITHUB_ENV; exit 0; fi | |
| if git diff --name-only HEAD^ HEAD | grep -q '^doc/CMakeLists.txt' ; then echo "PROCESS=true" >> $GITHUB_ENV; exit 0; fi | |
| if git diff --name-only HEAD^ HEAD | grep -q '^doc/conf.py.in' ; then echo "PROCESS=true" >> $GITHUB_ENV; exit 0; fi | |
| # if there is a change on the translation | |
| if git diff --name-only HEAD^ HEAD | grep -q "^locale/${{ matrix.language }}" ; then echo "PROCESS=true" >> $GITHUB_ENV; echo "CHK_LINK=true" >> $GITHUB_ENV; exit 0; fi | |
| - name: Get postgres version | |
| if: env.PROCESS == 'true' | |
| run: | | |
| sudo service postgresql start | |
| PGVER=$(psql --version | grep -Po '(?<=psql \(PostgreSQL\) )[^;]+(?=\.\d+ \()') | |
| echo "PGVER=${PGVER}" >> $GITHUB_ENV | |
| echo "PGPORT=5432" >> $GITHUB_ENV | |
| - name: Install python | |
| if: env.PROCESS == 'true' | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.12' | |
| - name: Install dependencies | |
| if: env.PROCESS == 'true' | |
| run: | | |
| sudo apt-get update | |
| # Basic dependencies | |
| sudo apt-get install -y \ | |
| postgresql-${PGVER} \ | |
| postgresql-server-dev-${PGVER} | |
| # documentation dependencies | |
| sudo apt-get install -y \ | |
| graphviz \ | |
| python3-sphinx \ | |
| python3-sphinx-bootstrap-theme \ | |
| sphinx-intl | |
| - name: Install Google OR-Tools | |
| if: env.PROCESS == 'true' | |
| run: | | |
| sudo pip install --root=/ ortools==9.10.4067 | |
| - name: Configure | |
| if: env.PROCESS == 'true' | |
| run: | | |
| mkdir build | |
| cd build | |
| cmake -DCMAKE_BUILD_TYPE=${{ env.release }} \ | |
| -DSPHINX_LINKCHECK=ON .. | |
| - name: Build Documentation | |
| if: env.PROCESS == 'true' | |
| run: | | |
| cd build | |
| make html-${{ matrix.language }} | |
| - name: Check Links | |
| if: env.CHK_LINK == 'true' | |
| run: | | |
| cd build | |
| make linkcheck-${{ matrix.language }} |