Repository navigation
fix(scope): quote mission name in NOTES.md frontmatter - #768
Conversation
A mission title containing ": " (or #, quotes, a leading -) was written
unquoted into NOTES.md, producing invalid YAML that `rig workspace
validate` rejected. Write it via JSON.stringify as {{mission_name_yaml}},
matching how {{intent_yaml}} is written; the heading keeps the raw title.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
(cherry picked from commit 8764bf1)
|
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 configuration
📒 Files selected for processing (4)
Included review availability: This review used your included allowance. Your plan provides up to 8 included reviews per hour; 7 remain after this review. 📝 WalkthroughWalkthroughThe NOTES frontmatter template now uses a YAML-specific mission-name placeholder. The placeholder substitution JSON-stringifies the mission name. Tests check quoted output and frontmatter validation for a title containing YAML-special characters. ChangesNOTES frontmatter
Priority: ⬇️ Low Estimated code review effort: 2 (Simple) | ~10 minutes Change: Bug fix Suggested reviewers: Merge Risk: ⚪ Minimal · up to This change quotes mission names in generated NOTES frontmatter, and targeted test success is reported. No material merge risk is identified. Architecture SummaryArchitecture risk: 🔵 Low · up to The change affects 1 system. Changed systems: Architecture concerns Review detailsSystems and components
Before / after behavior
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
Full details: Docstring CoverageExplanation Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 3 files. (1 skipped: 1 unsupported.)
✨ Finishing Touches🧪 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 |
|
Thanks, @adampog. On current main, the NOTES.md template does write the mission name unquoted ( |
openrig-review
left a comment
There was a problem hiding this comment.
Approved at c6d38bb. A mission name containing : , #, quotes or a leading - no longer produces NOTES.md frontmatter that rig workspace validate rejects: the template's name: is now written with JSON.stringify, a valid YAML double-quoted scalar. Plain names read back the same through both YAML parsers, existing NOTES.md files are untouched (they're only rendered when none exists), and the # Notes — heading keeps the raw name. It also fixes the same problem when a mission's intent sentence becomes the name. All 8 required checks pass. Thank you.
— dev60-planner@v-openrig-build
|
Merged, thanks @adampog. Mission names containing |
What a user gets
Before: a mission whose title contains
:(or#, quotes, or a leading-) was written unquoted intoNOTES.mdfrontmatter, which is invalid YAML, sorig workspace validaterejected the new mission. After: the name is written quoted (viaJSON.stringify, as{{mission_name_yaml}}, matching how{{intent_yaml}}is already written). The heading keeps the raw title.How you verified it
On
b5a9deaf(currentmain) plus this commit, Node 24.21.0, Linux:npx vitest run test/scope-commands.test.ts test/scope-convention-scaffold.test.tsinpackages/cli: 2 files, 105 tests passed, including a new case with a colon in the title.npm run lint: passed.Not run: the full
npm testandnpm run test:ui.Anything you were unsure about
Nothing in particular.
CHANGELOG.mdeditMade with an agent team (Claude Code and Codex), with an independent QA pass before submission.
🤖 Generated with Claude Code
Summary by CodeRabbit