Skip to content

Document mutation-testing workflow contract tests - #276

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

Document mutation-testing workflow contract tests#276
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 new "Mutation-testing workflow contract tests" section (## 37.) to
docs/developers-guide.md, documenting the caller workflow
.github/workflows/mutation-testing.yml
and its contract test, tests/workflow_contracts/mutation_testing_test.py.

The section covers:

  • the shared reusable workflow the caller delegates to
    (mutation-cargo.yml), the two run modes (daily change-scoped schedule,
    whole-workspace manual dispatch), and the informational (non-gating)
    nature of the run;
  • the real with: inputs the caller sets — paths, exclude-globs,
    extra-args (including the --test-workspace=true --test-tool=nextest
    flags and the schema_helpers_ui trybuild exclusion), shard-count: 8,
    and setup-commands — with no invented inputs;
  • the contract test's shape-only SHA style (a USES_RE regex asserting
    a full 40-hex commit SHA, not a hard-coded pin), its
    pytest.mark.skipif self-skip guard for mutation sandboxes that omit
    .github/, and the local run command, make test-workflow-contracts;
  • a note distinguishing the mutation contract test from the separate
    codescene_coverage_test.py, which pins a different action at its own
    SHA, so the two are not conflated.

This repository's docs/developers-guide.md has no table of contents or
index list near the top (sections are plain numbered ## headings), so no
cross-link entry was added; the new section is simply the next numbered
heading in sequence.

No roadmap or execplan tracking applies: docs/roadmap.md has no
mutation-testing items, and docs/execplans/mutation-testing.md is already
marked IMPLEMENTED for the original (now superseded) workflow shape — it
is not a checklist for this documentation addition.

Docs lint

make markdownlint (spelling/typos + markdownlint-cli2 on changed
Markdown files) passes with no errors on the final version of this change.
Only the Rust/Python test suites were skipped, per this being a docs-only
change.

Test plan

  • make markdownlint passes
  • Rust/Python test suites intentionally not run (docs-only change)

Edited file: docs/developers-guide.md

Add a developer's guide section explaining the mutation-testing caller
workflow's contract test (tests/workflow_contracts/mutation_testing_test.py):
what it pins, why the SHA assertion is shape-only, and how to run it locally
with make test-workflow-contracts.

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

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: 67d44338-cc5c-43ad-9c2d-7b66a76d59fe

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.

@github-actions github-actions Bot added scope: docs Documentation size: XS < 10 changed lines (excluding docs) risk: low Changes to docs, tests, or low-risk modules contributor: core 20+ merged PRs labels Jul 19, 2026
codescene-access[bot]

This comment was marked as outdated.

@codescene-access codescene-access 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.

No quality gates enabled for this code.

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

Labels

contributor: core 20+ merged PRs risk: low Changes to docs, tests, or low-risk modules scope: docs Documentation size: XS < 10 changed lines (excluding docs)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant