for-each-repo: optionally keep going on an error

In https://github.com/microsoft/git/issues/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 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.

Helped-by: Eric Sunshine <sunshine@sunshineco.com>
Helped-by: Patrick Steinhardt <ps@pks.im>
Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/Documentation/git-for-each-repo.txt b/Documentation/git-for-each-repo.txt
index 94bd19da263fa30e3905daad23dbbaed75c90c0d..abe3527aacab558877d806659c7996ee36f37e7c 100644 (file)
--- a/Documentation/git-for-each-repo.txt
+++ b/Documentation/git-for-each-repo.txt
@@ -42,6 +42,15 @@ 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.
++
+Note that the exact exit code of the failing command is not passed
+through as the exit code of the `for-each-repo` command: If the command
+failed in any of the specified repositories, the overall exit code will
+be 1.
 
 SUBPROCESS BEHAVIOR
 -------------------

diff --git a/builtin/for-each-repo.c b/builtin/for-each-repo.c
index 28186b30f54818cdbb42a4876358b7ceb20d20e2..c4fa41fda9f763629f39033df2fca3ae4bda514b 100644 (file)
--- a/builtin/for-each-repo.c
+++ b/builtin/for-each-repo.c
@@ -32,6 +32,7 @@ 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;
@@ -39,6 +40,8 @@ int cmd_for_each_repo(int argc, const char **argv, const char *prefix)
        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_("keep going even if command fails in a repository")),
                OPT_END()
        };
 
@@ -55,8 +58,14 @@ 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; i < values->nr; i++) {
+               int ret = run_command_on_repo(values->items[i].string, argc, argv);
+               if (ret) {
+                       if (!keep_going)
+                                       return ret;
+                       result = 1;
+               }
+       }
 
        return result;
 }

diff --git a/t/t0068-for-each-repo.sh b/t/t0068-for-each-repo.sh
index 4b90b74d5d515ec80b18b67e2b6f32780f860f22..95019e01ed33289aa025ec729d6b120f4c29f3c7 100755 (executable)
--- a/t/t0068-for-each-repo.sh
+++ b/t/t0068-for-each-repo.sh
@@ -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