Skip to content

Commit

Permalink
for-each-repo: optionally keep going on an error
Browse files Browse the repository at this point in the history
In microsoft#623, it was reported that
the regularly scheduled maintenance stops if one repo in the middle of
the list was found to be missing.

This is undesirable, and points out a gap in the design of `git
for-each-repo`: We need a mode where that command does not stop on an
error, but continues to try the running the specified command with the
other repositories.

Imitating the `--keep-going` option of GNU make, this commit teaches
`for-each-repo` the same trick: to continue with the operation on all
the remaining repositories in case there was a problem with one
repository, still setting the exit code to indicate an error occurred.

Signed-off-by: Johannes Schindelin <[email protected]>
  • Loading branch information
dscho committed Apr 16, 2024
1 parent 3c2a3fd commit 6721e3a
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 2 deletions.
4 changes: 4 additions & 0 deletions Documentation/git-for-each-repo.txt
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,10 @@ These config values are loaded from system, global, and local Git config,
as available. If `git for-each-repo` is run in a directory that is not a
Git repository, then only the system and global config is used.

--keep-going::
Continue with the remaining repositories if the command failed
on a repository. The exit code will still indicate that the
overall operation was not successful.

SUBPROCESS BEHAVIOR
-------------------
Expand Down
8 changes: 6 additions & 2 deletions builtin/for-each-repo.c
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,16 @@ static int run_command_on_repo(const char *path, int argc, const char ** argv)
int cmd_for_each_repo(int argc, const char **argv, const char *prefix)
{
static const char *config_key = NULL;
int keep_going = 0;
int i, result = 0;
const struct string_list *values;
int err;

const struct option options[] = {
OPT_STRING(0, "config", &config_key, N_("config"),
N_("config key storing a list of repository paths")),
OPT_BOOL(0, "keep-going", &keep_going,
N_("stop at the first repository where the operation failed")),
OPT_END()
};

Expand All @@ -55,8 +58,9 @@ int cmd_for_each_repo(int argc, const char **argv, const char *prefix)
else if (err)
return 0;

for (i = 0; !result && i < values->nr; i++)
result = run_command_on_repo(values->items[i].string, argc, argv);
for (i = 0; (keep_going || !result) && i < values->nr; i++)
if (run_command_on_repo(values->items[i].string, argc, argv))
result = 1;

return result;
}
16 changes: 16 additions & 0 deletions t/t0068-for-each-repo.sh
Original file line number Diff line number Diff line change
Expand Up @@ -59,4 +59,20 @@ test_expect_success 'error on NULL value for config keys' '
test_cmp expect actual
'

test_expect_success '--keep-going' '
git config keep.going non-existing &&
git config --add keep.going . &&
test_must_fail git for-each-repo --config=keep.going \
-- branch >out 2>err &&
test_grep "cannot change to .*non-existing" err &&
test_must_be_empty out &&
test_must_fail git for-each-repo --config=keep.going --keep-going \
-- branch >out 2>err &&
test_grep "cannot change to .*non-existing" err &&
git branch >expect &&
test_cmp expect out
'

test_done

0 comments on commit 6721e3a

Please sign in to comment.