While git-gc(1) knows to prune stale worktrees, git-maintenance(1) does
not yet have a task for this cleanup. Introduce a new "worktree-prune"
task to plug this gap.
Signed-off-by: Patrick Steinhardt <ps@xxxxxx>
---
Documentation/git-maintenance.adoc | 4 ++++
builtin/gc.c | 35 +++++++++++++++++++++++++++++++++++
t/t7900-maintenance.sh | 17 +++++++++++++++++
3 files changed, 56 insertions(+)
diff --git a/Documentation/git-maintenance.adoc b/Documentation/git-maintenance.adoc
index 3a1e2a69b6b..6f085a9cf8c 100644
--- a/Documentation/git-maintenance.adoc
+++ b/Documentation/git-maintenance.adoc
@@ -166,6 +166,10 @@ reflog-expire::
The `reflog-expire` task deletes any entries in the reflog older than the
expiry threshold. See linkgit:git-reflog[1] for more information.
+worktree-prune::
+ The `worktree-prune` task deletes stale or broken worktrees. See
+ linkit:git-worktree[1] for more information.
+
OPTIONS
-------
--auto::
diff --git a/builtin/gc.c b/builtin/gc.c
index 005ecc3f192..46c64c852dc 100644
--- a/builtin/gc.c
+++ b/builtin/gc.c
@@ -44,6 +44,7 @@
#include "hook.h"
#include "setup.h"
#include "trace2.h"
+#include "worktree.h"
#define FAILED_RUN "failed to run %s"
@@ -346,6 +347,34 @@ static int maintenance_task_worktree_prune(struct maintenance_run_opts *opts UNU
return run_command(&prune_worktrees_cmd);
}
+static int worktree_prune_condition(struct gc_config *cfg)
+{
+ struct strvec worktrees = STRVEC_INIT;
+ struct strbuf reason = STRBUF_INIT;
+ timestamp_t expiry_date;
+ int should_prune = 0;
+
+ if (parse_expiry_date(cfg->prune_worktrees_expire, &expiry_date) ||
+ get_worktree_names(the_repository, &worktrees) < 0)
+ goto out;
+
+ for (size_t i = 0; i < worktrees.nr; i++) {
+ char *wtpath;
+
+ strbuf_reset(&reason);
+ if (should_prune_worktree(worktrees.v[i], &reason, &wtpath, expiry_date)) {
+ should_prune = 1;
+ goto out;
+ }
+ free(wtpath);
+ }
+
+out:
+ strvec_clear(&worktrees);
+ strbuf_release(&reason);
+ return should_prune;
+}
+
static int too_many_loose_objects(struct gc_config *cfg)
{
/*
@@ -1455,6 +1484,7 @@ enum maintenance_task_label {
TASK_COMMIT_GRAPH,
TASK_PACK_REFS,
TASK_REFLOG_EXPIRE,
+ TASK_WORKTREE_PRUNE,
/* Leave as final value */
TASK__COUNT
@@ -1496,6 +1526,11 @@ static struct maintenance_task tasks[] = {
maintenance_task_reflog_expire,
reflog_expire_condition,
},
+ [TASK_WORKTREE_PRUNE] = {
+ "worktree-prune",
+ maintenance_task_worktree_prune,
+ worktree_prune_condition,
+ },
};
static int compare_tasks_by_selection(const void *a_, const void *b_)
diff --git a/t/t7900-maintenance.sh b/t/t7900-maintenance.sh
index 9b82e11c100..d21feda271f 100755
--- a/t/t7900-maintenance.sh
+++ b/t/t7900-maintenance.sh
@@ -493,6 +493,23 @@ test_expect_success 'reflog-expire task --auto only packs when exceeding limits'
test_subcommand git reflog expire --all <reflog-expire-auto.txt
'
+test_expect_success 'worktree-prune task' '
+ GIT_TRACE2_EVENT="$(pwd)/worktree-prune.txt" \
+ git maintenance run --task=worktree-prune &&
+ test_subcommand git worktree prune --expire 3.months.ago <worktree-prune.txt
+'
+
+test_expect_success 'worktree-prune task --auto only prunes with prunable worktree' '
+ GIT_TRACE2_EVENT="$(pwd)/worktree-prune-auto.txt" \
+ git maintenance run --auto --task=worktree-prune &&
+ test_subcommand ! git worktree prune --expire 3.months.ago <worktree-prune-auto.txt &&
+ mkdir .git/worktrees &&
+ : >.git/worktrees/abc &&
+ GIT_TRACE2_EVENT="$(pwd)/worktree-prune-auto.txt" \
+ git maintenance run --auto --task=worktree-prune &&
+ test_subcommand git worktree prune --expire 3.months.ago <worktree-prune-auto.txt
+'
+
test_expect_success '--auto and --schedule incompatible' '
test_must_fail git maintenance run --auto --schedule=daily 2>err &&
test_grep "at most one" err
--
2.49.0.901.g37484f566f.dirty
