Skip to content

docs: document CI parity checks - #2668

Closed
redzwanmutalib wants to merge 1 commit into
Graphify-Labs:v8from
redzwanmutalib:docs/ci-parity-checks
Closed

docs: document CI parity checks#2668
redzwanmutalib wants to merge 1 commit into
Graphify-Labs:v8from
redzwanmutalib:docs/ci-parity-checks

Conversation

@redzwanmutalib

Copy link
Copy Markdown
Contributor

Summary

  • document the authoritative location of CI commands
  • list the local CI-style dependency, pytest, skillgen, and CLI smoke commands
  • clarify the Python 3.10/3.12 matrix and advisory status of Ruff, Pyright, Bandit, and pip-audit

Verification

  • uv run --frozen ruff check . — passed
  • all five tools.skillgen consistency guards — passed
  • git diff --check — passed

Scope

Docs-only: README.md. No source, test, workflow, AGENTS, generated artifact, hook, or skill changes.

The full pytest suite was not used as a native-Windows blocker because the repository's Ubuntu CI matrix is authoritative and known Windows parity failures remain in symlink, long-path, POSIX, separator, and encoding behavior.

@graphify-labs graphify-labs Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Graphify reviewed this change.

Looks safe to merge — no coupling regressions and no blocking issues, checked against the code graph (not a self-assessment).


Graphify review — findings

This PR adds a new "CI parity checks" section to the README, documenting the commands contributors can run locally to mirror CI verification (uv sync, pytest, various skillgen checks, and graphify commands). It also notes which tools (Ruff, Pyright, Bandit, pip-audit) are advisory versus blocking. The change is documentation-only within the README, inserted before the existing macOS note and Git workflow sections.

No blocking issues surfaced.

Analysis details — impact, health, verification

Impact & health

Graphify review

Impact — 26 functions depend on the 26 functions this change touches.

Health — grade A; no new coupling hotspots.

Verification — 26 functions in the blast radius were not formally verified this run (proofs are advisory here).

Gate & verification

graphify gate

PASS — objectively clean (no health regressions, tests not run — proofs not run this pass (advisory)). Grounded, not self-assessed.

Advisory (not blocking):

  • verification_scope: 26 function(s) in the blast radius were not formally verified this run

@safishamsi

Copy link
Copy Markdown
Collaborator

Shipped in v0.9.42 (graphifyy==0.9.42 on PyPI). Documents CI parity checks. Credited in the release notes. Thanks @redzwanmutalib!

@safishamsi safishamsi closed this Aug 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants