Adopt the common CI and tooling setup - #90
Open
dannywillems wants to merge 6 commits into
Open
Conversation
Bring the client in line with the shared Python CI+tooling standard: - Dependencies: bump all runtime and dev floors to their latest releases (l9format stays pinned at 2.0.1); add hypothesis, cyclonedx-bom, nox, zizmor, mkdocs-material, and mkdocstrings. - Ruff: expand the rule set (S, ASYNC, PT, PTH, PIE, RET, ARG, ERA, RUF, PL) and fix every finding rather than ignoring it, including adding request timeouts in the sync client and tightening the examples and tests. Only pytest asserts (S101) stay exempt in tests. - mypy: enable strict; the library passes with zero errors. Test functions are exempt from requiring annotations (standard pytest convention). - Coverage: pytest-cov with branch coverage and a 70% gate (make coverage). - Makefile: add coverage, test-all (nox), audit, zizmor, sbom, and docs targets; check now runs coverage. - Workflows: replace the ad-hoc CI with the standard ci.yml, and add zizmor.yml, sbom.yml, and shellcheck.yaml. Every workflow is hardened to pass zizmor: SHA-pinned actions, least-privilege permissions, persist-credentials false, and github context passed through env vars. Secret scanning uses TruffleHog. - Docs: a mkdocs-material + mkdocstrings site (make docs).
|
You are seeing this message because GitHub Code Scanning has recently been set up for this repository, or this pull request contains the workflow file for the Code Scanning tool. What Enabling Code Scanning Means:
For more information about GitHub Code Scanning, check out the documentation. |
uv.lock was gitignored, so CI had no lockfile and uv sync re-resolved to the latest (including the broken hypothesis 6.161.7). Commit the lock and stop ignoring it.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Brings the client in line with the shared Python CI+tooling standard (the same setup as leakix-mcp).
Added
pytest-cov+ branch coverage,make coveragegate at 70% (current 73.5%), CI job.pip-audit(make audit) + CI job; no advisories.zizmor(make zizmor) + a zizmor-action CI job (SARIF to code scanning). Every workflow hardened to pass zizmor with zero findings: SHA-pinned actions, least-privilegepermissions,persist-credentials: false, and github context moved toenv:.make sbom) + release workflow.make test-all) and a mkdocs-material + mkdocstrings docs site (make docs).Changed
l9formatstays pinned at 2.0.1); added hypothesis, cyclonedx-bom, nox, zizmor, mkdocs deps.assert(S101) stays exempt in tests.strictenabled; the library passes with zero errors. Test functions are exempt from requiring annotations (standard pytest convention;tests/made a package for the override).actions.ymlCI with the standardci.yml(lint, typecheck, test matrix 3.11-3.14, coverage, audit, secret-scan). The old CI also tested macOS/Windows; the commonci.ymlis Ubuntu-only - flag if cross-platform CI should be retained.Verification
make checkgreen (format, lint, mypy strict, coverage 73.5%).make zizmorandmake auditclean.make docsbuilds--strict.Notes
uv.lockis gitignored in this repo (library), so the dependency bump is expressed via the pyproject floors.