diff options
author | Jonathon Reinhart <Jonathon.Reinhart@gmail.com> | 2017-01-16 02:20:07 +0300 |
---|---|---|
committer | Jonathon Reinhart <Jonathon.Reinhart@gmail.com> | 2017-01-17 04:38:59 +0300 |
commit | 90ee81dcd0201a02c5a94d2fa524643dc7a4e365 (patch) | |
tree | 8e54730d298152a82e5fb36468676bb6f3fa79a9 /doc/ci/git_submodules.md | |
parent | f1bd9f05e2ca0c165f06c47c32d44f2951265e6e (diff) |
Document GIT_SUBMODULE_STRATEGY
This documents the `GIT_SUBMODULE_STRATEGY` feature added in
gitlab-ci-multi-runner version 1.10.
[ci skip]
Diffstat (limited to 'doc/ci/git_submodules.md')
-rw-r--r-- | doc/ci/git_submodules.md | 13 |
1 files changed, 12 insertions, 1 deletions
diff --git a/doc/ci/git_submodules.md b/doc/ci/git_submodules.md index 1d782200cca..869743ce80a 100644 --- a/doc/ci/git_submodules.md +++ b/doc/ci/git_submodules.md @@ -61,7 +61,18 @@ correctly with your CI builds: 1. First, make sure you have used [relative URLs](#configuring-the-gitmodules-file) for the submodules located in the same GitLab server. -1. Then, use `git submodule sync/update` in `before_script`: +1. Next, if you are using `gitlab-ci-multi-runner` v1.10+, you can set the + `GIT_SUBMODULE_STRATEGY` variable to either `normal` or `recursive` to tell + the runner to fetch your submodules before the build: + ```yaml + variables: + GIT_SUBMODULE_STRATEGY: recursive + ``` + See the [`.gitlab-ci.yml` reference](yaml/README.md#git-submodule-strategy) + for more details about `GIT_SUBMODULE_STRATEGY`. + +1. If you are using an older version of `gitlab-ci-multi-runner`, then use + `git submodule sync/update` in `before_script`: ```yaml before_script: |