sphinx-design-elements/.github/workflows/main.yml at main · 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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
---
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",
        ]
        docutils-version: [
          "0.21.*",
        ]
        sphinx-version: [
          "5.*",
          "6.*",
          "7.*",
          "8.*",
          "9.*",
        ]
        exclude:

          # Don't validate Sphinx 8 and 9 on Python 3.9. It is not supported.
          - python-version: "3.9"
            docutils-version: "0.21.*"
            sphinx-version: "8.*"
          - python-version: "3.9"
            docutils-version: "0.21.*"
            sphinx-version: "9.*"

        include:

          # Validate docutils 0.19, 0.20, and 0.22.
          - python-version: "3.14"
            docutils-version: "0.19.*"
            sphinx-version: "9.*"
          - python-version: "3.14"
            docutils-version: "0.20.*"
            sphinx-version: "9.*"
          - python-version: "3.14"
            docutils-version: "0.22.*"
            sphinx-version: "9.*"

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

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

    - name: Acquire sources
      uses: actions/checkout@v6
      with:
        # Fetch tags, because `versioningit` needs them.
        # https://github.com/actions/checkout/issues/1471
        fetch-tags: true
        fetch-depth: 0
        filter: tree:0

    - 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: Set up project
      run: |

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

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

    - name: Sphinx and docutils versions
      run: |
        sphinx-build --version
        docutils --version

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

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