Skip to content

Add basic CI configuration #10

Add basic CI configuration

Add basic CI configuration #10

Workflow file for this run

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 on ${{ matrix.runs-on }} Python ${{ matrix.python-version }}
runs-on: ${{ matrix.runs-on }}
needs: [pre-commit]
strategy:
fail-fast: false
matrix:
runs-on: [ubuntu-latest, windows-latest, macos-14]
python-version: ["3.12"]
include:
- runs-on: ubuntu-latest
python-version: "3.13"
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 --showlocals -ra --cov --cov-report=term
# TODO upload coverage statistics, and fail on decrease?
- name: Compare example stubs
run: |
python -m docstub -v --config=examples/docstub.toml examples/example_pkg
git diff --exit-code examples/ && echo "Stubs for example_pkg did not change"
- name: Generate docstub stubs
run: |
python -m docstub -v src/docstub