* enhancement(#40): integrate branch pruning into /gsd-cleanup archival workflow Adds a prune_local_branches step to cleanup.md (between archive_phases and commit) that force-deletes local branches whose upstream is gone — keeping local clones symmetric with delete_branch_on_merge on GitHub. Key design choices vs. PR #562 (the local-model draft): - dry-run step shows stale branches using cached tracking refs only; git fetch --prune is deferred to the execution step so the dry-run is non-side-effecting - awk uses { if ($1 != "*") print $1 } form to explicitly exclude the currently checked-out branch (the * prefix in git branch -vv output), not a prose note that lets xargs receive literal * as an argument - git fetch --prune runs exactly once, in prune_local_branches, eliminating the TOCTOU window between a preview fetch and an execution fetch - two new negative-contract tests: identify_completed_milestones must not run git branch commands; show_dry_run must not run git fetch --prune Closes #40 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * chore: regenerate changeset using repo script (correct format) Replaces hand-written fragment (used `/** ... */` comment syntax) with one generated by `npm run changeset -- --type Changed --pr 562`. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * fix: address codex review blockers — protect main/next/trunk, align dry-run with execution Codex adversarial review (pre-PR gate) flagged two blockers: 1. awk filter only excluded '*' (current branch) but not protected names. main/next/trunk/develop could be force-deleted if their upstream was gone. Fix: use !~ /^\*$|^main$|^next$|^trunk$|^develop$/ regex match. 2. Dry-run enumerated from cached tracking refs; execution re-ran git fetch --prune, creating a TOCTOU window between what the user confirmed and what got deleted. Fix: move git fetch --prune into show_dry_run (prefetch for display accuracy); prune_local_branches now enumerates from the already-fetched state with no second fetch. Updated 14 structural tests to match new design (added protected-name exclusion test; inverted show_dry_run fetch assertion). Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> --------- Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
196 lines
6.2 KiB
Markdown
196 lines
6.2 KiB
Markdown
<purpose>
|
|
|
|
Archive accumulated phase directories from completed milestones into `.planning/milestones/v{X.Y}-phases/`. Identifies which phases belong to each completed milestone, shows a dry-run summary, and moves directories on confirmation.
|
|
|
|
</purpose>
|
|
|
|
<required_reading>
|
|
|
|
1. `.planning/MILESTONES.md`
|
|
2. `.planning/milestones/` directory listing
|
|
3. `.planning/phases/` directory listing
|
|
|
|
</required_reading>
|
|
|
|
<process>
|
|
|
|
<step name="identify_completed_milestones">
|
|
|
|
Read `.planning/MILESTONES.md` to identify completed milestones and their versions.
|
|
|
|
```bash
|
|
cat .planning/MILESTONES.md
|
|
```
|
|
|
|
Extract each milestone version (e.g., v1.0, v1.1, v2.0).
|
|
|
|
Check which milestone archive dirs already exist:
|
|
|
|
```bash
|
|
ls -d .planning/milestones/v*-phases 2>/dev/null || true
|
|
```
|
|
|
|
Filter to milestones that do NOT already have a `-phases` archive directory.
|
|
|
|
If all milestones already have phase archives:
|
|
|
|
```
|
|
All completed milestones already have phase directories archived. Nothing to clean up.
|
|
```
|
|
|
|
Stop here.
|
|
|
|
</step>
|
|
|
|
<step name="determine_phase_membership">
|
|
|
|
For each completed milestone without a `-phases` archive, read the archived ROADMAP snapshot to determine which phases belong to it:
|
|
|
|
```bash
|
|
cat .planning/milestones/v{X.Y}-ROADMAP.md
|
|
```
|
|
|
|
Extract phase numbers and names from the archived roadmap (e.g., Phase 1: Foundation, Phase 2: Auth).
|
|
|
|
Check which of those phase directories still exist in `.planning/phases/`:
|
|
|
|
```bash
|
|
ls -d .planning/phases/*/ 2>/dev/null || true
|
|
```
|
|
|
|
Match phase directories to milestone membership. Only include directories that still exist in `.planning/phases/`.
|
|
|
|
</step>
|
|
|
|
<step name="show_dry_run">
|
|
|
|
Present a dry-run summary for each milestone:
|
|
|
|
```
|
|
## Cleanup Summary
|
|
|
|
### v{X.Y} — {Milestone Name}
|
|
These phase directories will be archived:
|
|
- 01-foundation/
|
|
- 02-auth/
|
|
- 03-core-features/
|
|
|
|
Destination: .planning/milestones/v{X.Y}-phases/
|
|
|
|
### v{X.Z} — {Milestone Name}
|
|
These phase directories will be archived:
|
|
- 04-security/
|
|
- 05-hardening/
|
|
|
|
Destination: .planning/milestones/v{X.Z}-phases/
|
|
```
|
|
|
|
**Stale local branches (upstream gone):**
|
|
|
|
First, update remote-tracking refs so the candidate list matches the execution list exactly:
|
|
|
|
```bash
|
|
git fetch --prune 2>/dev/null || true
|
|
```
|
|
|
|
Then enumerate candidates (protected branch names are excluded even if their upstream is gone):
|
|
|
|
```bash
|
|
git branch -vv | awk '/: gone\]/ { if ($1 !~ /^\*$|^main$|^next$|^trunk$|^develop$/) print $1 }'
|
|
```
|
|
|
|
Show each branch name. If none, show:
|
|
|
|
```
|
|
No stale local branches detected.
|
|
```
|
|
|
|
If no phase directories remain to archive (all already moved or deleted) AND no stale branches exist:
|
|
|
|
```
|
|
No phase directories found to archive. Phases may have been removed or archived previously.
|
|
No stale local branches detected either.
|
|
```
|
|
|
|
Stop here.
|
|
|
|
|
|
**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: "Proceed with archiving and pruning?" with options: "Yes — archive phases and prune stale branches" | "Cancel"
|
|
|
|
If "Cancel": Stop.
|
|
|
|
</step>
|
|
|
|
<step name="archive_phases">
|
|
|
|
For each milestone, move phase directories:
|
|
|
|
```bash
|
|
mkdir -p .planning/milestones/v{X.Y}-phases
|
|
```
|
|
|
|
For each phase directory belonging to this milestone:
|
|
|
|
```bash
|
|
mv .planning/phases/{dir} .planning/milestones/v{X.Y}-phases/
|
|
```
|
|
|
|
Repeat for all milestones in the cleanup set.
|
|
|
|
</step>
|
|
|
|
<step name="prune_local_branches">
|
|
|
|
After phase archival, prune local branches whose upstream has been deleted. Use the same filter as the dry-run so the execution list matches exactly what the user confirmed:
|
|
|
|
```bash
|
|
git branch -vv | awk '/: gone\]/ { if ($1 !~ /^\*$|^main$|^next$|^trunk$|^develop$/) print $1 }' | xargs -r git branch -D
|
|
```
|
|
|
|
Notes:
|
|
- `git fetch --prune` already ran in `show_dry_run` — the tracking refs are current and this step enumerates from the same state the user confirmed.
|
|
- `!~ /^\*$/` skips the currently checked-out branch (prefixed with `* ` in `git branch -vv` output, so `$1` yields `*`).
|
|
- `!~ /^main$|^next$|^trunk$|^develop$/` excludes protected branch names even if their upstream is gone — matches the dry-run exclusion exactly.
|
|
- `xargs -r` prevents `git branch -D` from running with no arguments when no stale branches exist.
|
|
|
|
</step>
|
|
|
|
<step name="commit">
|
|
|
|
Commit the changes:
|
|
|
|
```bash
|
|
_GSD_SHIM_NAME="gsd-tools.cjs"; _GSD_RUNTIME_ROOT="${RUNTIME_DIR:-$(git rev-parse --show-toplevel 2>/dev/null || pwd)}"; GSD_TOOLS="${_GSD_RUNTIME_ROOT}/get-shit-done/bin/${_GSD_SHIM_NAME}"; if [ -f "$GSD_TOOLS" ]; then gsd_run() { node "$GSD_TOOLS" "$@"; }; elif [ -f "${_GSD_RUNTIME_ROOT}/.claude/get-shit-done/bin/${_GSD_SHIM_NAME}" ]; then GSD_TOOLS="${_GSD_RUNTIME_ROOT}/.claude/get-shit-done/bin/${_GSD_SHIM_NAME}"; gsd_run() { node "$GSD_TOOLS" "$@"; }; elif command -v gsd-tools >/dev/null 2>&1; then GSD_TOOLS="$(command -v gsd-tools)"; gsd_run() { "$GSD_TOOLS" "$@"; }; elif [ -f "$HOME/.claude/get-shit-done/bin/${_GSD_SHIM_NAME}" ]; then GSD_TOOLS="$HOME/.claude/get-shit-done/bin/${_GSD_SHIM_NAME}"; gsd_run() { node "$GSD_TOOLS" "$@"; }; else echo "ERROR: gsd-tools.cjs not found at $GSD_TOOLS and gsd-tools is not on PATH. Run: npx -y @opengsd/gsd-core@latest --claude --local" >&2; exit 1; fi
|
|
gsd_run query commit "chore: archive phase directories from completed milestones" --files .planning/milestones/ .planning/phases/
|
|
```
|
|
|
|
</step>
|
|
|
|
<step name="report">
|
|
|
|
```
|
|
Archived:
|
|
{For each milestone}
|
|
- v{X.Y}: {N} phase directories → .planning/milestones/v{X.Y}-phases/
|
|
|
|
Pruned: {N} local branches whose upstream is gone.
|
|
|
|
.planning/phases/ cleaned up.
|
|
```
|
|
|
|
</step>
|
|
|
|
</process>
|
|
|
|
<success_criteria>
|
|
|
|
- [ ] All completed milestones without existing phase archives identified
|
|
- [ ] Phase membership determined from archived ROADMAP snapshots
|
|
- [ ] Dry-run summary shown and user confirmed (covers both archival and pruning)
|
|
- [ ] Phase directories moved to `.planning/milestones/v{X.Y}-phases/`
|
|
- [ ] Stale local branches pruned (branches whose upstream is gone)
|
|
- [ ] Changes committed
|
|
|
|
</success_criteria>
|