Repository navigation
Repin install-whitaker to 5a99aed7 (whitaker-installer 0.2.11) - #189
Conversation
Reviewer's guide (collapsed on small PRs)Reviewer's GuideRepins Whitaker provisioning to shared-actions revision 5a99aed7, which defaults to whitaker-installer 0.2.11 and fixes cold Dylint driver builds by using a verified Clippy snapshot; associated workflow contract expectations and mutations are updated to match. Sequence diagram for Whitaker provisioning and lint executionsequenceDiagram
participant CI as CI lint job
participant Action as install-whitaker action
participant Installer as whitaker-installer 0.2.11
participant Driver as Dylint driver
participant Clippy as Verified Clippy snapshot
CI->>Action: Install Whitaker
Action->>Installer: Provision Whitaker
Installer->>Clippy: Use verified snapshot
Clippy-->>Driver: Build driver
Driver-->>CI: Provide Whitaker diagnostics
CI->>CI: make lint
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the
Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
WalkthroughThe CI workflow now pins the Whitaker installation action to shared-actions revision ChangesWhitaker provisioning pin
Possibly related issues
Possibly related PRs
Priority: Change: Bug fix Merge Risk:
 |
| Check name | Status | Explanation | Resolution |
|---|---|---|---|
| Developer Documentation |  |
Document the changed Whitaker tooling requirement. The PR changes .github/workflows/ci.yml from shared-actions revision 2ddf19b3 to 5a99aed78ce68dcebd3052b75c31e6f173162b1e, which selects `whita… |
Update docs/developers-guide.md in the local tooling or workflow-pins section. Record the pinned install-whitaker revision, the resulting whitaker-installer 0.2.11 requirement, and the reason for the pin. State the required validation… |
-
Check name Status Explanation Title check The title names the change: repinning install-whitaker to commit 5a99aed7, which defaults to whitaker-installer 0.2.11. This matches the workflow and test-file changes. The title does not reference a … Description check The description states the purpose: repinning the install-whitaker action to 5a99aed7, the reason (Dylint 6.0.1 clones a Clippy master branch that no longer exists), and the test-file updates. It is r… Docstring Coverage No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat… Linked Issues check Check skipped because no linked issues were found for this pull request. Out of Scope Changes check Check skipped because no linked issues were found for this pull request. Testing (Overall) The changed action pin is covered by the existing workflow contract. test_ci_provisions_whitaker_before_each_lint_routerequires exactly oneinstall-whitakerstep with the full new SHA, before eve…User-Facing Documentation Pass. The diff changes only the CI Whitaker action pin and the matching workflow-contract test fixtures. It does not change mapsplicecommands, outputs, or user-facing behaviour. No update to `docs/…Module-Level Documentation Pass the module-level documentation check. The pull request changes only action pins and the related mutation string. Both changed Python modules retain clear module docstrings, and the YAML workflow … Testing (Unit And Behavioural) Pass. Retain the workflow contract tests. test_ci_provisions_whitaker_before_each_lint_routeparses the real GitHub Actions workflow and checks the exact pinned action, ordering, unconditional execu…Testing (Property / Proof) The change only repins one GitHub Action and updates the matching exact-pin fixture and wrong-pin mutation. It introduces no invariant over a range of inputs, states, orderings, or transitions. The ex… Testing (Compile-Time / Ui) Pass. Restrict the assessment to the actual diff: it changes one GitHub Actions pin and updates two Python workflow-contract fixtures. It introduces no Rust or TypeScript compile-time behaviour and no… Unit Architecture Accept this change. The pull request only repins the Whitaker GitHub Action and updates the matching contract-test fixture and wrong-pin mutation. It adds no query, command, fallible operation, depend… Domain Architecture Pass. The pull request changes only a GitHub Actions pin and two workflow contract test literals. It does not change domain code, domain policies, commands, repositories, adapters, or transport and pe… Observability Pass this check. The pull request changes only the pinned GitHub Actions revision for Whitaker and updates two contract-test literals. It changes CI dependency provisioning, not production runtime beh… Full details: Title check
-
Explanation
The title names the change: repinning install-whitaker to commit 5a99aed7, which defaults to whitaker-installer 0.2.11. This matches the workflow and test-file changes. The title does not reference a roadmap item or issue number. The PR description links the work to DF12-89 and shared-actions
#651, but the title requirements only call for roadmap or issue numbers where the PR description references them as roadmap or issue items. The title is specific and accurate, so it passes.
Full details: Description check
-
Explanation
The description states the purpose: repinning the install-whitaker action to 5a99aed7, the reason (Dylint 6.0.1 clones a Clippy master branch that no longer exists), and the test-file updates. It is related to the changeset and gives useful context. It also includes a CI gate note.
Full details: Docstring Coverage
-
Explanation
No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 2 files. (1 skipped: 1 unsupported.)
Full details: Testing (Overall)
-
Explanation
The changed action pin is covered by the existing workflow contract.
test_ci_provisions_whitaker_before_each_lint_routerequires exactly oneinstall-whitakerstep with the full new SHA, before every reachable lint route. The parametrizedwrong_pinmutation now changes the new pin and verifies that_validaterejects it. The tests therefore fail for the old pin and for a different pin. No test is required to verify the third-party installer itself.
Full details: User-Facing Documentation
-
Explanation
Pass. The diff changes only the CI Whitaker action pin and the matching workflow-contract test fixtures. It does not change
mapsplicecommands, outputs, or user-facing behaviour. No update todocs/users-guide.mdor a migration document is required.
Full details: Module-Level Documentation
-
Explanation
Pass the module-level documentation check. The pull request changes only action pins and the related mutation string. Both changed Python modules retain clear module docstrings, and the YAML workflow is not a Python module.
Full details: Testing (Unit And Behavioural)
-
Explanation
Pass. Retain the workflow contract tests.
test_ci_provisions_whitaker_before_each_lint_routeparses the real GitHub Actions workflow and checks the exact pinned action, ordering, unconditional execution, and failure propagation. The mutation suite exercises wrong pins, missing provisioning, soft failures, masked exit status, ad hoc installation, and additional lint jobs. These tests cross the workflow boundary and cover the changed pin without relying only on private helpers.
Full details: Testing (Property / Proof)
-
Explanation
The change only repins one GitHub Action and updates the matching exact-pin fixture and wrong-pin mutation. It introduces no invariant over a range of inputs, states, orderings, or transitions. The existing small, parameterized regression table remains suitable. No property test or exhaustive proof is required.
Full details: Testing (Compile-Time / Ui)
-
Explanation
Pass. Restrict the assessment to the actual diff: it changes one GitHub Actions pin and updates two Python workflow-contract fixtures. It introduces no Rust or TypeScript compile-time behaviour and no text-based, structured, multi-variant, or UI-adjacent output. The existing Python contract tests assert the pinned action and reject the wrong pin, so trybuild or snapshot tests are not required by this check.
Full details: Unit Architecture
-
Explanation
Accept this change. The pull request only repins the Whitaker GitHub Action and updates the matching contract-test fixture and wrong-pin mutation. It adds no query, command, fallible operation, dependency boundary, state mutation, or unit responsibility. The changed tests preserve the existing explicit workflow contract.
Full details: Domain Architecture
-
Explanation
Pass. The pull request changes only a GitHub Actions pin and two workflow contract test literals. It does not change domain code, domain policies, commands, repositories, adapters, or transport and persistence boundaries. The Domain Architecture failure conditions do not apply.
Full details: Observability
-
Explanation
Pass this check. The pull request changes only the pinned GitHub Actions revision for Whitaker and updates two contract-test literals. It changes CI dependency provisioning, not production runtime behaviour, throughput, latency, storage, queues, or service boundaries. The existing
Install Whitakerstep andmake lintstep retain their normal action and command output for diagnosis. No new metric, trace, alert, or production log is required by this change.
-
Full details: Developer Documentation
-
Explanation
Document the changed Whitaker tooling requirement. The PR changes
.github/workflows/ci.ymlfrom shared-actions revision2ddf19b3to5a99aed78ce68dcebd3052b75c31e6f173162b1e, which selectswhitaker-installer 0.2.11. The developer's guide documents the Whitaker route and cold driver builds, but it does not record this installer version, action pin, or the Dylintmasterfailure that motivates the change. No guide or design-document change is included.Resolution
Update
docs/developers-guide.mdin the local tooling or workflow-pins section. Record the pinnedinstall-whitakerrevision, the resultingwhitaker-installer 0.2.11requirement, and the reason for the pin. State the required validation for a future pin change. Keep the workflow contract tests aligned with the documented pin.
A pin moves forward, neat and bright,
The workflow follows it outright.
Tests track the hash in every place,
A wrong-pin check keeps up the pace.
Whitaker starts with a newer trace.
Comment @coderabbitai help to get the list of available commands.
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey - I've found 1 issue
Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments
### Comment 1
<location path=".github/workflows/ci.yml" line_range="93" />
<code_context>
markdownlint-cli2 --version
- name: Install Whitaker
- uses: leynos/shared-actions/.github/actions/install-whitaker@2ddf19b3fd52c0f1089db0d57b015f859b80ab67
+ uses: leynos/shared-actions/.github/actions/install-whitaker@5a99aed78ce68dcebd3052b75c31e6f173162b1e # shared-actions 5a99aed7 (whitaker-installer 0.2.11)
- name: Lint
run: make lint
</code_context>
<issue_to_address>
**Installer decision goes undocumented**
When the CI Whitaker installer pin changes to 0.2.11, the workflow now selects whitaker-installer 0.2.11, but the developer guide only describes Whitaker's generic cold-driver bootstrap and does not record this version or why it was selected. Contributors therefore cannot use the project guidance to identify the installer behind the CI route or the Clippy snapshot fix.
Update the Whitaker tooling guidance to record the new installer choice and its cold-driver build behavior.
</issue_to_address>| markdownlint-cli2 --version | ||
| - name: Install Whitaker | ||
| uses: leynos/shared-actions/.github/actions/install-whitaker@2ddf19b3fd52c0f1089db0d57b015f859b80ab67 | ||
| uses: leynos/shared-actions/.github/actions/install-whitaker@5a99aed78ce68dcebd3052b75c31e6f173162b1e # shared-actions 5a99aed7 (whitaker-installer 0.2.11) |
There was a problem hiding this comment.
⚪ Low · Installer decision goes undocumented
When the CI Whitaker installer pin changes to 0.2.11, the workflow now selects whitaker-installer 0.2.11, but the developer guide only describes Whitaker's generic cold-driver bootstrap and does not record this version or why it was selected. Contributors therefore cannot use the project guidance to identify the installer behind the CI route or the Clippy snapshot fix.
Update the Whitaker tooling guidance to record the new installer choice and its cold-driver build behavior.
Prompt for AI agents
In `.github/workflows/ci.yml` at line 93:
**Installer decision goes undocumented**
When the CI Whitaker installer pin changes to 0.2.11, the workflow now selects whitaker-installer 0.2.11, but the developer guide only describes Whitaker's generic cold-driver bootstrap and does not record this version or why it was selected. Contributors therefore cannot use the project guidance to identify the installer behind the CI route or the Clippy snapshot fix.
Update the Whitaker tooling guidance to record the new installer choice and its cold-driver build behavior.From AGENTS.md L38-41:
- **Update:** When new decisions are made, requirements change, libraries are
added/removed, or architectural patterns evolve, **proactively update** the
relevant file(s) in the `docs/` directory to reflect the latest state.
**Ensure the documentation remains accurate and current.**![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Part of DF12-89
Repins
leynos/shared-actions/.github/actions/install-whitakerto5a99aed78ce68dcebd3052b75c31e6f173162b1e(shared-actions #651, approved as a root by concordat QG-002, leynos/concordat#331). The action then defaults to whitaker-installer 0.2.11, which builds the Dylint driver from a verified Clippy snapshot: upstream Dylint 6.0.1 clones Clippy'smaster, which no longer exists, so every cold Whitaker driver build fails.Also the pinned
ACTIONand the wrong-pin mutation intests/workflow_contracts/whitaker_provisioning_test.pyandwhitaker_provisioning_mutations_test.py.Other Whitaker paths
No bare
cargo dylint,cargo binstall whitakeror hand-rolled installer outside the action and thewhitakerwrapper.Notes
A cache-restored driver rebuilds once (about a minute); that is expected. Gate: CI green on the lint lane at the head, with the lint job's log read for Whitaker's diagnostics.
Summary by Sourcery
Repin the Whitaker CI installation action and its workflow contracts to restore reliable lint provisioning.
Bug Fixes:
CI:
Tests: