Skip to content

CI Contract

Blocking workflows

  • CI (.github/workflows/ci.yml) is the primary PR blocking gate.
  • It validates lint, types, tests, package build/smoke install, repo check, coverage, and docs build.

Informational workflows

  • Quality is schedule/manual for extended visibility and trend checks.
  • Mutation tests, SBOM, Dependency Audit, and OSV provide security/quality signals and artifacts.

Artifact expectations

  • Repo audit JSON report (report.json) from CI.
  • Dependency audit JSON (pip-audit-report.json) artifact.
  • CycloneDX SBOM (sbom.cdx.json) artifact.

Offline-by-default policy

  • Test suite blocks real network by default via tests/conftest.py.
  • Network tests must opt in with @pytest.mark.network.

Local parity commands

  • python -m pre_commit run -a
  • pytest -q
  • bash quality.sh cov