Skip to content

Document mutation-testing workflow contract tests - #150

Draft
leynos wants to merge 1 commit into
mainfrom
docs/mutation-contract-tests
Draft

Document mutation-testing workflow contract tests#150
leynos wants to merge 1 commit into
mainfrom
docs/mutation-contract-tests

Conversation

@leynos

@leynos leynos commented Jul 19, 2026

Copy link
Copy Markdown
Owner

Summary

Adds a ## Mutation-testing workflow contract tests section to
docs/developers-guide.md, documenting the informational mutation-testing
caller workflow and the pull-request-time contract test that pins its shape.

  • Explains the caller's two run modes (daily change-scoped schedule; manual
    whole-workspace dispatch) and the with: inputs it passes to
    leynos/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").
  • Notes the uses: reference pins the shared workflow to a full 40-character
    commit 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 any
    accompanying test edit.
  • Documents the local run command,
    make test-workflow-contracts (backed by
    uv run --with 'pytest>=8' --with 'pyyaml>=6' pytest tests/workflow_contracts -q), and lists what the test asserts: the uses:
    pin, the exact with: block, least-privilege job permissions with an empty
    workflow-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.md or execplan entry relates to mutation testing or this
documentation task, so no roadmap/execplan tracking applies.

Docs lint

make markdownlint (which chains the spelling gate) passes clean after
fixing two -ise/-ize spellings (summarisingsummarizing,
serialisesserializes) introduced by the new prose.

Files changed

Test plan

  • make markdownlint passes (spelling gate + markdownlint-cli2)
  • No Rust/Python test suite run — docs-only change, per instructions

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.

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry @leynos, you have reached your weekly rate limit of 500000 diff characters.

Please try again later or upgrade to continue using Sourcery

@coderabbitai

coderabbitai Bot commented Jul 19, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: b8b6da52-3572-4881-9a5b-2958f8b28d27

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/mutation-contract-tests

Comment @coderabbitai help to get the list of available commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant