Document mutation-testing workflow contract tests - #615
Draft
leynos wants to merge 1 commit into
Draft
Conversation
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 |
Add a "Workflow contract tests" subsection under the existing Mutation testing section in docs/developers-guide.md, describing tests/workflow_contracts/mutation_testing_test.py: the six checks it runs (uses, permissions, default permissions, concurrency, triggers, with-block), the make test-workflow-contracts entrypoint, and the hard-pinned PINNED_SHA constant that requires bumping the workflow and test together.
leynos
force-pushed
the
docs/mutation-contract-tests
branch
from
July 19, 2026 23:46
927ce43 to
bdfce1c
Compare
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
### Workflow contract testssubsection under the existing## Mutation testingsection indocs/developers-guide.md, documentingtests/workflow_contracts/mutation_testing_test.py.the root workspace,
extra-crate-dirs: "wireframe_testing").uses:line equalsEXPECTED_USES, built from aPINNED_SHAconstant,so bumping the pin requires editing the workflow and the test constant
together in the same change (Dependabot cannot bump it unattended).
make test-workflow-contracts(
uv run --with 'pytest>=8' --with 'pyyaml>=6' pytest tests/workflow_contracts -q), and the six checks the test performs: thepinned
uses:reference, job permissions, workflow-level defaultpermissions,
concurrency,triggers, and thewith:block(
extra-crate-dirs,exclude-globs,extra-args).Roadmap / execplan note
docs/execplans/adopt-shared-mutation-workflow.md(Stage C) alreadytracked updating the developers-guide "Mutation testing" section describing
the caller itself, and that work has landed. This PR adds incremental
documentation of the contract test that was not separately itemised in
that plan; no roadmap or execplan item needs ticking for this change.
Docs lint
make markdownlint—Summary: 0 error(s)(log content shown above; ranclean, no fixes required).
Files
docs/developers-guide.mdTest plan
make markdownlintpasses