State the Pin Comment as the Release Tag and Define $/ - #1885
Conversation
The action pinning rule prescribed a `# vX.Y.Z` comment, which a pin to a repository whose release tags carry no `v` cannot honor without naming a tag that does not exist. State the comment as the release tag at the pinned SHA, spelled as the referenced repository publishes it, and bring WORKFLOW.md D9.1 into agreement. Both statements also exempted a `$/` reference without saying what it is, so name it as GitHub's self-repository path syntax, resolved at the containing workflow file's own commit. Closes on promotion: #1805 Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
Apply the release-tag spelling rule to the major-only comment too, drop an unverifiable Dependabot rationale, use a constructed bare tag in the example, scope the `$/` definition to a workflow file, and update the prose-lint test docstring that restated the old rule. Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
|
Navigate logical layers of code changes, visualize relationships, and explore their blast radius. No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository: ptr727/ProjectTemplate/.coderabbit.yaml Review profile: CHILL Plan: Advanced Run ID: ⛔ Files ignored due to path filters (3)
📒 Files selected for processing (4)
Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review. 📝 WalkthroughWalkthroughThe workflow guidance now requires SHA-pin comments to use the referenced repository’s exact release-tag spelling. It clarifies that ChangesWorkflow pinning guidance
Priority: ⬇️ Low Estimated code review effort: 2 (Simple) | ~10 minutes Merge Risk: ⚪ Minimal · up to This change clarifies workflow pinning guidance without changing test behavior; the generated copies and their digest are consistent. No actionable merge risk remains. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
The changes consistently update the documented contract and its generated copies without introducing behavioral code changes or internal inconsistencies.
Review effort: Lite
Findings: None
What changed in this PR
This PR updates the fleet workflow pinning documentation to require that the trailing pin comment match the referenced repository’s published release tag spelling (including repositories whose tags do not use a v prefix), and it defines the previously undocumented $/ self-repository uses: syntax. It then propagates the updated contract wording to the workflow CI contract reference copies and refreshes a prose-lint test docstring that referenced the old rule.
Changes:
- Update
GOVERNANCE.mdandWORKFLOW.mdto require release-tag-accurate pin comments (instead of prescribingvX.Y.Zunconditionally) and to define$/. - Regenerate/refresh the
workflow-ci-contractD9.1 reference text in the skill distribution copies and update the corresponding source digest. - Adjust a prose-lint test docstring to reflect the broadened pin-comment rule.
| File | Description |
|---|---|
| WORKFLOW.md | Updates D9.1 to require a release-tag-accurate comment and defines $/ for workflow-file self-repo resolution. |
| scripts/tests/test_prose_lint.py | Updates the docstring describing the pin-comment rule so it no longer implies only v-prefixed tags. |
| GOVERNANCE.md | Refines the Action pinning rule to require comments that match the upstream’s tag spelling, and defines $/ in workflow files. |
| .github/skills/workflow-ci-contract/references/d-guarantees.md | Regenerated skill copy reflecting the updated D9.1 wording. |
| .claude-plugin/fleet-skills/skills/workflow-ci-contract/references/d-guarantees.md | Regenerated plugin skill copy reflecting the updated D9.1 wording. |
| .claude-plugin/fleet-skills/.source-digests/workflow-ci-contract | Updates the recorded source digest to match the regenerated workflow-ci-contract content. |
| .agents/skills/workflow-ci-contract/references/d-guarantees.md | Updates the skill source reference text for D9.1 to match the new contract wording. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
@coderabbitai review |
✅ Action performedReview finished.
|
The action pinning rule in
GOVERNANCE.md"Workflow YAML Conventions" prescribed a# vX.Y.Zcomment, which a pin to a repository whose release tags carry novcannot honor without naming a tag that does not exist. It also exempted a$/reference without saying what$/is.$/as GitHub's workflow-file syntax for a path in the repository holding that file, resolved at that file's own commit.WORKFLOW.mdD9.1 into agreement, regenerate theworkflow-ci-contractinclude copies, and update a prose-lint test docstring that restated the old rule.Closes on promotion: #1805
🤖 Generated with Claude Code
Summary by CodeRabbit
$/workflow references are resolved. Local and self-repository references still do not require a pin.dotnet/nbgv@masterexception.