Document mutation-testing workflow contract tests - #85
Draft
leynos wants to merge 1 commit into
Draft
Conversation
Add a section to the developer guide explaining the thin mutation-testing caller workflow, its two run modes, the caller configuration inputs, and what the contract test in tests/workflow_contracts/mutation_testing_test.py pins, so contributors know how to run and interpret it locally via `make test-workflow-contracts`.
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.yml, its two run modes (dailychange-scoped schedule and whole-crate manual dispatch), the caller's
extra-args/exclude-globsinputs, and whattests/workflow_contracts/mutation_testing_test.pypins.USES_REregex asserting a full40-hex commit SHA on
mutation-cargo.yml). The SHA value itself is nothard-coded, so Dependabot bumps it without any accompanying test edit.
There is no
pytestmark/skip-if guard — this is a Rust repository, sothe Python sandbox-omits-
.github/concern from the mutmut permutationdoes not apply here.
make test-workflow-contracts(theMakefile already exposes this target, wrapping
uv run --with 'pytest>=8' --with 'pyyaml>=6' pytest tests/workflow_contracts -q).with:inputs the caller actually sets are documented(
extra-args: "--all-features"andexclude-globs: "src/tests/**,tests/support/**,src/bin/bless_traces.rs");there is no
pathsorextra-crate-dirsinput in this caller.Roadmap/execplan note
docs/roadmap.mdanddocs/model-training-pipeline-roadmap.mdcontain nomutation-testing or workflow-contract-test tracking items, so no
roadmap/execplan annotation applies.
TOC
docs/developers-guide.mdhas no table of contents or index list near thetop (it is a flat sequence of
##sections), so no cross-link entry wasadded; the new section was appended after the existing "Workflow pins and
Dependabot" section, which it complements.
Docs lint
make markdownlintpassed (spelling check viamake spelling, thenmarkdownlint-cli2over all tracked Markdown, 0 errors). Two words in theinitial draft (
summarising,serialises) were corrected to the en-GBOxford
-izeforms (summarizing,serializes) to satisfy the repository'stypos policy. The generated
typos.tomlwas regenerated as a side effect ofrunning
make spellingbut reverted before committing, since that churn isunrelated to this change.
Files changed
docs/developers-guide.md