Document mutation-testing workflow contract tests - #150
Draft
leynos wants to merge 1 commit into
Draft
Conversation
Add a section to the developers' guide explaining the caller workflow's purpose, its two run modes, the with: inputs it passes, the SHA-pinning style of the reusable-workflow reference, and how to run the contract test locally, so contributors understand why the test exists and how to reproduce it without reading the workflow YAML and test source directly.
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 informational mutation-testingcaller workflow and the pull-request-time contract test that pins its shape.
whole-workspace dispatch) and the
with:inputs it passes toleynos/shared-actions/.github/workflows/mutation-cargo.yml(
paths: "src/,crates/",exclude-globs: "test-support/**,crates/test-utils/**",extra-args: "--workspace --all-features --test-workspace=true").uses:reference pins the shared workflow to a full 40-charactercommit SHA, and that the contract test asserts only the shape of that pin
(
USES_RE), not a hard-coded SHA value, so Dependabot bumps it without anyaccompanying test edit.
make test-workflow-contracts(backed byuv run --with 'pytest>=8' --with 'pyyaml>=6' pytest tests/workflow_contracts -q), and lists what the test asserts: theuses:pin, the exact
with:block, least-privilege job permissions with an emptyworkflow-level default, per-ref concurrency without cancellation, and the
trigger shape (daily schedule plus a plain
workflow_dispatch).The developers' guide is a short, flat document with no table of contents, so
no cross-link index entry was needed.
No
docs/roadmap.mdor execplan entry relates to mutation testing or thisdocumentation task, so no roadmap/execplan tracking applies.
Docs lint
make markdownlint(which chains the spelling gate) passes clean afterfixing two
-ise/-izespellings (summarising→summarizing,serialises→serializes) introduced by the new prose.Files changed
docs/developers-guide.mdTest plan
make markdownlintpasses (spelling gate + markdownlint-cli2)