Continue looping over submodules with the "git submodule foreach" command after a non-zero exit

Question

I have a project that contains many submodules. I want to loop over each submodule with the following command:

git submodule foreach npm install

And I want the script to continue looping over each submodule even if one submodule returns an error (non zero return code). Currently, a non-zero return code from running this command in any submodule will cause git to stop looping over the remaining submodules.

Any recommendations on how to accomplish this?

git submodule foreach 'yarn' – danday74 Mar 11 '17 at 04:13 — danday74, Mar 11 '17 at 04:13

gniourf_gniourf · Accepted Answer · 2013-11-01T15:22:47.390

139

Just make your command always return a 0 code like so:

git submodule foreach 'npm install || :'

This is taken from the manual: git help submodule:

   foreach
       Evaluates an arbitrary shell command in each checked out submodule.
       The command has access to the variables $name, $path, $sha1 and
       $toplevel: $name is the name of the relevant submodule section in
       .gitmodules, $path is the name of the submodule directory relative
       to the superproject, $sha1 is the commit as recorded in the
       superproject, and $toplevel is the absolute path to the top-level
       of the superproject. Any submodules defined in the superproject but
       not checked out are ignored by this command. Unless given --quiet,
       foreach prints the name of each submodule before evaluating the
       command. If --recursive is given, submodules are traversed
       recursively (i.e. the given shell command is evaluated in nested
       submodules as well). A non-zero return from the command in any
       submodule causes the processing to terminate. This can be
       overridden by adding || : to the end of the command.

       As an example, git submodule foreach 'echo $path `git rev-parse
       HEAD`' will show the path and currently checked out commit for each
       submodule.

The command : from help : in bash:

:: :
    Null command.

    No effect; the command does nothing.

    Exit Status:
    Always succeeds.

Always succeeds :)

edited Nov 01 '13 at 15:22

answered Nov 01 '13 at 15:13

gniourf_gniourf

44,650
9
93
104

11

`git submodule foreach 'npm install || true'` would do the same. – Maksim Dmitriev Jan 23 '14 at 07:43
It doesn't work on Windows. Was supposed to? Even using bash the \`\` only try to execute the first one and breaks anyway. – Idemax Aug 01 '16 at 14:01
2

@MarceloFilho: Try using the git bash. – MaBe Sep 14 '16 at 12:33
Using git bash @MaBe... :/ – Idemax Sep 15 '16 at 09:21
@MarceloFilho: please open a new question, describing the problem (so that it is reproducible by everybody), and link this question. – gniourf_gniourf Sep 15 '16 at 09:23
On Mac use " instead of ' – ort11 Jan 23 '18 at 19:56
Using an EC2 with Ubuntu 18.04.3 LTS, `|| true` failed for me, but `|| :` worked like a charm... Thank you @gniourf_gniourf – Gilberto Treviño Aug 24 '21 at 14:40

Simon · Answer 2 · 2023-03-09T21:34:23.843

5

In windows batch, you can set the return code to 0 by adding an ampersand and another command that does nothing:

git submodule foreach "npm install & echo done"

edit: originally the answer was using a semicolon to do this, which was incorrect.

edited Mar 09 '23 at 21:34

answered Aug 17 '22 at 23:10

Simon

171
1
4

Yeah, that's the part that the Git docs completely ignore: non-POSIX shells. +1 – 0xC0000022L Mar 31 '23 at 11:05

score 2 · Answer 3 · edited May 23 '17 at 12:32

2

You could see this topic.

I don't use GIT, but if you can locate the .gitmodules files, it may be easy to loop for each submodules :

<command to find all of your submodules>|while read; do
    # ... (default use $REPLY as an item)
done

Or :

while read; do
    # ...
done <<< "$(command to find all of your submodules)"

See this reminder on how to read a command output with a loop in Bash.

edited May 23 '17 at 12:32

Community

1
1

answered Nov 01 '13 at 14:48

Idriss Neumann

3,760
2
23
32

Please don't "parse" `.gitmodules` using shell ... there's a way to do it and that's: `git config --file .gitmodules --get-regexp ` ... which could indeed be piped into while then. – 0xC0000022L Mar 31 '23 at 11:07
2

@0xC0000022L this answer is +10 years old ;) (since, I became very used to use git)... – Idriss Neumann Apr 01 '23 at 12:28

Continue looping over submodules with the "git submodule foreach" command after a non-zero exit

3 Answers3

Linked