traitlets/.github/workflows/tests.yml at main · ipython/traitlets · 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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
name: Tests

on:
  push:
    branches-ignore:
      - "claude/**"
  pull_request:
  schedule:
    - cron: "0 8 * * *"

concurrency:
  group: >-
    ${{ github.workflow }}-
    ${{ github.ref_type }}-
    ${{ github.event.pull_request.number || github.sha }}
  cancel-in-progress: true

defaults:
  run:
    shell: bash -eux {0}

jobs:
  tests:
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest, windows-latest, macos-latest]
        python-version: ["3.10", "3.13", "3.14"]
        include:
          - os: ubuntu-latest
            python-version: "3.11"
          - os: ubuntu-latest
            python-version: "3.12"
          # Free-threaded builds aren't in the runner tool cache and are
          # expensive to provision on Windows/macOS (~73s vs ~23s on Linux),
          # so exercise 3.14t on Linux only.
          - os: ubuntu-latest
            python-version: "3.14t"
          - os: ubuntu-latest
            python-version: "pypy-3.11"

    steps:
      - uses: actions/checkout@v7
      - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
        with:
          node_version: "none"
          python_package_manager: "uv pip"
      - name: Run Tests
        run: hatch run cov:test
      # Codecov merges the uploads of every matrix job into one report for
      # the commit, so each job uploads its own and nothing combines them here.
      - name: Upload coverage to Codecov
        uses: codecov/codecov-action@v7
        with:
          files: coverage.xml
          disable_search: true
          flags: ${{ matrix.os }}-${{ matrix.python-version }}
          # Empty on pull requests from forks, where Codecov falls back to a
          # tokenless upload. Flip fail_ci_if_error on once the secret is set.
          token: ${{ secrets.CODECOV_TOKEN }}
          fail_ci_if_error: false

  test_minimum_versions:
    name: Test Minimum Versions
    runs-on: ubuntu-latest
    timeout-minutes: 10
    steps:
      - uses: actions/checkout@v7
      - name: Base Setup
        uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
        with:
          dependency_type: minimum
          node_version: "none"
          python_package_manager: "uv pip"
      - name: Run the unit tests
        run: hatch run test:nowarn

  test_lint:
    name: Test Lint
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7
      - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
        with:
          node_version: "none"
          python_package_manager: "uv pip"
      - name: Run Linters
        run: |
          hatch run typing:test
          hatch run lint:build
          pipx run 'validate-pyproject[all]' pyproject.toml
          pipx run doc8 --max-line-length=200

  test_docs:
    timeout-minutes: 10
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7
      - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
        with:
          node_version: "none"
          python_package_manager: "uv pip"
      - name: Build the docs
        run: hatch run docs:build

  test_prereleases:
    name: Test Prereleases
    timeout-minutes: 10
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v7
      - name: Base Setup
        uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
        with:
          dependency_type: pre
          node_version: "none"
          python_package_manager: "uv pip"
      - name: Run the tests
        run: hatch run test:nowarn

  make_sdist:
    name: Make SDist
    runs-on: ubuntu-latest
    timeout-minutes: 10
    steps:
      - uses: actions/checkout@v7
      - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
        with:
          node_version: "none"
          python_package_manager: "uv pip"
      - uses: jupyterlab/maintainer-tools/.github/actions/make-sdist@v1

  test_sdist:
    runs-on: ubuntu-latest
    needs: [make_sdist]
    name: Install from SDist and Test
    timeout-minutes: 20
    steps:
      - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
        with:
          node_version: "none"
          python_package_manager: "uv pip"
      - uses: jupyterlab/maintainer-tools/.github/actions/test-sdist@v1

  # Downstream projects are slow and only meaningful if traitlets itself is
  # healthy, so hold them until every fast job has finished and passed.
  downstream:
    needs:
      - tests
      - test_minimum_versions
      - test_lint
      - test_docs
      - test_prereleases
      - test_sdist
    uses: ./.github/workflows/downstream.yml

  check_links:
    runs-on: ubuntu-latest
    timeout-minutes: 10
    steps:
      - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
        with:
          node_version: "none"
          python_package_manager: "uv pip"
      - uses: jupyterlab/maintainer-tools/.github/actions/check-links@v1

  check_release:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v7
      - name: Base Setup
        uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
        with:
          node_version: "none"
          python_package_manager: "uv pip"
      - name: Install Dependencies
        run: |
          pip install -e .
      - name: Check Release
        uses: jupyter-server/jupyter_releaser/.github/actions/check-release@v2
        with:
          token: ${{ secrets.GITHUB_TOKEN }}