CODEWITHSUNDEEP
continuous-integrationgitlabcontinuous-deploymentgitlab-ci
soupybionics
soupybionics

Reputation: 4386

How to specify the submodule branch in gitlab-ci?

How to specify branch in .gitlab-ci.yml for a submodule (different repo) in gitlab-ci?

Upvotes: 9

Views: 12198

Answers (3)

mr.wolle
mr.wolle

Reputation: 1326

Nowadays you can set GIT_SUBMODULE_UPDATE_FLAGS: --remote in your gitlab ci file. This will check out the latest tip of your branch defined in .gitmodules.

See gitlab ci doc

Upvotes: 0

Zach Smith
Zach Smith

Reputation: 8961

Along with @stefan's answer to this question. You also have to tell Git to only look at the specified branch for the latest commit. git submodule update seems to always fetch the latest commit regardless of the branch. Doing git submodule update --remote seems to force git to focus on the branch you specify in the .gitmodules file.

So in your .gitmodules files, as @stefen mentions:

[submodule "MyRepo"]
    path = MyRepo
    url = https://github.com/vendor/MyRepo.git
    branch = master

Then in your GitLab .gitlab-ci.yml file, you need to specify to only look at the configured branch when setting up submodules. My file includes this before_script:

# GitLab CI provides a variable "GIT_SUBMODULE_STRATEGY" that sets up submodules automatically
# But then branch tracking doesn't work (doesn't seem to allow for specifying the --remote) flag
before_script:
 - git submodule sync --recursive
 - git submodule update --init --remote --recursive

According to documentation, this before_script is the same functionality as provided by GIT_SUBMODULE_STRATEGY (except that I can add the --remote flag to the before_script): https://docs.gitlab.com/ee/ci/yaml/README.html#git-submodule-strategy

Upvotes: 4

Stefan van Gastel
Stefan van Gastel

Reputation: 4478

You don't. You specify it in the .gitmodules file of the project you are building.

[submodule "MyRepo"]
    path = MyRepo
    url = https://github.com/vendor/MyRepo.git
    branch = master

Upvotes: 11

Related Questions