docs: document how to run the collector's CI checks locally (#47) - #56
Merged
Merged
Conversation
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
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.
Closes #47
Acceptance criterion (verbatim): "someone new can reproduce every CI check locally from the README without reading
ci.yml."What changed: a "Development" section in
collector/README.mdthat lists every check CI runs:collector/: lint, format, types, tests (with the 100% floor explained, since it comes from config rather than a flag) and the Python 3.11 floor run.mkdocs build --strict.make upis given as the local equivalent, and the section points to the exact assertions inci.yml.This goes beyond the list in the issue body, which left out the
imagejob andbook.yml. The criterion says every check, so they're in.It also notes that the 3.11 run rebuilds
.venv, so the two test runs go one after the other.Gates: I ran every documented root-level command from this branch:
bash -nonimage/*.sh,docker compose config --quietandmkdocs build --strictall pass. The collector commands are the ones CI runs unchanged. The README passesmarkdownlint(MD013 disabled, as in the org's pre-commit config) and its 2 bash fences parse.docker buildwasn't re-run, since the command is copied verbatim from CI and no image input changed.🤖 Generated with Claude Code