docs(skill): add versioning policy — prevents prerelease version incidents#117
docs(skill): add versioning policy — prevents prerelease version incidents#117
Conversation
Codifies semver versioning rules for SDK and CLI packages: - MAJOR.MINOR.PATCH only on dev/main (no prerelease suffixes) - bump-build.mjs -build.N versions are local-only, never committed - SDK + CLI versions must stay in sync (workspace resolution footgun) - Surgeon owns version bumps; other agents hands-off - prerelease-version-guard CI gate enforces the policy Motivated by PR bradygaster#640 (prerelease broke workspace resolution) and PR #116 (prerelease leak on release branch). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
🔧 EECOM CODE REVIEW PR #117 - versioning-policy skill documentation Review Summary✅ APPROVED — Technical accuracy verified on npm workspace semver footgun, bump-build.mjs behavior, and SKIP_BUILD_BUMP workaround. Detailed Findings1. npm Workspace Semver Footgun ✅The documentation correctly describes the critical semver vulnerability (§4):
|
|
📣 PAO DevRel Review — PR #117 Overall Assessment✅ Clarity & Readability: Excellent Strengths1. Excellent Context & ClarityThe skill document excels at explaining why the policy exists. The incident reference (PR bradygaster#640) is particularly valuable — it grounds the abstract rules in a concrete failure scenario that new contributors can understand. A contributor reading this will immediately grasp why "prerelease versions break workspace resolution" is not just a rule, but a learned lesson. 2. Accessible Incident NarrativeThe PR bradygaster#640 explanation (§8) is genuinely helpful:
3. Strong Template Compliance
4. Practical, Actionable RulesThe ownership matrix (§5) is clear:
The lifecycle diagram (§6) is a nice visual anchor for understanding version state transitions. Minor Suggestions for Improvement1. Typo in SKILL.md, Line 25–26The `scripts/bump-build.mjs` script creates `-build.N` versions (e.g., `0.9.1-build.4`) for **local development testing
g only**.→ Should be: 2. Line 30–31 Formatting IssueBoth `@bradygaster/squad-sdk` and `@bradygaster/squad-cli` **MUST have the same version** at all times. The root `packa
ge.json` version must also match.→ Should be: 3. Line 33–34 Line Break Issue`bump-build.mjs` enforces this by updating all three `package.json` files in lockstep (root + `packages/squad-sdk` + `p
packages/squad-cli`).→ Should be: 4. Inconsistent Line Break in §4Lines 52–53 have similar wrapping artifacts. Suggests the markdown may have been reformatted or pasted with word-wrap issues. 5. Consider Adding Anti-Patterns SectionThe document is strong on what to do, but an explicit anti-patterns section would reinforce lessons:
6. Decision File Could Link Back to SkillThe decision file references the skill ("Full policy documented in New Contributor PerspectiveA new Squad member reading this would:
The skill is contributor-ready with minor formatting cleanup. RecommendationMerge with minor fixes:
The core policy is well-reasoned, clearly explained, and will prevent similar incidents. The investment in narrative and incident context is exactly what makes skills effective for onboarding and compliance. PAO signing off — nicely done, Flight. ✨ |
|
⚙️ Booster (CI/CD Engineer) Review: PR #117 — Versioning Policy Documentation SummaryThe versioning policy SKILL is well-written and comprehensively documents the constraints that the CI gates in PR #115 enforce. I found the documentation to be accurate and complete — no critical gaps between the policy and CI enforcement. Alignment with CI Gates (PR #115)✅ Fully Aligned. The policy correctly references and explains all three version-related gates:
|
|
🧪 FIDO Quality Review — PR #117 Versioning Policy Skill SummaryThis PR documents critical versioning policies that prevented the PR bradygaster#640 workspace resolution incident. The skill is well-structured and addresses the semver footgun comprehensively. Overall: Strong foundation with actionability gap. Completeness vs. PR bradygaster#640 Incident ✅PR bradygaster#640 failure modes covered:
Additional incidents addressed:
Accuracy of Semver Claims ✅Verified against code:
Critical concern: The skill claims Actionability
|
Documents versioning rules to prevent prerelease version incidents. Closes #117 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Documents versioning rules. Fork PR: diberry#117. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
Merged upstream as bradygaster#692 |
Versioning Policy Skill
Adds .squad/skills/versioning-policy/SKILL.md — a comprehensive versioning policy for the Squad monorepo.
Why this is needed
The repo had no documented versioning policy, which caused two incidents: