Skip to content

Document mutation-testing workflow contract tests - #37

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

Document mutation-testing workflow contract tests#37
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
    .github/workflows/mutation-testing.yml caller (delegating to
    leynos/shared-actions/.github/workflows/mutation-cargo.yml) and the
    contract test that pins its shape,
    tests/workflow_contracts/mutation_testing_test.py.
  • This is a docs-only change; no workflow or test behaviour is altered.

Permutation

Permutation A (Rust, single crate). The caller's actual with: block sets
extra-args: "--all-features" and setup-commands (installing
clang/lld/mold); it has no paths or exclude-globs inputs, so those
were omitted rather than invented. The contract test is shape-only
(USES_RE regex asserting a 40-hex-character commit SHA) — Dependabot bumps
the pin freely with no accompanying test edit, consistent with the existing
"Workflow pins and Dependabot" guidance later in the same document.

Local run command

make test-workflow-contracts, confirmed against the real Makefile target
(uv run --with 'pytest>=8' --with 'pyyaml>=6' pytest tests/workflow_contracts -q).

Roadmap/execplan note

No roadmap or execplan tracking applies: docs/roadmap.md has no
mutation-testing entries, and the repository has no docs/execplans/
directory.

TOC/cross-link note

docs/developers-guide.md has no in-document table of contents or section
index to update. docs/contents.md (the documentation-set index) already
describes the developer guide generically ("explains the local workflow and
implementation tooling for contributors"), which remains accurate without
changes.

Docs lint

make markdownlint (which chains spelling checks and markdownlint-cli2)
passes: 0 error(s). Two en-GB Oxford spellings introduced in the first
draft ("summarising", "serialises") were corrected to "-ize" forms
("summarizing", "serializes") to satisfy the repository's typos
configuration.

Test plan

  • make markdownlint passes with the new section included.
  • No code or workflow test suites were run, per the docs-only scope of
    this change.

Add a "Mutation-testing workflow contract tests" section to the developer
guide explaining the mutation-testing caller workflow, the informational
nature of its runs, and the contract test in
tests/workflow_contracts/mutation_testing_test.py that pins the caller's
shape. Documents the local run command (make test-workflow-contracts) and
the shape-only SHA-pinning convention already described elsewhere in the
guide.

@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

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: 619aa66c-65b7-4525-bf6b-5a857ff51cb1

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.

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

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant