Skip to content

Commit 6a1dca6

Browse files
gitstergitster
committed
Merge branch 'sk/maintenance-remote-prune' into seen
A new periodic maintenance task to run "git remote prune" has been introduced. * sk/maintenance-remote-prune: maintenance: add prune-remote-refs task
2 parents e743482 + 7559fd9 commit 6a1dca6

File tree

3 files changed

+187
-7
lines changed

3 files changed

+187
-7
lines changed

‎Documentation/git-maintenance.adoc‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,26 @@ pack-refs::
158158
need to iterate across many references. See linkgit:git-pack-refs[1]
159159
for more information.
160160

161+
prune-remote-refs::
162+
The `prune-remote-refs` task runs `git remote prune` on each remote
163+
repository registered in the local repository. This task helps clean
164+
up deleted remote branches, improving the performance of operations
165+
that iterate through the refs. See linkgit:git-remote[1] for more
166+
information. This task is disabled by default.
167+
+
168+
NOTE: This task is opt-in to prevent unexpected removal of remote refs
169+
for users of linkgit:git-maintenance[1]. For most users, configuring `fetch.prune=true`
170+
is an acceptable solution, as it will automatically clean up stale remote-tracking
171+
branches during normal fetch operations. However, this task can be useful in
172+
specific scenarios:
173+
+
174+
--
175+
* When using selective fetching (e.g., `git fetch origin +foo:refs/remotes/origin/foo`)
176+
where `fetch.prune` would only affect refs that are explicitly fetched.
177+
* When third-party tools might perform unexpected full fetches, and you want
178+
periodic cleanup independently of fetch operations.
179+
--
180+
161181
OPTIONS
162182
-------
163183
--auto::

‎builtin/gc.c‎

Lines changed: 85 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
#include "lockfile.h"
2424
#include "parse-options.h"
2525
#include "run-command.h"
26+
#include "remote.h"
2627
#include "sigchain.h"
2728
#include "strvec.h"
2829
#include "commit.h"
@@ -921,6 +922,63 @@ static int maintenance_opt_schedule(const struct option *opt, const char *arg,
921922
return 0;
922923
}
923924

925+
struct remote_cb_data {
926+
struct maintenance_run_opts *maintenance_opts;
927+
struct string_list failed_remotes;
928+
};
929+
930+
static void report_failed_remotes(struct string_list *failed_remotes,
931+
const char *action_name)
932+
{
933+
if (failed_remotes->nr) {
934+
int i;
935+
struct strbuf msg = STRBUF_INIT;
936+
strbuf_addf(&msg, _("failed to %s the following remotes: "),
937+
action_name);
938+
for (i = 0; i < failed_remotes->nr; i++) {
939+
if (i)
940+
strbuf_addstr(&msg, ", ");
941+
strbuf_addstr(&msg, failed_remotes->items[i].string);
942+
}
943+
error("%s", msg.buf);
944+
strbuf_release(&msg);
945+
}
946+
}
947+
948+
static int prune_remote(struct remote *remote, void *cb_data)
949+
{
950+
struct child_process child = CHILD_PROCESS_INIT;
951+
struct remote_cb_data *data = cb_data;
952+
953+
if (!remote->url.nr)
954+
return 0;
955+
956+
child.git_cmd = 1;
957+
strvec_pushl(&child.args, "remote", "prune", remote->name, NULL);
958+
959+
if (run_command(&child))
960+
string_list_append(&data->failed_remotes, remote->name);
961+
962+
return 0;
963+
}
964+
965+
static int maintenance_task_prune_remote(struct maintenance_run_opts *opts,
966+
struct gc_config *cfg UNUSED)
967+
{
968+
struct remote_cb_data cbdata = { .maintenance_opts = opts,
969+
.failed_remotes = STRING_LIST_INIT_DUP };
970+
971+
int result;
972+
result = for_each_remote(prune_remote, &cbdata);
973+
974+
report_failed_remotes(&cbdata.failed_remotes, "prune");
975+
if (cbdata.failed_remotes.nr)
976+
result = 1;
977+
978+
string_list_clear(&cbdata.failed_remotes, 0);
979+
return result;
980+
}
981+
924982
/* Remember to update object flag allocation in object.h */
925983
#define SEEN (1u<<0)
926984

@@ -1041,8 +1099,8 @@ static int maintenance_task_commit_graph(struct maintenance_run_opts *opts,
10411099

10421100
static int fetch_remote(struct remote *remote, void *cbdata)
10431101
{
1044-
struct maintenance_run_opts *opts = cbdata;
10451102
struct child_process child = CHILD_PROCESS_INIT;
1103+
struct remote_cb_data *data = cbdata;
10461104

10471105
if (remote->skip_default_update)
10481106
return 0;
@@ -1053,21 +1111,34 @@ static int fetch_remote(struct remote *remote, void *cbdata)
10531111
"--no-write-fetch-head", "--recurse-submodules=no",
10541112
NULL);
10551113

1056-
if (opts->quiet)
1114+
if (data->maintenance_opts->quiet)
10571115
strvec_push(&child.args, "--quiet");
10581116

1059-
return !!run_command(&child);
1117+
if (run_command(&child))
1118+
string_list_append(&data->failed_remotes, remote->name);
1119+
1120+
return 0;
10601121
}
10611122

10621123
static int maintenance_task_prefetch(struct maintenance_run_opts *opts,
10631124
struct gc_config *cfg UNUSED)
10641125
{
1065-
if (for_each_remote(fetch_remote, opts)) {
1066-
error(_("failed to prefetch remotes"));
1067-
return 1;
1126+
struct remote_cb_data cbdata = { .maintenance_opts = opts,
1127+
.failed_remotes = STRING_LIST_INIT_DUP };
1128+
1129+
int result = 0;
1130+
1131+
if (for_each_remote(fetch_remote, &cbdata)) {
1132+
error(_("failed to prefetch some remotes"));
1133+
result = 1;
10681134
}
10691135

1070-
return 0;
1136+
report_failed_remotes(&cbdata.failed_remotes, "prefetch");
1137+
if (cbdata.failed_remotes.nr)
1138+
result = 1;
1139+
1140+
string_list_clear(&cbdata.failed_remotes, 0);
1141+
return result;
10711142
}
10721143

10731144
static int maintenance_task_gc(struct maintenance_run_opts *opts,
@@ -1383,6 +1454,7 @@ enum maintenance_task_label {
13831454
TASK_GC,
13841455
TASK_COMMIT_GRAPH,
13851456
TASK_PACK_REFS,
1457+
TASK_PRUNE_REMOTE_REFS,
13861458

13871459
/* Leave as final value */
13881460
TASK__COUNT
@@ -1419,6 +1491,10 @@ static struct maintenance_task tasks[] = {
14191491
maintenance_task_pack_refs,
14201492
pack_refs_condition,
14211493
},
1494+
[TASK_PRUNE_REMOTE_REFS] = {
1495+
"prune-remote-refs",
1496+
maintenance_task_prune_remote,
1497+
},
14221498
};
14231499

14241500
static int compare_tasks_by_selection(const void *a_, const void *b_)
@@ -1513,6 +1589,8 @@ static void initialize_maintenance_strategy(void)
15131589
tasks[TASK_LOOSE_OBJECTS].schedule = SCHEDULE_DAILY;
15141590
tasks[TASK_PACK_REFS].enabled = 1;
15151591
tasks[TASK_PACK_REFS].schedule = SCHEDULE_WEEKLY;
1592+
tasks[TASK_PRUNE_REMOTE_REFS].enabled = 0;
1593+
tasks[TASK_PRUNE_REMOTE_REFS].schedule = SCHEDULE_DAILY;
15161594
}
15171595
}
15181596

‎t/t7900-maintenance.sh‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -447,6 +447,88 @@ test_expect_success 'pack-refs task' '
447447
test_subcommand git pack-refs --all --prune <pack-refs.txt
448448
'
449449

450+
test_expect_success 'prune-remote-refs task not enabled by default' '
451+
git clone . prune-test &&
452+
(
453+
cd prune-test &&
454+
GIT_TRACE2_EVENT="$(pwd)/prune.txt" git maintenance run 2>err &&
455+
test_subcommand ! git remote prune origin <prune.txt
456+
)
457+
'
458+
459+
test_expect_success 'prune-remote-refs task cleans stale remote refs' '
460+
test_commit initial &&
461+
462+
# Create two separate remote repos
463+
git clone . remote1 &&
464+
git clone . remote2 &&
465+
466+
git clone . prune-test-clean &&
467+
(
468+
cd prune-test-clean &&
469+
git config maintenance.prune-remote-refs.enabled true &&
470+
471+
# Add both remotes
472+
git remote add remote1 "../remote1" &&
473+
git remote add remote2 "../remote2" &&
474+
475+
# Create and push branches to both remotes
476+
git branch -f side2 HEAD &&
477+
git push remote1 side2 &&
478+
git push remote2 side2 &&
479+
480+
# Rename branches in each remote to simulate a stale branch
481+
git -C ../remote1 branch -m side2 side3 &&
482+
git -C ../remote2 branch -m side2 side4 &&
483+
484+
GIT_TRACE2_EVENT="$(pwd)/prune.txt" git maintenance run --task=prune-remote-refs &&
485+
486+
# Verify pruning happened for both remotes
487+
test_subcommand git remote prune remote1 <prune.txt &&
488+
test_subcommand git remote prune remote2 <prune.txt &&
489+
test_must_fail git rev-parse refs/remotes/remote1/side2 &&
490+
test_must_fail git rev-parse refs/remotes/remote2/side2
491+
)
492+
'
493+
494+
test_expect_success 'prune-remote-refs task continues to prune remotes even if some fail' '
495+
test_commit initial-prune-remote-refs &&
496+
497+
git clone . remote-bad1 &&
498+
git clone . remote-bad2 &&
499+
git clone . remote-good &&
500+
501+
git clone . prune-test-partial &&
502+
(
503+
cd prune-test-partial &&
504+
git config maintenance.prune-remote-refs.enabled true &&
505+
506+
# Add remotes in alphabetical order to ensure processing order
507+
git remote add aaa-bad1 "../remote-bad1" &&
508+
git remote add bbb-bad2 "../remote-bad2" &&
509+
git remote add ccc-good "../remote-good" &&
510+
511+
# Create and push branches to all remotes
512+
git branch -f side2 HEAD &&
513+
git push aaa-bad1 side2 &&
514+
git push bbb-bad2 side2 &&
515+
git push ccc-good side2 &&
516+
517+
# Rename branch in good remote to simulate a stale branch
518+
git -C ../remote-good branch -m side2 side3 &&
519+
520+
# Break the bad remotes by removing their directories
521+
rm -rf ../remote-bad1 ../remote-bad2 &&
522+
523+
GIT_TRACE2_EVENT="$(pwd)/prune.txt" git maintenance run --task=prune-remote-refs 2>err || true &&
524+
525+
# Verify pruning happened for good remote despite bad remote failures
526+
test_subcommand git remote prune ccc-good <prune.txt &&
527+
test_must_fail git rev-parse refs/remotes/ccc-good/side2 &&
528+
test_grep "error: failed to prune the following remotes: aaa-bad1, bbb-bad2" err
529+
)
530+
'
531+
450532
test_expect_success '--auto and --schedule incompatible' '
451533
test_must_fail git maintenance run --auto --schedule=daily 2>err &&
452534
test_grep "at most one" err

0 commit comments

Comments
 (0)