Add basic CI configuration #2
Workflow file for this run
This file contains 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: CI | |
| on: | |
| workflow_dispatch: | |
| pull_request: | |
| push: | |
| branches: | |
| - main | |
| 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 | |
| jobs: | |
| pre-commit: | |
| name: pre-commit | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.x" | |
| - uses: pre-commit/action@v3.0.1 | |
| with: | |
| extra_args: --hook-stage manual --all-files | |
| checks: | |
| name: Test with Python ${{ matrix.python-version }} on ${{ matrix.runs-on }} | |
| runs-on: ${{ matrix.runs-on }} | |
| needs: [pre-commit] | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| python-version: ["3.9", "3.13"] | |
| runs-on: [ubuntu-latest, windows-latest, macos-14] | |
| include: | |
| - python-version: "pypy-3.10" | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| allow-prereleases: true | |
| - name: Install package | |
| run: python -m pip install .[test,optional] | |
| - name: Run pytest | |
| run: >- | |
| python -m pytest -ra --cov --cov-report=xml --cov-report=term | |
| --durations=20 | |
| - name: Upload coverage report | |
| uses: codecov/codecov-action@v4.5.0 | |
| with: | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| - name: Compare example stubs | |
| run: | | |
| python -m docstub -v example/example_pkg | |
| git diff --exit-code example/ | |
| - name: Generate docstub stubs | |
| run: | | |
| python -m docstub -v src/docstub | |
| - name: Upload docstub stubs | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: docstub-stubs | |
| path: ./src/docstub-stubs |