Document mutation-testing workflow contract tests - #204
Draft
leynos wants to merge 1 commit into
Draft
Conversation
Add a developers' guide section explaining the caller workflow in .github/workflows/mutation-testing.yml, its three with: inputs, the shape-only SHA pin, and what tests/test_mutation_workflow_contract.py validates, including the local run command.
Contributor
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
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.
Summary
Adds a
## Mutation-testing workflow contract testssection todocs/developers-guide.md, documenting the thin caller workflow at.github/workflows/mutation-testing.ymland the contract test that pins its shape.
Permutation: Python (mutmut), matching the shared brief's Permutation C,
reconciled to this repository's actual configuration:
with:block carries exactly three inputs —paths,module-prefix-strip, andpython-version— noexclude-globsorextra-args. Only these three are documented.uses:pin follows the shape-only style:USES_REintests/test_mutation_workflow_contract.pyasserts a full 40-charactercommit SHA without hard-coding the value, so Dependabot bumps it without a
test edit.
skipifguard — it always executesand reads the workflow file directly from the checkout. This differs from
the template's assumption of a mutmut-sandbox self-skip, so the section
states the actual behaviour rather than the assumed one.
uv run pytest tests/test_mutation_workflow_contract.py.No table of contents exists in
docs/developers-guide.md(the top of thefile is a list of accepted ADRs, not a section index), so no cross-link was
added.
No roadmap or execplan tracking applies:
docs/roadmap.mdanddocs/execplans/roadmap-normalization.mdcontain no mutation-testing taskto tick or annotate.
Docs lint
make markdownlint(markdownlint-cli2 + en-GB-oxendict spelling check viatypos): passes for the new section. One pre-existing
MD049emphasis-stylefinding remains at line 862 (unrelated table caption, predates this change,
left untouched).
Test plan
uv run pytest tests/test_mutation_workflow_contract.py— 6 passedmake markdownlint— passes; no new findings from this change