Skip to content

Improve prune recovery guidance #1777

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
codeforester merged 1 commit into from
Jul 28, 2026
+21 −2
Merged

Improve prune recovery guidance #1777

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion cli/bash/commands/basectl/subcommands/gh_branch_worktree.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -295,7 +295,7 @@ base_gh_branch_prune_local() {
printf 'No merged local branches found.\n'
fi
if ((skipped_worktree > 0)); then
printf 'Hint: run `basectl gh worktree prune` to inspect stale worktrees.\n'
printf 'Hint: run `basectl gh worktree prune` to preview these worktrees, then `basectl gh worktree prune --yes` and rerun this command.\n'
fi
printf 'Summary: %s %s, %s skipped worktree, %s skipped upstream, %s failed.\n' \
"$deleted" "$([[ "$dry_run" -eq 1 ]] && printf 'would delete' || printf 'deleted')" \
Expand Down Expand Up @@ -514,6 +514,11 @@ base_gh_worktree_prune() {
--yes)
dry_run=0
;;
--remote)
base_gh_usage_error base_gh_worktree_usage \
"Option '--remote' is only supported by 'basectl gh branch prune'. Run 'basectl gh branch prune --remote' for remote branch cleanup."
return $?
;;
-h|--help)
base_gh_worktree_usage
return 0
Expand Down
10 changes: 9 additions & 1 deletion cli/bash/commands/basectl/tests/gh-branch-worktree.bats
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,14 @@ load ./basectl_helpers.bash
[[ "$output" != *"basectl gh issue create"* ]]
}

@test "basectl gh worktree prune explains that remote cleanup belongs to branch prune" {
run_basectl gh worktree prune --remote

[ "$status" -eq 2 ]
[[ "$output" == *"Option '--remote' is only supported by 'basectl gh branch prune'."* ]]
[[ "$output" == *"Run 'basectl gh branch prune --remote' for remote branch cleanup."* ]]
}

@test "basectl gh branch usage errors return status 2" {
run_basectl gh branch stale --days never

Expand Down Expand Up @@ -219,7 +227,7 @@ load ./basectl_helpers.bash

[ "$status" -eq 0 ]
[[ "$output" == *"SKIP merged-work attached to worktree "*"/merged-worktree"* ]]
[[ "$output" == *'Hint: run `basectl gh worktree prune` to inspect stale worktrees.'* ]]
[[ "$output" == *'Hint: run `basectl gh worktree prune` to preview these worktrees, then `basectl gh worktree prune --yes` and rerun this command.'* ]]
[[ "$output" == *"Summary: 0 deleted, 1 skipped worktree, 0 skipped upstream, 0 failed."* ]]
git -C "$repo" show-ref --verify --quiet refs/heads/merged-work
}
Expand Down
6 changes: 6 additions & 0 deletions docs/github-workflow.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -438,6 +438,12 @@ a merged GitHub PR, then deletes the now-free local branch when safe. Resolve an
reported GitHub verification failures and rerun the preview before applying it
with `--yes`.

When `basectl gh branch prune` reports branches attached to worktrees, preview
those worktrees with `basectl gh worktree prune`, apply the safe removals with
`basectl gh worktree prune --yes`, and rerun the branch-prune command. The
`--remote` option belongs to `basectl gh branch prune`; worktree pruning only
removes local worktrees and their local branches.

## Superseded Pull Requests

A pull request closed because another pull request supersedes it has a
Expand Down
Loading