855 lines
25 KiB
Markdown
855 lines
25 KiB
Markdown
<purpose>
|
|
|
|
Mark a shipped version (v1.0, v1.1, v2.0) as complete. Creates historical record in MILESTONES.md, performs full PROJECT.md evolution review, reorganizes ROADMAP.md with milestone groupings, and tags the release in git.
|
|
|
|
</purpose>
|
|
|
|
<required_reading>
|
|
|
|
1. templates/milestone.md
|
|
2. templates/milestone-archive.md
|
|
3. `.planning/ROADMAP.md`
|
|
4. `.planning/REQUIREMENTS.md`
|
|
5. `.planning/PROJECT.md`
|
|
|
|
</required_reading>
|
|
|
|
<archival_behavior>
|
|
|
|
When a milestone completes:
|
|
|
|
1. Extract full milestone details to `.planning/milestones/v[X.Y]-ROADMAP.md`
|
|
2. Archive requirements to `.planning/milestones/v[X.Y]-REQUIREMENTS.md`
|
|
3. Update ROADMAP.md — overwrite in place with milestone grouping (preserve Backlog section)
|
|
4. Safety commit archive files + updated ROADMAP.md, then `git rm REQUIREMENTS.md` (fresh for next milestone)
|
|
5. Perform full PROJECT.md evolution review
|
|
6. Offer to create next milestone inline
|
|
7. Archive UI artifacts (`*-UI-SPEC.md`, `*-UI-REVIEW.md`) alongside other phase documents
|
|
8. Clean up `.planning/ui-reviews/` screenshot files (binary assets, never archived)
|
|
|
|
**Context Efficiency:** Archives keep ROADMAP.md constant-size and REQUIREMENTS.md milestone-scoped.
|
|
|
|
**ROADMAP archive** uses `templates/milestone-archive.md` — includes milestone header (status, phases, date), full phase details, milestone summary (decisions, issues, tech debt).
|
|
|
|
**REQUIREMENTS archive** contains all requirements marked complete with outcomes, traceability table with final status, notes on changed requirements.
|
|
|
|
</archival_behavior>
|
|
|
|
<process>
|
|
|
|
<step name="pre_close_artifact_audit">
|
|
Before proceeding with milestone close, run the comprehensive open artifact audit.
|
|
|
|
```bash
|
|
gsd-sdk query audit-open
|
|
```
|
|
|
|
If the output contains open items (any section with count > 0):
|
|
|
|
Display the full audit report to the user.
|
|
|
|
Then ask:
|
|
```
|
|
These items are open. Choose an action:
|
|
[R] Resolve — stop and fix items, then re-run /gsd:complete-milestone
|
|
[A] Acknowledge all — document as deferred and proceed with close
|
|
[C] Cancel — exit without closing
|
|
```
|
|
|
|
If user chooses [A] (Acknowledge):
|
|
1. Re-run `gsd-sdk query audit-open --json` to get structured data
|
|
2. Write acknowledged items to STATE.md under `## Deferred Items` section:
|
|
```markdown
|
|
## Deferred Items
|
|
|
|
Items acknowledged and deferred at milestone close on {date}:
|
|
|
|
| Category | Item | Status |
|
|
|----------|------|--------|
|
|
| debug | {slug} | {status} |
|
|
| quick_task | {slug} | {status} |
|
|
...
|
|
```
|
|
Sanitize all slug and status values via `sanitizeForDisplay()` before writing. Never inject raw file content into STATE.md.
|
|
3. Record in MILESTONES.md entry: `Known deferred items at close: {count} (see STATE.md Deferred Items)`
|
|
4. Proceed with milestone close.
|
|
|
|
If output shows all clear (no open items): print `All artifact types clear.` and proceed.
|
|
|
|
SECURITY: Audit JSON output is structured data from the `audit-open` query handler (same JSON contract as legacy `gsd-tools.cjs audit-open`) — validated and sanitized at source. When writing to STATE.md, item slugs and descriptions are sanitized via `sanitizeForDisplay()` before inclusion. Never inject raw user-supplied content into STATE.md without sanitization.
|
|
</step>
|
|
|
|
<step name="verify_readiness">
|
|
|
|
**Use `roadmap analyze` for comprehensive readiness check:**
|
|
|
|
```bash
|
|
ROADMAP=$(gsd-sdk query roadmap.analyze)
|
|
```
|
|
|
|
This returns all phases with plan/summary counts and disk status. Use this to verify:
|
|
- Which phases belong to this milestone?
|
|
- All phases complete (all plans have summaries)? Check `disk_status === 'complete'` for each.
|
|
- `progress_percent` should be 100%.
|
|
|
|
**Requirements completion check (REQUIRED before presenting):**
|
|
|
|
Parse REQUIREMENTS.md traceability table:
|
|
- Count total v1 requirements vs checked-off (`[x]`) requirements
|
|
- Identify any non-Complete rows in the traceability table
|
|
|
|
Present:
|
|
|
|
```
|
|
Milestone: [Name, e.g., "v1.0 MVP"]
|
|
|
|
Includes:
|
|
- Phase 1: Foundation (2/2 plans complete)
|
|
- Phase 2: Authentication (2/2 plans complete)
|
|
- Phase 3: Core Features (3/3 plans complete)
|
|
- Phase 4: Polish (1/1 plan complete)
|
|
|
|
Total: {phase_count} phases, {total_plans} plans, all complete
|
|
Requirements: {N}/{M} v1 requirements checked off
|
|
```
|
|
|
|
**If requirements incomplete** (N < M):
|
|
|
|
```
|
|
⚠ Unchecked Requirements:
|
|
|
|
- [ ] {REQ-ID}: {description} (Phase {X})
|
|
- [ ] {REQ-ID}: {description} (Phase {Y})
|
|
```
|
|
|
|
MUST present 3 options:
|
|
1. **Proceed anyway** — mark milestone complete with known gaps
|
|
2. **Run audit first** — `/gsd:audit-milestone` to assess gap severity
|
|
3. **Abort** — return to development
|
|
|
|
If user selects "Proceed anyway": note incomplete requirements in MILESTONES.md under `### Known Gaps` with REQ-IDs and descriptions.
|
|
|
|
<config-check>
|
|
|
|
```bash
|
|
cat .planning/config.json 2>/dev/null || true
|
|
```
|
|
|
|
</config-check>
|
|
|
|
<if mode="yolo">
|
|
|
|
```
|
|
⚡ Auto-approved: Milestone scope verification
|
|
[Show breakdown summary without prompting]
|
|
Proceeding to stats gathering...
|
|
```
|
|
|
|
Proceed to gather_stats.
|
|
|
|
</if>
|
|
|
|
<if mode="interactive" OR="custom with gates.confirm_milestone_scope true">
|
|
|
|
```
|
|
Ready to mark this milestone as shipped?
|
|
(yes / wait / adjust scope)
|
|
```
|
|
|
|
Wait for confirmation.
|
|
- "adjust scope": Ask which phases to include.
|
|
- "wait": Stop, user returns when ready.
|
|
|
|
</if>
|
|
|
|
</step>
|
|
|
|
<step name="gather_stats">
|
|
|
|
Calculate milestone statistics:
|
|
|
|
```bash
|
|
git log --oneline --grep="feat(" | head -20
|
|
git diff --stat FIRST_COMMIT..LAST_COMMIT | tail -1
|
|
find . -name "*.swift" -o -name "*.ts" -o -name "*.py" | xargs wc -l 2>/dev/null || true
|
|
git log --format="%ai" FIRST_COMMIT | tail -1
|
|
git log --format="%ai" LAST_COMMIT | head -1
|
|
```
|
|
|
|
Present:
|
|
|
|
```
|
|
Milestone Stats:
|
|
- Phases: [X-Y]
|
|
- Plans: [Z] total
|
|
- Tasks: [N] total (from phase summaries)
|
|
- Files modified: [M]
|
|
- Lines of code: [LOC] [language]
|
|
- Timeline: [Days] days ([Start] → [End])
|
|
- Git range: feat(XX-XX) → feat(YY-YY)
|
|
```
|
|
|
|
</step>
|
|
|
|
<step name="extract_accomplishments">
|
|
|
|
Extract one-liners from SUMMARY.md files using summary-extract:
|
|
|
|
```bash
|
|
# For each phase in milestone, extract one-liner
|
|
for summary in .planning/phases/*-*/*-SUMMARY.md; do
|
|
[ -e "$summary" ] || continue
|
|
gsd-sdk query summary-extract "$summary" --fields one_liner --pick one_liner
|
|
done
|
|
```
|
|
|
|
Extract 4-6 key accomplishments. Present:
|
|
|
|
```
|
|
Key accomplishments for this milestone:
|
|
1. [Achievement from phase 1]
|
|
2. [Achievement from phase 2]
|
|
3. [Achievement from phase 3]
|
|
4. [Achievement from phase 4]
|
|
5. [Achievement from phase 5]
|
|
```
|
|
|
|
</step>
|
|
|
|
<step name="create_milestone_entry">
|
|
|
|
**Note:** MILESTONES.md entry is now created automatically by `gsd-sdk query milestone.complete` in the archive_milestone step. The entry includes version, date, phase/plan/task counts, and accomplishments extracted from SUMMARY.md files.
|
|
|
|
If additional details are needed (e.g., user-provided "Delivered" summary, git range, LOC stats), add them manually after the CLI creates the base entry.
|
|
|
|
</step>
|
|
|
|
<step name="evolve_project_full_review">
|
|
|
|
Full PROJECT.md evolution review at milestone completion.
|
|
|
|
Read all phase summaries:
|
|
|
|
```bash
|
|
cat .planning/phases/*-*/*-SUMMARY.md
|
|
```
|
|
|
|
**Full review checklist:**
|
|
|
|
1. **"What This Is" accuracy:**
|
|
- Compare current description to what was built
|
|
- Update if product has meaningfully changed
|
|
|
|
2. **Core Value check:**
|
|
- Still the right priority? Did shipping reveal a different core value?
|
|
- Update if the ONE thing has shifted
|
|
|
|
3. **Requirements audit:**
|
|
|
|
**Validated section:**
|
|
- All Active requirements shipped this milestone → Move to Validated
|
|
- Format: `- ✓ [Requirement] — v[X.Y]`
|
|
|
|
**Active section:**
|
|
- Remove requirements moved to Validated
|
|
- Add new requirements for next milestone
|
|
- Keep unaddressed requirements
|
|
|
|
**Out of Scope audit:**
|
|
- Review each item — reasoning still valid?
|
|
- Remove irrelevant items
|
|
- Add requirements invalidated during milestone
|
|
|
|
4. **Context update:**
|
|
- Current codebase state (LOC, tech stack)
|
|
- User feedback themes (if any)
|
|
- Known issues or technical debt
|
|
|
|
5. **Key Decisions audit:**
|
|
- Extract all decisions from milestone phase summaries
|
|
- Add to Key Decisions table with outcomes
|
|
- Mark ✓ Good, ⚠️ Revisit, or — Pending
|
|
|
|
6. **Constraints check:**
|
|
- Any constraints changed during development? Update as needed
|
|
|
|
Update PROJECT.md inline. Update "Last updated" footer:
|
|
|
|
```markdown
|
|
---
|
|
*Last updated: [date] after v[X.Y] milestone*
|
|
```
|
|
|
|
**Example full evolution (v1.0 → v1.1 prep):**
|
|
|
|
Before:
|
|
|
|
```markdown
|
|
## What This Is
|
|
|
|
A real-time collaborative whiteboard for remote teams.
|
|
|
|
## Core Value
|
|
|
|
Real-time sync that feels instant.
|
|
|
|
## Requirements
|
|
|
|
### Validated
|
|
|
|
(None yet — ship to validate)
|
|
|
|
### Active
|
|
|
|
- [ ] Canvas drawing tools
|
|
- [ ] Real-time sync < 500ms
|
|
- [ ] User authentication
|
|
- [ ] Export to PNG
|
|
|
|
### Out of Scope
|
|
|
|
- Mobile app — web-first approach
|
|
- Video chat — use external tools
|
|
```
|
|
|
|
After v1.0:
|
|
|
|
```markdown
|
|
## What This Is
|
|
|
|
A real-time collaborative whiteboard for remote teams with instant sync and drawing tools.
|
|
|
|
## Core Value
|
|
|
|
Real-time sync that feels instant.
|
|
|
|
## Requirements
|
|
|
|
### Validated
|
|
|
|
- ✓ Canvas drawing tools — v1.0
|
|
- ✓ Real-time sync < 500ms — v1.0 (achieved 200ms avg)
|
|
- ✓ User authentication — v1.0
|
|
|
|
### Active
|
|
|
|
- [ ] Export to PNG
|
|
- [ ] Undo/redo history
|
|
- [ ] Shape tools (rectangles, circles)
|
|
|
|
### Out of Scope
|
|
|
|
- Mobile app — web-first approach, PWA works well
|
|
- Video chat — use external tools
|
|
- Offline mode — real-time is core value
|
|
|
|
## Context
|
|
|
|
Shipped v1.0 with 2,400 LOC TypeScript.
|
|
Tech stack: Next.js, Supabase, Canvas API.
|
|
Initial user testing showed demand for shape tools.
|
|
```
|
|
|
|
**Step complete when:**
|
|
|
|
- [ ] "What This Is" reviewed and updated if needed
|
|
- [ ] Core Value verified as still correct
|
|
- [ ] All shipped requirements moved to Validated
|
|
- [ ] New requirements added to Active for next milestone
|
|
- [ ] Out of Scope reasoning audited
|
|
- [ ] Context updated with current state
|
|
- [ ] All milestone decisions added to Key Decisions
|
|
- [ ] "Last updated" footer reflects milestone completion
|
|
|
|
</step>
|
|
|
|
<step name="reorganize_roadmap">
|
|
|
|
Update `.planning/ROADMAP.md` — group completed milestone phases:
|
|
|
|
```markdown
|
|
# Roadmap: [Project Name]
|
|
|
|
## Milestones
|
|
|
|
- ✅ **v1.0 MVP** — Phases 1-4 (shipped YYYY-MM-DD)
|
|
- 🚧 **v1.1 Security** — Phases 5-6 (in progress)
|
|
- 📋 **v2.0 Redesign** — Phases 7-10 (planned)
|
|
|
|
## Phases
|
|
|
|
<details>
|
|
<summary>✅ v1.0 MVP (Phases 1-4) — SHIPPED YYYY-MM-DD</summary>
|
|
|
|
- [x] Phase 1: Foundation (2/2 plans) — completed YYYY-MM-DD
|
|
- [x] Phase 2: Authentication (2/2 plans) — completed YYYY-MM-DD
|
|
- [x] Phase 3: Core Features (3/3 plans) — completed YYYY-MM-DD
|
|
- [x] Phase 4: Polish (1/1 plan) — completed YYYY-MM-DD
|
|
|
|
</details>
|
|
|
|
### 🚧 v[Next] [Name] (In Progress / Planned)
|
|
|
|
- [ ] Phase 5: [Name] ([N] plans)
|
|
- [ ] Phase 6: [Name] ([N] plans)
|
|
|
|
## Progress
|
|
|
|
| Phase | Milestone | Plans Complete | Status | Completed |
|
|
| ----------------- | --------- | -------------- | ----------- | ---------- |
|
|
| 1. Foundation | v1.0 | 2/2 | Complete | YYYY-MM-DD |
|
|
| 2. Authentication | v1.0 | 2/2 | Complete | YYYY-MM-DD |
|
|
| 3. Core Features | v1.0 | 3/3 | Complete | YYYY-MM-DD |
|
|
| 4. Polish | v1.0 | 1/1 | Complete | YYYY-MM-DD |
|
|
| 5. Security Audit | v1.1 | 0/1 | Not started | - |
|
|
| 6. Hardening | v1.1 | 0/2 | Not started | - |
|
|
```
|
|
|
|
</step>
|
|
|
|
<step name="archive_milestone">
|
|
|
|
**Delegate archival to `gsd-sdk query milestone.complete`:**
|
|
|
|
```bash
|
|
ARCHIVE=$(gsd-sdk query milestone.complete "v[X.Y]" --name "[Milestone Name]")
|
|
```
|
|
|
|
The CLI handles:
|
|
- Creating `.planning/milestones/` directory
|
|
- Archiving ROADMAP.md to `milestones/v[X.Y]-ROADMAP.md`
|
|
- Archiving REQUIREMENTS.md to `milestones/v[X.Y]-REQUIREMENTS.md` with archive header
|
|
- Moving audit file to milestones if it exists
|
|
- Creating/appending MILESTONES.md entry with accomplishments from SUMMARY.md files
|
|
- Updating STATE.md (status, last activity)
|
|
|
|
Extract from result: `version`, `date`, `phases`, `plans`, `tasks`, `accomplishments`, `archived`.
|
|
|
|
Verify: `✅ Milestone archived to .planning/milestones/`
|
|
|
|
**Phase archival (optional):** After archival completes, ask the user:
|
|
|
|
|
|
**Text mode (`workflow.text_mode: true` in config or `--text` flag):** Set `TEXT_MODE=true` if `--text` is present in `$ARGUMENTS` OR `text_mode` from init JSON is `true`. When TEXT_MODE is active, replace every `AskUserQuestion` call with a plain-text numbered list and ask the user to type their choice number. This is required for non-Claude runtimes (OpenAI Codex, Gemini CLI, etc.) where `AskUserQuestion` is not available.
|
|
AskUserQuestion(header="Archive Phases", question="Archive phase directories to milestones/?", options: "Yes — move to milestones/v[X.Y]-phases/" | "Skip — keep phases in place")
|
|
|
|
If "Yes": move phase directories to the milestone archive:
|
|
```bash
|
|
mkdir -p .planning/milestones/v[X.Y]-phases
|
|
# For each phase directory in .planning/phases/:
|
|
mv .planning/phases/{phase-dir} .planning/milestones/v[X.Y]-phases/
|
|
```
|
|
Verify: `✅ Phase directories archived to .planning/milestones/v[X.Y]-phases/`
|
|
|
|
If "Skip": Phase directories remain in `.planning/phases/` as raw execution history. Use `/gsd:cleanup` later to archive retroactively.
|
|
|
|
After archival, the AI still handles:
|
|
- Reorganizing ROADMAP.md with milestone grouping (requires judgment) — overwrite in place after extracting Backlog section
|
|
- Full PROJECT.md evolution review (requires understanding)
|
|
- Safety commit of archive files + updated ROADMAP.md, then `git rm .planning/REQUIREMENTS.md`
|
|
- These are NOT fully delegated because they require AI interpretation of content
|
|
|
|
</step>
|
|
|
|
<step name="reorganize_roadmap_and_delete_originals">
|
|
|
|
After `milestone complete` has archived, reorganize ROADMAP.md with milestone groupings, then commit archives as a safety checkpoint before removing originals.
|
|
|
|
**Backlog preservation — do this FIRST before rewriting ROADMAP.md:**
|
|
|
|
Extract the Backlog section from the current ROADMAP.md before making any changes:
|
|
|
|
```bash
|
|
# Extract lines under ## Backlog through end of file (or next ## section)
|
|
BACKLOG_SECTION=$(awk '/^## Backlog/{found=1} found{print}' .planning/ROADMAP.md)
|
|
```
|
|
|
|
If `$BACKLOG_SECTION` is empty, there is no Backlog section — skip silently.
|
|
|
|
**Reorganize ROADMAP.md** — overwrite in place (do NOT delete first) with milestone groupings:
|
|
|
|
```markdown
|
|
# Roadmap: [Project Name]
|
|
|
|
## Milestones
|
|
|
|
- ✅ **v1.0 MVP** — Phases 1-4 (shipped YYYY-MM-DD)
|
|
- 🚧 **v1.1 Security** — Phases 5-6 (in progress)
|
|
|
|
## Phases
|
|
|
|
<details>
|
|
<summary>✅ v1.0 MVP (Phases 1-4) — SHIPPED YYYY-MM-DD</summary>
|
|
|
|
- [x] Phase 1: Foundation (2/2 plans) — completed YYYY-MM-DD
|
|
- [x] Phase 2: Authentication (2/2 plans) — completed YYYY-MM-DD
|
|
|
|
</details>
|
|
```
|
|
|
|
**Re-append Backlog section after the rewrite** (only if `$BACKLOG_SECTION` was non-empty):
|
|
|
|
Append the extracted Backlog content verbatim to the end of the newly written ROADMAP.md. This ensures 999.x backlog items are never silently dropped during milestone reorganization.
|
|
|
|
**Safety commit — commit archive files BEFORE deleting any originals:**
|
|
|
|
```bash
|
|
gsd-sdk query commit "chore: archive v[X.Y] milestone files" --files .planning/milestones/v[X.Y]-ROADMAP.md .planning/milestones/v[X.Y]-REQUIREMENTS.md .planning/milestones/v[X.Y]-MILESTONE-AUDIT.md .planning/MILESTONES.md .planning/PROJECT.md .planning/STATE.md .planning/ROADMAP.md
|
|
```
|
|
|
|
This creates a durable checkpoint in git history. If anything fails after this point, the working tree can be reconstructed from git.
|
|
|
|
**Remove REQUIREMENTS.md via git rm** (preserves history, stages deletion atomically):
|
|
|
|
```bash
|
|
git rm .planning/REQUIREMENTS.md
|
|
```
|
|
|
|
</step>
|
|
|
|
<step name="write_retrospective">
|
|
|
|
**Append to living retrospective:**
|
|
|
|
Check for existing retrospective:
|
|
```bash
|
|
ls .planning/RETROSPECTIVE.md 2>/dev/null || true
|
|
```
|
|
|
|
**If exists:** Read the file, append new milestone section before the "## Cross-Milestone Trends" section.
|
|
|
|
**If doesn't exist:** Create from template at `~/.claude/get-shit-done/templates/retrospective.md`.
|
|
|
|
**Gather retrospective data:**
|
|
|
|
1. From SUMMARY.md files: Extract key deliverables, one-liners, tech decisions
|
|
2. From VERIFICATION.md files: Extract verification scores, gaps found
|
|
3. From UAT.md files: Extract test results, issues found
|
|
4. From git log: Count commits, calculate timeline
|
|
5. From the milestone work: Reflect on what worked and what didn't
|
|
|
|
**Write the milestone section:**
|
|
|
|
```markdown
|
|
## Milestone: v{version} — {name}
|
|
|
|
**Shipped:** {date}
|
|
**Phases:** {phase_count} | **Plans:** {plan_count}
|
|
|
|
### What Was Built
|
|
{Extract from SUMMARY.md one-liners}
|
|
|
|
### What Worked
|
|
{Patterns that led to smooth execution}
|
|
|
|
### What Was Inefficient
|
|
{Missed opportunities, rework, bottlenecks}
|
|
|
|
### Patterns Established
|
|
{New conventions discovered during this milestone}
|
|
|
|
### Key Lessons
|
|
{Specific, actionable takeaways}
|
|
|
|
### Cost Observations
|
|
- Model mix: {X}% opus, {Y}% sonnet, {Z}% haiku
|
|
- Sessions: {count}
|
|
- Notable: {efficiency observation}
|
|
```
|
|
|
|
**Update cross-milestone trends:**
|
|
|
|
If the "## Cross-Milestone Trends" section exists, update the tables with new data from this milestone.
|
|
|
|
**Commit:**
|
|
```bash
|
|
gsd-sdk query commit "docs: update retrospective for v${VERSION}" --files .planning/RETROSPECTIVE.md
|
|
```
|
|
|
|
</step>
|
|
|
|
<step name="update_state">
|
|
|
|
Most STATE.md updates were handled by `milestone complete`, but verify and update remaining fields:
|
|
|
|
**Project Reference:**
|
|
|
|
```markdown
|
|
## Project Reference
|
|
|
|
See: .planning/PROJECT.md (updated [today])
|
|
|
|
**Core value:** [Current core value from PROJECT.md]
|
|
**Current focus:** [Next milestone or "Planning next milestone"]
|
|
```
|
|
|
|
**Accumulated Context:**
|
|
- Clear decisions summary (full log in PROJECT.md)
|
|
- Clear resolved blockers
|
|
- Keep open blockers for next milestone
|
|
|
|
</step>
|
|
|
|
<step name="handle_branches">
|
|
|
|
Check branching strategy and offer merge options.
|
|
|
|
Use `init milestone-op` for context, or load config directly:
|
|
|
|
```bash
|
|
INIT=$(gsd-sdk query init.execute-phase "1")
|
|
if [[ "$INIT" == @file:* ]]; then INIT=$(cat "${INIT#@file:}"); fi
|
|
```
|
|
|
|
Extract `branching_strategy`, `phase_branch_template`, `milestone_branch_template`, and `commit_docs` from init JSON.
|
|
|
|
Detect base branch:
|
|
```bash
|
|
BASE_BRANCH=$(gsd-sdk query config-get git.base_branch 2>/dev/null || echo "")
|
|
if [ -z "$BASE_BRANCH" ] || [ "$BASE_BRANCH" = "null" ]; then
|
|
BASE_BRANCH=$(git symbolic-ref refs/remotes/origin/HEAD 2>/dev/null | sed 's|^refs/remotes/origin/||')
|
|
BASE_BRANCH="${BASE_BRANCH:-main}"
|
|
fi
|
|
```
|
|
|
|
**If "none":** Skip to git_tag.
|
|
|
|
**For "phase" strategy:**
|
|
|
|
```bash
|
|
BRANCH_PREFIX=$(echo "$PHASE_BRANCH_TEMPLATE" | sed 's/{.*//')
|
|
PHASE_BRANCHES=$(git branch --list "${BRANCH_PREFIX}*" 2>/dev/null | sed 's/^\*//' | tr -d ' ')
|
|
```
|
|
|
|
**For "milestone" strategy:**
|
|
|
|
```bash
|
|
BRANCH_PREFIX=$(echo "$MILESTONE_BRANCH_TEMPLATE" | sed 's/{.*//')
|
|
MILESTONE_BRANCH=$(git branch --list "${BRANCH_PREFIX}*" 2>/dev/null | sed 's/^\*//' | tr -d ' ' | head -1)
|
|
```
|
|
|
|
**If no branches found:** Skip to git_tag.
|
|
|
|
**If branches exist:**
|
|
|
|
```
|
|
## Git Branches Detected
|
|
|
|
Branching strategy: {phase/milestone}
|
|
Branches: {list}
|
|
|
|
Options:
|
|
1. **Merge to main** — Merge branch(es) to main
|
|
2. **Delete without merging** — Already merged or not needed
|
|
3. **Keep branches** — Leave for manual handling
|
|
```
|
|
|
|
AskUserQuestion with options: Squash merge (Recommended), Merge with history, Delete without merging, Keep branches.
|
|
|
|
**Squash merge:**
|
|
|
|
```bash
|
|
CURRENT_BRANCH=$(git branch --show-current)
|
|
git checkout ${BASE_BRANCH}
|
|
|
|
if [ "$BRANCHING_STRATEGY" = "phase" ]; then
|
|
for branch in $PHASE_BRANCHES; do
|
|
git merge --squash "$branch"
|
|
# Strip .planning/ from staging if commit_docs is false
|
|
if [ "$COMMIT_DOCS" = "false" ]; then
|
|
git reset HEAD .planning/ 2>/dev/null || true
|
|
fi
|
|
git commit -m "feat: $branch for v[X.Y]"
|
|
done
|
|
fi
|
|
|
|
if [ "$BRANCHING_STRATEGY" = "milestone" ]; then
|
|
git merge --squash "$MILESTONE_BRANCH"
|
|
# Strip .planning/ from staging if commit_docs is false
|
|
if [ "$COMMIT_DOCS" = "false" ]; then
|
|
git reset HEAD .planning/ 2>/dev/null || true
|
|
fi
|
|
git commit -m "feat: $MILESTONE_BRANCH for v[X.Y]"
|
|
fi
|
|
|
|
git checkout "$CURRENT_BRANCH"
|
|
```
|
|
|
|
**Merge with history:**
|
|
|
|
```bash
|
|
CURRENT_BRANCH=$(git branch --show-current)
|
|
git checkout ${BASE_BRANCH}
|
|
|
|
if [ "$BRANCHING_STRATEGY" = "phase" ]; then
|
|
for branch in $PHASE_BRANCHES; do
|
|
git merge --no-ff --no-commit "$branch"
|
|
# Strip .planning/ from staging if commit_docs is false
|
|
if [ "$COMMIT_DOCS" = "false" ]; then
|
|
git reset HEAD .planning/ 2>/dev/null || true
|
|
fi
|
|
git commit -m "Merge branch '$branch' for v[X.Y]"
|
|
done
|
|
fi
|
|
|
|
if [ "$BRANCHING_STRATEGY" = "milestone" ]; then
|
|
git merge --no-ff --no-commit "$MILESTONE_BRANCH"
|
|
# Strip .planning/ from staging if commit_docs is false
|
|
if [ "$COMMIT_DOCS" = "false" ]; then
|
|
git reset HEAD .planning/ 2>/dev/null || true
|
|
fi
|
|
git commit -m "Merge branch '$MILESTONE_BRANCH' for v[X.Y]"
|
|
fi
|
|
|
|
git checkout "$CURRENT_BRANCH"
|
|
```
|
|
|
|
**Delete without merging:**
|
|
|
|
```bash
|
|
if [ "$BRANCHING_STRATEGY" = "phase" ]; then
|
|
for branch in $PHASE_BRANCHES; do
|
|
git branch -d "$branch" 2>/dev/null || git branch -D "$branch"
|
|
done
|
|
fi
|
|
|
|
if [ "$BRANCHING_STRATEGY" = "milestone" ]; then
|
|
git branch -d "$MILESTONE_BRANCH" 2>/dev/null || git branch -D "$MILESTONE_BRANCH"
|
|
fi
|
|
```
|
|
|
|
**Keep branches:** Report "Branches preserved for manual handling"
|
|
|
|
</step>
|
|
|
|
<step name="git_tag">
|
|
|
|
<config-check>
|
|
Read `git.create_tag` via `gsd-sdk query config-get git.create_tag 2>/dev/null || echo "true"`.
|
|
If the result is `false` → skip this step entirely and proceed to `git_commit_milestone`.
|
|
</config-check>
|
|
|
|
Create git tag:
|
|
|
|
```bash
|
|
# Pre-check: skip if tag already exists (prevents silent failure on retry)
|
|
if git rev-parse "v[X.Y]" >/dev/null 2>&1; then echo "Tag v[X.Y] already exists, skipping"; exit 0; fi
|
|
git tag -a v[X.Y] -m "v[X.Y] [Name]
|
|
|
|
Delivered: [One sentence]
|
|
|
|
Key accomplishments:
|
|
- [Item 1]
|
|
- [Item 2]
|
|
- [Item 3]
|
|
|
|
See .planning/MILESTONES.md for full details."
|
|
```
|
|
|
|
Confirm: "Tagged: v[X.Y]"
|
|
|
|
Ask: "Push tag to remote? (y/n)"
|
|
|
|
If yes:
|
|
```bash
|
|
git push origin v[X.Y]
|
|
```
|
|
|
|
</step>
|
|
|
|
<step name="git_commit_milestone">
|
|
|
|
Commit the REQUIREMENTS.md deletion (archive files and ROADMAP.md were already committed in the safety commit in `reorganize_roadmap_and_delete_originals`).
|
|
|
|
```bash
|
|
git commit -m "chore: remove REQUIREMENTS.md for v[X.Y] milestone"
|
|
```
|
|
|
|
Confirm: "Committed: chore: remove REQUIREMENTS.md for v[X.Y] milestone"
|
|
|
|
</step>
|
|
|
|
<step name="offer_next">
|
|
|
|
```
|
|
✅ Milestone v[X.Y] [Name] complete
|
|
|
|
Shipped:
|
|
- [N] phases ([M] plans, [P] tasks)
|
|
- [One sentence of what shipped]
|
|
|
|
Archived:
|
|
- milestones/v[X.Y]-ROADMAP.md
|
|
- milestones/v[X.Y]-REQUIREMENTS.md
|
|
|
|
Summary: .planning/MILESTONES.md
|
|
Tag: v[X.Y]
|
|
|
|
---
|
|
|
|
## ▶ Next Up — [${PROJECT_CODE}] ${PROJECT_TITLE}
|
|
|
|
**Start Next Milestone** — questioning → research → requirements → roadmap
|
|
|
|
`/clear` then:
|
|
|
|
`/gsd:new-milestone`
|
|
|
|
---
|
|
```
|
|
|
|
</step>
|
|
|
|
</process>
|
|
|
|
<milestone_naming>
|
|
|
|
**Version conventions:**
|
|
- **v1.0** — Initial MVP
|
|
- **v1.1, v1.2** — Minor updates, new features, fixes
|
|
- **v2.0, v3.0** — Major rewrites, breaking changes, new direction
|
|
|
|
**Names:** Short 1-2 words (v1.0 MVP, v1.1 Security, v1.2 Performance, v2.0 Redesign).
|
|
|
|
</milestone_naming>
|
|
|
|
<what_qualifies>
|
|
|
|
**Create milestones for:** Initial release, public releases, major feature sets shipped, before archiving planning.
|
|
|
|
**Don't create milestones for:** Every phase completion (too granular), work in progress, internal dev iterations (unless truly shipped).
|
|
|
|
Heuristic: "Is this deployed/usable/shipped?" If yes → milestone. If no → keep working.
|
|
|
|
</what_qualifies>
|
|
|
|
<success_criteria>
|
|
|
|
Milestone completion is successful when:
|
|
|
|
- [ ] Pre-close artifact audit run and output shown to user
|
|
- [ ] Deferred items recorded in STATE.md if user acknowledged
|
|
- [ ] Known deferred items count noted in MILESTONES.md entry
|
|
|
|
- [ ] MILESTONES.md entry created with stats and accomplishments
|
|
- [ ] PROJECT.md full evolution review completed
|
|
- [ ] All shipped requirements moved to Validated in PROJECT.md
|
|
- [ ] Key Decisions updated with outcomes
|
|
- [ ] ROADMAP.md Backlog section extracted before rewrite, re-appended after (skipped if absent)
|
|
- [ ] ROADMAP.md reorganized with milestone grouping (overwritten in place, not deleted)
|
|
- [ ] Roadmap archive created (milestones/v[X.Y]-ROADMAP.md)
|
|
- [ ] Requirements archive created (milestones/v[X.Y]-REQUIREMENTS.md)
|
|
- [ ] Safety commit made (archive files + updated ROADMAP.md) BEFORE deleting REQUIREMENTS.md
|
|
- [ ] REQUIREMENTS.md removed via `git rm` (fresh for next milestone, history preserved)
|
|
- [ ] STATE.md updated with fresh project reference
|
|
- [ ] Git tag created (v[X.Y]) (if `git.create_tag` enabled)
|
|
- [ ] Milestone commit made (includes archive files and deletion)
|
|
- [ ] Requirements completion checked against REQUIREMENTS.md traceability table
|
|
- [ ] Incomplete requirements surfaced with proceed/audit/abort options
|
|
- [ ] Known gaps recorded in MILESTONES.md if user proceeded with incomplete requirements
|
|
- [ ] RETROSPECTIVE.md updated with milestone section
|
|
- [ ] Cross-milestone trends updated
|
|
- [ ] User knows next step (/gsd:new-milestone)
|
|
|
|
</success_criteria>
|