sphinx-design-elements/.github/workflows/main.yml at 2fb33adcf0effd145121ffbb28f6cb6a8226875e · tech-writing/sphinx-design-elements · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
---
name: Tests

on:
  pull_request:
  push:
    branches: [ main ]

  # Allow job to be triggered manually.
  workflow_dispatch:

# Cancel in-progress jobs when pushing to the same branch.
concurrency:
  cancel-in-progress: true
  group: ${{ github.workflow }}-${{ github.ref }}

jobs:

  tests:

    runs-on: "ubuntu-latest"
    strategy:
      fail-fast: false
      matrix:
        python-version: [
          "3.9",
          "3.14",
        ]
        sphinx-version: [
          "5.*",
          "6.*",
          "7.*",
        ]

    env:
      PYTHON: ${{ matrix.python-version }}
      SPHINX: ${{ matrix.sphinx-version }}
      UV_SYSTEM_PYTHON: true

    name: >
      Sphinx ${{ matrix.sphinx-version }}
      Python ${{ matrix.python-version }}
    steps:

    - name: Acquire sources
      uses: actions/checkout@v6

    - name: Set up Python
      uses: actions/setup-python@v6
      with:
        python-version: ${{ matrix.python-version }}

    - name: Set up uv
      uses: astral-sh/setup-uv@v7
      with:
        cache-dependency-glob: |
          pyproject.toml
        cache-suffix: ${{ matrix.python-version }}
        enable-cache: true
        version: "latest"

    - name: Setup project
      run: |

        # Install package in editable mode.
        uv pip install --editable='.[develop,docs,test]'

        # Install specific Sphinx version, according to test matrix slot.
        uv pip install 'sphinx==${{ matrix.sphinx-version }}'

        # Display Sphinx version.
        sphinx-build --version

    - name: Run linter and software tests
      run: |
        poe check

    - name: Upload coverage to Codecov
      uses: codecov/codecov-action@v5
      env:
        CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
      with:
        files: ./coverage.xml
        flags: unittests
        env_vars: PYTHON,SPHINX
        name: codecov-umbrella
        fail_ci_if_error: true