docstub/.github/workflows/ci.yml at main · scientific-python/docstub · 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
name: CI

on:
  workflow_dispatch:
  pull_request:
  push:
    branches:
      - main

permissions: {}

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

env:
  # Many color libraries just need this to be set to any value, but at least
  # one distinguishes color depth, where "3" -> "256-bit color".
  FORCE_COLOR: 3
  PIP_PROGRESS_BAR: "off"

defaults:
  run:
    # Make sure that bash specific stuff works on Windows
    shell: bash

jobs:
  lint:
    name: pre-commit
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
        with:
          fetch-depth: 0
          persist-credentials: false
      - uses: actions/setup-python@v6
        with:
          python-version: "3.x"
      - uses: pre-commit/action@2c7b3805fd2a0fd8c1884dcaebf91fc102a13ecd  # v3.0.1
        with:
          extra_args: --hook-stage manual --all-files

  test:
    name: Test ${{ matrix.runs-on.short }}-py${{ matrix.python-version }}
    runs-on: ${{ matrix.runs-on.name }}
    strategy:
      fail-fast: false
      matrix:
        runs-on:
          - { short: linux, name: ubuntu-latest }
          - { short: win, name: windows-latest }
          - { short: macos, name: macos-latest }
        python-version: ["3.12", "3.14"]
        include:
          - runs-on: { short: linux, name: ubuntu-latest }
            python-version: "3.13"

    steps:
      - uses: actions/checkout@v6
        with:
          fetch-depth: 0
          persist-credentials: false

      - uses: actions/setup-python@v6
        with:
          python-version: ${{ matrix.python-version }}
          allow-prereleases: true

      - name: Install package
        run: |
          python -m pip install --group "test" .
          python -m docstub --version
          docstub --help

      - name: Run pytest
        run: >-
          python -m pytest --showlocals -ra --cov --cov-report=term

      # TODO upload coverage statistics, and fail on decrease?

      - name: Check example_pkg-stubs
        # Check that stubs for example_pkg are up-to-date by regenerating them
        # with docstub and looking for differences.
        run: |
          rm -rf examples/example_pkg-stubs
          python -m docstub run -v \
              --config=examples/docstub.toml \
              --out-dir=examples/example_pkg-stubs \
              examples/example_pkg
          .github/scripts/assert-unchanged.sh examples/

      - name: Check docstub-stubs (single process)
        # Check that stubs for docstub are up-to-date by regenerating them
        # with docstub and looking for differences.
        run: |
          rm -rf src/docstub-stubs
          python -m docstub run -v src/docstub -o src/docstub-stubs
          .github/scripts/assert-unchanged.sh src/docstub-stubs/

      - name: Check docstub-stubs (multiprocess)
        # Repeat test with multiprocessing enabled
        run: |
          rm -rf src/docstub-stubs
          python -m docstub run -v src/docstub -o src/docstub-stubs --workers 2
          .github/scripts/assert-unchanged.sh src/docstub-stubs/

      - name: Check with mypy.stubtest
        run: |
          python -m mypy.stubtest \
            --mypy-config-file pyproject.toml \
            --allowlist stubtest_allow.txt \
            docstub

      - name: Check tests/ with mypy
        run: |
          python -m mypy tests/

      - name: Check tests/ with basedpyright
        run: |
          basedpyright tests/