|
|
|
|
@@ -1,71 +1,58 @@
|
|
|
|
|
---
|
|
|
|
|
name: finishing-a-development-branch
|
|
|
|
|
description: Use when implementation is complete, all tests pass, and you need to decide how to integrate the work - guides completion of development work by presenting structured options for merge, PR, or cleanup
|
|
|
|
|
description: Use when implementation is complete, all tests pass, and you need to decide how to integrate the work
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
# Finishing a Development Branch
|
|
|
|
|
|
|
|
|
|
## Overview
|
|
|
|
|
|
|
|
|
|
Guide completion of development work by presenting clear options and handling chosen workflow.
|
|
|
|
|
|
|
|
|
|
**Core principle:** Verify tests → Detect environment → Present options → Execute choice → Clean up.
|
|
|
|
|
|
|
|
|
|
**Announce at start:** "I'm using the finishing-a-development-branch skill to complete this work."
|
|
|
|
|
|
|
|
|
|
## The Process
|
|
|
|
|
## Step 1: Verify Tests
|
|
|
|
|
|
|
|
|
|
### Step 1: Verify Tests
|
|
|
|
|
Run the project's full test suite (`npm test` / `cargo test` / `pytest` / `go test ./...`).
|
|
|
|
|
|
|
|
|
|
**Before presenting options, verify tests pass:**
|
|
|
|
|
**If tests fail**, report the failures and stop — the menu comes after a green suite:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
# Run project's test suite
|
|
|
|
|
npm test / cargo test / pytest / go test ./...
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
**If tests fail:**
|
|
|
|
|
```
|
|
|
|
|
Tests failing (<N> failures). Must fix before completing:
|
|
|
|
|
|
|
|
|
|
[Show failures]
|
|
|
|
|
|
|
|
|
|
Cannot proceed with merge/PR until tests pass.
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Stop. Don't proceed to Step 2.
|
|
|
|
|
**If tests pass:** continue to Step 2.
|
|
|
|
|
|
|
|
|
|
**If tests pass:** Continue to Step 2.
|
|
|
|
|
|
|
|
|
|
### Step 2: Detect Environment
|
|
|
|
|
|
|
|
|
|
**Determine workspace state before presenting options:**
|
|
|
|
|
## Step 2: Detect Environment
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
GIT_DIR=$(cd "$(git rev-parse --git-dir)" 2>/dev/null && pwd -P)
|
|
|
|
|
GIT_COMMON=$(cd "$(git rev-parse --git-common-dir)" 2>/dev/null && pwd -P)
|
|
|
|
|
# Capture now, while still inside the workspace — Step 5 changes directory
|
|
|
|
|
# before cleanup (Step 6) needs this value
|
|
|
|
|
WORKTREE_PATH=$(git rev-parse --show-toplevel)
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
This determines which menu to show and how cleanup works:
|
|
|
|
|
|
|
|
|
|
| State | Menu | Cleanup |
|
|
|
|
|
|-------|------|---------|
|
|
|
|
|
| `GIT_DIR == GIT_COMMON` (normal repo) | Standard 4 options | No worktree to clean up |
|
|
|
|
|
| `GIT_DIR != GIT_COMMON`, named branch | Standard 4 options | Provenance-based (see Step 6) |
|
|
|
|
|
| `GIT_DIR != GIT_COMMON`, detached HEAD | Reduced 3 options (no merge) | No cleanup (externally managed) |
|
|
|
|
|
| `GIT_DIR == GIT_COMMON` (normal repo) | Standard 3 options | No worktree to clean up |
|
|
|
|
|
| `GIT_DIR != GIT_COMMON`, named branch | Standard 3 options | Provenance-based (see Step 6) |
|
|
|
|
|
| `GIT_DIR != GIT_COMMON`, detached HEAD | Reduced 2 options (no merge) | Externally managed — leave in place |
|
|
|
|
|
|
|
|
|
|
### Step 3: Determine Base Branch
|
|
|
|
|
## Step 3: Determine Base Branch
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
# Try common base branches
|
|
|
|
|
git merge-base HEAD main 2>/dev/null || git merge-base HEAD master 2>/dev/null
|
|
|
|
|
```
|
|
|
|
|
The base branch is whatever this work forked from — usually named in the
|
|
|
|
|
plan, the conversation, or the branch's upstream. If it is not already
|
|
|
|
|
known, ask: "This branch split from <your best guess> - is that correct?"
|
|
|
|
|
Confirm before merging: merging into the wrong base is expensive to undo.
|
|
|
|
|
|
|
|
|
|
Or ask: "This branch split from main - is that correct?"
|
|
|
|
|
## Step 4: Present Options
|
|
|
|
|
|
|
|
|
|
### Step 4: Present Options
|
|
|
|
|
|
|
|
|
|
**Normal repo and named-branch worktree — present exactly these 4 options:**
|
|
|
|
|
**Normal repo and named-branch worktree — present exactly these 3 options:**
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
Implementation complete. What would you like to do?
|
|
|
|
|
@@ -73,28 +60,30 @@ Implementation complete. What would you like to do?
|
|
|
|
|
1. Merge back to <base-branch> locally
|
|
|
|
|
2. Push and create a Pull Request
|
|
|
|
|
3. Keep the branch as-is (I'll handle it later)
|
|
|
|
|
4. Discard this work
|
|
|
|
|
|
|
|
|
|
Which option?
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
**Detached HEAD — present exactly these 3 options:**
|
|
|
|
|
**Detached HEAD — present exactly these 2 options:**
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
Implementation complete. You're on a detached HEAD (externally managed workspace).
|
|
|
|
|
|
|
|
|
|
1. Push as new branch and create a Pull Request
|
|
|
|
|
2. Keep as-is (I'll handle it later)
|
|
|
|
|
3. Discard this work
|
|
|
|
|
|
|
|
|
|
Which option?
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
**Don't add explanation** - keep options concise.
|
|
|
|
|
Present the menu exactly as written — concise, with every option coming
|
|
|
|
|
from the list above. Discarding the work happens only in response to your
|
|
|
|
|
human partner explicitly asking for it (see "If your human partner asks to
|
|
|
|
|
discard the work" below). Wait for their answer; the integration decision
|
|
|
|
|
is theirs.
|
|
|
|
|
|
|
|
|
|
### Step 5: Execute Choice
|
|
|
|
|
## Step 5: Execute Choice
|
|
|
|
|
|
|
|
|
|
#### Option 1: Merge Locally
|
|
|
|
|
### Option 1: Merge Locally
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
# Get main repo root for CWD safety
|
|
|
|
|
@@ -108,34 +97,43 @@ git merge <feature-branch>
|
|
|
|
|
|
|
|
|
|
# Verify tests on merged result
|
|
|
|
|
<test command>
|
|
|
|
|
|
|
|
|
|
# Only after merge succeeds: cleanup worktree (Step 6), then delete branch
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Then: Cleanup worktree (Step 6), then delete branch:
|
|
|
|
|
If tests fail on the merged result: stop, leave the worktree and branch in
|
|
|
|
|
place, and investigate — nothing has been pushed, so the merge is local
|
|
|
|
|
and recoverable.
|
|
|
|
|
|
|
|
|
|
Once the merged result is green: clean up the worktree (Step 6), then
|
|
|
|
|
delete the branch:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
git branch -d <feature-branch>
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
#### Option 2: Push and Create PR
|
|
|
|
|
### Option 2: Push and Create PR
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
# Push branch
|
|
|
|
|
git push -u origin <feature-branch>
|
|
|
|
|
# From a detached HEAD, name the new branch on the remote:
|
|
|
|
|
# git push origin HEAD:refs/heads/<new-branch>
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
**Do NOT clean up worktree** — user needs it alive to iterate on PR feedback.
|
|
|
|
|
Then create the pull/merge request against <base-branch> with the forge's
|
|
|
|
|
tooling — its CLI if one is available, or the creation URL most forges
|
|
|
|
|
print when you push — following the repo's PR template and conventions if
|
|
|
|
|
present, and report the URL to your human partner.
|
|
|
|
|
|
|
|
|
|
#### Option 3: Keep As-Is
|
|
|
|
|
Keep the worktree — your human partner iterates on PR feedback there.
|
|
|
|
|
|
|
|
|
|
### Option 3: Keep As-Is
|
|
|
|
|
|
|
|
|
|
Report: "Keeping branch <name>. Worktree preserved at <path>."
|
|
|
|
|
|
|
|
|
|
**Don't cleanup worktree.**
|
|
|
|
|
### If your human partner asks to discard the work
|
|
|
|
|
|
|
|
|
|
#### Option 4: Discard
|
|
|
|
|
This path exists only as a response to an explicit request to throw the
|
|
|
|
|
work away. Confirm first:
|
|
|
|
|
|
|
|
|
|
**Confirm first:**
|
|
|
|
|
```
|
|
|
|
|
This will permanently delete:
|
|
|
|
|
- Branch <name>
|
|
|
|
|
@@ -145,41 +143,39 @@ This will permanently delete:
|
|
|
|
|
Type 'discard' to confirm.
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Wait for exact confirmation.
|
|
|
|
|
Wait for that exact confirmation. When it arrives:
|
|
|
|
|
|
|
|
|
|
If confirmed:
|
|
|
|
|
```bash
|
|
|
|
|
MAIN_ROOT=$(git -C "$(git rev-parse --git-common-dir)/.." rev-parse --show-toplevel)
|
|
|
|
|
cd "$MAIN_ROOT"
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Then: Cleanup worktree (Step 6), then force-delete branch:
|
|
|
|
|
Then clean up the worktree (Step 6) and force-delete the branch:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
git branch -D <feature-branch>
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Step 6: Cleanup Workspace
|
|
|
|
|
## Step 6: Cleanup Workspace
|
|
|
|
|
|
|
|
|
|
**Only runs for Options 1 and 4.** Options 2 and 3 always preserve the worktree.
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
GIT_DIR=$(cd "$(git rev-parse --git-dir)" 2>/dev/null && pwd -P)
|
|
|
|
|
GIT_COMMON=$(cd "$(git rev-parse --git-common-dir)" 2>/dev/null && pwd -P)
|
|
|
|
|
WORKTREE_PATH=$(git rev-parse --show-toplevel)
|
|
|
|
|
```
|
|
|
|
|
**Runs for Option 1 and confirmed discards.** Options 2 and 3 always
|
|
|
|
|
preserve the worktree. Both callers have already changed directory to the
|
|
|
|
|
main repo root — worktree removal must run from outside the worktree —
|
|
|
|
|
and use the `GIT_DIR`/`GIT_COMMON`/`WORKTREE_PATH` values captured in
|
|
|
|
|
Step 2, from before that directory change.
|
|
|
|
|
|
|
|
|
|
**If `GIT_DIR == GIT_COMMON`:** Normal repo, no worktree to clean up. Done.
|
|
|
|
|
|
|
|
|
|
**If worktree path is under `.worktrees/` or `worktrees/`:** Superpowers created this worktree — we own cleanup.
|
|
|
|
|
**If `WORKTREE_PATH` is under `.worktrees/` or `worktrees/`:** Superpowers
|
|
|
|
|
created this worktree — we own cleanup:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
MAIN_ROOT=$(git -C "$(git rev-parse --git-common-dir)/.." rev-parse --show-toplevel)
|
|
|
|
|
cd "$MAIN_ROOT"
|
|
|
|
|
git worktree remove "$WORKTREE_PATH"
|
|
|
|
|
git worktree prune # Self-healing: clean up any stale registrations
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
**Otherwise:** The host environment (harness) owns this workspace. Do NOT remove it. If your platform provides a workspace-exit tool, use it. Otherwise, leave the workspace in place.
|
|
|
|
|
**Otherwise:** The host environment owns this workspace — leave it in
|
|
|
|
|
place. If your platform provides a workspace-exit tool, use it.
|
|
|
|
|
|
|
|
|
|
## Quick Reference
|
|
|
|
|
|
|
|
|
|
@@ -188,54 +184,18 @@ git worktree prune # Self-healing: clean up any stale registrations
|
|
|
|
|
| 1. Merge locally | yes | - | - | yes |
|
|
|
|
|
| 2. Create PR | - | yes | yes | - |
|
|
|
|
|
| 3. Keep as-is | - | - | yes | - |
|
|
|
|
|
| 4. Discard | - | - | - | yes (force) |
|
|
|
|
|
| Discard (explicit request only) | - | - | - | yes (force) |
|
|
|
|
|
|
|
|
|
|
## Common Mistakes
|
|
|
|
|
## Common Rationalizations
|
|
|
|
|
|
|
|
|
|
**Skipping test verification**
|
|
|
|
|
- **Problem:** Merge broken code, create failing PR
|
|
|
|
|
- **Fix:** Always verify tests before offering options
|
|
|
|
|
|
|
|
|
|
**Open-ended questions**
|
|
|
|
|
- **Problem:** "What should I do next?" is ambiguous
|
|
|
|
|
- **Fix:** Present exactly 4 structured options (or 3 for detached HEAD)
|
|
|
|
|
|
|
|
|
|
**Cleaning up worktree for Option 2**
|
|
|
|
|
- **Problem:** Remove worktree user needs for PR iteration
|
|
|
|
|
- **Fix:** Only cleanup for Options 1 and 4
|
|
|
|
|
|
|
|
|
|
**Deleting branch before removing worktree**
|
|
|
|
|
- **Problem:** `git branch -d` fails because worktree still references the branch
|
|
|
|
|
- **Fix:** Merge first, remove worktree, then delete branch
|
|
|
|
|
|
|
|
|
|
**Running git worktree remove from inside the worktree**
|
|
|
|
|
- **Problem:** Command fails silently when CWD is inside the worktree being removed
|
|
|
|
|
- **Fix:** Always `cd` to main repo root before `git worktree remove`
|
|
|
|
|
|
|
|
|
|
**Cleaning up harness-owned worktrees**
|
|
|
|
|
- **Problem:** Removing a worktree the harness created causes phantom state
|
|
|
|
|
- **Fix:** Only clean up worktrees under `.worktrees/` or `worktrees/`
|
|
|
|
|
|
|
|
|
|
**No confirmation for discard**
|
|
|
|
|
- **Problem:** Accidentally delete work
|
|
|
|
|
- **Fix:** Require typed "discard" confirmation
|
|
|
|
|
|
|
|
|
|
## Red Flags
|
|
|
|
|
|
|
|
|
|
**Never:**
|
|
|
|
|
- Proceed with failing tests
|
|
|
|
|
- Merge without verifying tests on result
|
|
|
|
|
- Delete work without confirmation
|
|
|
|
|
- Force-push without explicit request
|
|
|
|
|
- Remove a worktree before confirming merge success
|
|
|
|
|
- Clean up worktrees you didn't create (provenance check)
|
|
|
|
|
- Run `git worktree remove` from inside the worktree
|
|
|
|
|
|
|
|
|
|
**Always:**
|
|
|
|
|
- Verify tests before offering options
|
|
|
|
|
- Detect environment before presenting menu
|
|
|
|
|
- Present exactly 4 options (or 3 for detached HEAD)
|
|
|
|
|
- Get typed confirmation for Option 4
|
|
|
|
|
- Clean up worktree for Options 1 & 4 only
|
|
|
|
|
- `cd` to main repo root before worktree removal
|
|
|
|
|
- Run `git worktree prune` after removal
|
|
|
|
|
| Excuse | Reality |
|
|
|
|
|
|--------|---------|
|
|
|
|
|
| "Tests passed earlier this session" | Run the suite on the tree you are about to integrate. A green run only proves the tree it ran on. |
|
|
|
|
|
| "They obviously want it merged" | Integration is your human partner's decision. Present the menu and wait. |
|
|
|
|
|
| "They seem done with this feature — I'll offer to discard it" | The menu is complete as written. Discard happens only when your human partner asks for it in so many words. |
|
|
|
|
|
| "'Yeah, get rid of it' counts as confirmation" | Only the typed word `discard` authorizes deletion. |
|
|
|
|
|
| "The PR is up, so the worktree is clutter now" | PR feedback gets fixed in that worktree. It stays until the work lands. |
|
|
|
|
|
| "This other worktree looks stale — I'll clean it too" | Clean up only worktrees under `.worktrees/` or `worktrees/`. Everything else belongs to the host. |
|
|
|
|
|
| "The merged-result failure is probably flaky" | A failing merged result stops everything. Branch and worktree stay put while you investigate. |
|
|
|
|
|
| "The base branch is obviously main" | Confirm the fork point or ask. Merging into the wrong base is expensive to undo. |
|
|
|
|
|
| "The push was rejected — force-push will fix it" | A rejected push means the remote moved. Investigate; force-push only on your human partner's explicit request. |
|
|
|
|
|
|
