[pre-commit.ci] pre-commit autoupdate #827
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: continuous-integration | |
| on: | |
| push: | |
| branches: [main] | |
| tags: | |
| - 'v*' | |
| pull_request: | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| pre-commit: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v7 | |
| - name: Set up Python | |
| uses: actions/setup-python@v6 | |
| with: | |
| python-version: "3.11" | |
| - uses: pre-commit/action@v3.0.1 | |
| tests: | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: [ubuntu-latest] | |
| python-version: ["3.11", "3.12", "3.13", "3.14"] | |
| sphinx-version: ["~=7.0", "~=8.0", "~=9.0"] | |
| extras: ["testing"] | |
| include: | |
| - os: windows-latest | |
| python-version: "3.11" | |
| sphinx-version: "~=7.0" | |
| extras: "testing" | |
| - os: windows-latest | |
| python-version: "3.13" | |
| sphinx-version: "~=8.0" | |
| extras: "testing" | |
| - os: windows-latest | |
| python-version: "3.14" | |
| sphinx-version: "~=9.0" | |
| extras: "testing" | |
| runs-on: ${{ matrix.os }} | |
| name: Tests (py${{ matrix.python-version }}, Sphinx${{ matrix.sphinx-version }}, on ${{ matrix.os }}) | |
| steps: | |
| - uses: actions/checkout@v7 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v6 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| cache: pip | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install --upgrade "sphinx${{ matrix.sphinx-version }}" -e .[${{ matrix.extras}}] | |
| - name: Run pytest | |
| run: | | |
| pytest --cov=sphinx_design --cov-report=xml --cov-report=term-missing | |
| - name: Upload to Codecov | |
| if: (github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository) && matrix.python-version == '3.13' && matrix.sphinx-version == '~=8.0' && matrix.os == 'ubuntu-latest' | |
| uses: codecov/codecov-action@v7 | |
| with: | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| name: pytests | |
| flags: pytests | |
| files: ./coverage.xml | |
| fail_ci_if_error: true | |
| docs-build-format: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| format: [html, latex, man] | |
| steps: | |
| - uses: actions/checkout@v7 | |
| - name: Set up Python | |
| uses: actions/setup-python@v6 | |
| with: | |
| python-version: "3.11" | |
| cache: pip | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install -e .[rtd] | |
| - name: Install SVG conversion tools (for sphinx.ext.imgconverter) | |
| if: matrix.format == 'latex' | |
| run: sudo apt-get update -q && sudo apt-get install -y -q --no-install-recommends imagemagick librsvg2-bin | |
| - name: Build documentation | |
| run: sphinx-build -nW --keep-going -b ${{ matrix.format }} docs/ docs/_build/${{ matrix.format }} | |
| docs-build-pdf: | |
| # compiling the LaTeX sources catches what the sphinx build alone cannot: | |
| # missing LaTeX packages and icon names unknown to fontawesome5.sty | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v7 | |
| - name: Set up Python | |
| uses: actions/setup-python@v6 | |
| with: | |
| python-version: "3.11" | |
| cache: pip | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install -e .[rtd] | |
| - name: Install SVG conversion tools (for sphinx.ext.imgconverter) | |
| run: sudo apt-get update -q && sudo apt-get install -y -q --no-install-recommends imagemagick librsvg2-bin | |
| - name: Build LaTeX sources | |
| run: sphinx-build -nW --keep-going -b latex docs/ docs/_build/latex | |
| - name: Compile PDF | |
| uses: xu-cheng/latex-action@v4 | |
| with: | |
| # TeX Live 2026's colortbl loops with Sphinx <9.1.1 table colorrows | |
| # (sphinx-doc/sphinx#14465) — drop this pin once on sphinx >=9.1.1 | |
| texlive_version: "2025" | |
| working_directory: docs/_build/latex | |
| root_file: sphinxdesign.tex | |
| - name: Upload PDF | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: docs-pdf | |
| path: docs/_build/latex/sphinxdesign.pdf | |
| # https://github.com/marketplace/actions/alls-green#why | |
| check: # This job does nothing and is only used for the branch protection | |
| if: always() | |
| needs: | |
| - pre-commit | |
| - tests | |
| - docs-build-format | |
| - docs-build-pdf | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Decide whether the needed jobs succeeded or failed | |
| uses: re-actors/alls-green@release/v1 | |
| with: | |
| jobs: ${{ toJSON(needs) }} | |
| publish: | |
| name: Publish to PyPi | |
| needs: [pre-commit, tests] | |
| if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags') | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout source | |
| uses: actions/checkout@v7 | |
| - name: Set up Python | |
| uses: actions/setup-python@v6 | |
| with: | |
| python-version: "3.11" | |
| - name: install flit | |
| run: | | |
| pip install flit~=3.4 | |
| - name: Build and publish | |
| run: | | |
| flit publish | |
| env: | |
| FLIT_USERNAME: __token__ | |
| FLIT_PASSWORD: ${{ secrets.PYPI_KEY }} |