Files
msd-core/get-shit-done/workflows/insert-phase.md
Tom Boucher 303fd26b45 fix(#2662): add state.add-roadmap-evolution SDK handler; insert-phase uses it (#2683)
/gsd-insert-phase step 4 instructed the agent to directly Edit/Write
.planning/STATE.md to append a Roadmap Evolution entry. Projects that
ship a protect-files.sh PreToolUse hook (a recommended hardening
pattern) blocked the raw write, silently leaving STATE.md out of sync
with ROADMAP.md.

Adds a dedicated SDK handler state.add-roadmap-evolution (plus space
alias) that:

  - Reads STATE.md through the shared readModifyWriteStateMd lockfile
    path (matches sibling mutation handlers — atomic against
    concurrent writers).
  - Locates ### Roadmap Evolution under ## Accumulated Context, or
    creates both sections as needed.
  - Dedupes on exact-line match so idempotent retries are no-ops
    ({ added: false, reason: "duplicate" }).
  - Validates --phase / --action presence and action membership,
    throwing GSDError(Validation) for bad input (no silent
    { ok: false } swallow).

Workflow change (insert-phase.md step 4):

  - Replaces the raw Edit/Write instructions for STATE.md with
    gsd-sdk query state.patch (for the next-phase pointer) and
    gsd-sdk query state.add-roadmap-evolution (for the evolution
    log).
  - Updates success criteria to check handler responses.
  - Drops "Write" from commands/gsd/insert-phase.md allowed-tools
    (no step in the workflow needs it any more).

Tests (vitest, sdk/src/query/state-mutation.test.ts): subsection
creation when missing; append-preserving-order when present;
duplicate -> reason=duplicate; idempotence over two calls; three
validation cases covering missing --phase, missing --action, and
invalid action.

This is the first SDK handler dedicated to STATE.md Roadmap
Evolution mutations. Other workflows with similar raw STATE.md
edits (/gsd-pause-work, /gsd-resume-work, /gsd-new-project,
/gsd-complete-milestone, /gsd-add-phase) remain on raw Edit/Write
and will need follow-up issues to migrate — out of scope for this
fix.

Closes #2662
2026-04-24 20:20:02 -04:00

4.3 KiB

Insert a decimal phase for urgent work discovered mid-milestone between existing integer phases. Uses decimal numbering (72.1, 72.2, etc.) to preserve the logical sequence of planned phases while accommodating urgent insertions without renumbering the entire roadmap.

<required_reading> Read all files referenced by the invoking prompt's execution_context before starting. </required_reading>

Parse the command arguments: - First argument: integer phase number to insert after - Remaining arguments: phase description

Example: /gsd:insert-phase 72 Fix critical auth bug -> after = 72 -> description = "Fix critical auth bug"

If arguments missing:

ERROR: Both phase number and description required
Usage: /gsd:insert-phase <after> <description>
Example: /gsd:insert-phase 72 Fix critical auth bug

Exit.

Validate first argument is an integer.

Load phase operation context:
INIT=$(gsd-sdk query init.phase-op "${after_phase}")
if [[ "$INIT" == @file:* ]]; then INIT=$(cat "${INIT#@file:}"); fi

Check roadmap_exists from init JSON. If false:

ERROR: No roadmap found (.planning/ROADMAP.md)

Exit.

**Delegate the phase insertion to `gsd-sdk query phase.insert`:**
RESULT=$(gsd-sdk query phase.insert "${after_phase}" "${description}")

The CLI handles:

  • Verifying target phase exists in ROADMAP.md
  • Calculating next decimal phase number (checking existing decimals on disk)
  • Generating slug from description
  • Creating the phase directory (.planning/phases/{N.M}-{slug}/)
  • Inserting the phase entry into ROADMAP.md after the target phase with (INSERTED) marker

Extract from result: phase_number, after_phase, name, slug, directory.

Update STATE.md to reflect the inserted phase via SDK handlers (never raw `Edit`/`Write` — projects may ship a `protect-files.sh` PreToolUse hook that blocks direct STATE.md writes):
  1. Update STATE.md's next-phase pointer(s) to the newly inserted phase {decimal_phase}:

    gsd-sdk query state.patch '{"Current Phase":"{decimal_phase}","Next recommended run":"/gsd:plan-phase {decimal_phase}"}'
    

    (Adjust field names to whatever pointers STATE.md exposes — the handler reports which fields it matched.)

  2. Append a Roadmap Evolution entry via the dedicated handler. It creates the ### Roadmap Evolution subsection under ## Accumulated Context if missing and dedupes identical entries:

    gsd-sdk query state.add-roadmap-evolution \
      --phase {decimal_phase} \
      --action inserted \
      --after {after_phase} \
      --note "{description}" \
      --urgent
    

    Expected response shape: { added: true, entry: "- Phase ... (URGENT)" } (or { added: false, reason: "duplicate", entry: ... } on replay).

Present completion summary:
Phase {decimal_phase} inserted after Phase {after_phase}:
- Description: {description}
- Directory: .planning/phases/{decimal-phase}-{slug}/
- Status: Not planned yet
- Marker: (INSERTED) - indicates urgent work

Roadmap updated: .planning/ROADMAP.md
Project state updated: .planning/STATE.md

---

## Next Up

**Phase {decimal_phase}: {description}** -- urgent insertion

`/clear` then:

`/gsd:plan-phase {decimal_phase}`

---

**Also available:**
- Review insertion impact: Check if Phase {next_integer} dependencies still make sense
- Review roadmap

---

<anti_patterns>

  • Don't use this for planned work at end of milestone (use /gsd:add-phase)
  • Don't insert before Phase 1 (decimal 0.1 makes no sense)
  • Don't renumber existing phases
  • Don't modify the target phase content
  • Don't create plans yet (that's /gsd:plan-phase)
  • Don't commit changes (user decides when to commit) </anti_patterns>

<success_criteria> Phase insertion is complete when:

  • gsd-sdk query phase.insert executed successfully
  • Phase directory created
  • Roadmap updated with new phase entry (includes "(INSERTED)" marker)
  • gsd-sdk query state.add-roadmap-evolution ... returned { added: true } or { added: false, reason: "duplicate" }
  • gsd-sdk query state.patch returned matched next-phase pointer field(s)
  • User informed of next steps and dependency implications </success_criteria>