Using git submodules
If you're building a big project, you might want to break it down into smaller chunks and use git submodules to make everything work.
If you have a
.gitmodules file at the root of the repo, it is automatically initialized as part of your build by default.
If your submodules are in a public repository, use the public Git URL in your
If your submodules are in a private repository, you will need to add your Shippable subscription's deploy key to the private repository on your source control, so that we have access to pull from the repository.
- First, go to your Subscription's Settings tab and copy the deploy key (key in image is redacted for privacy):
- Next, go to the private repository in your source control that contains the required submodule and add a deploy key in your repository settings (key in image is redacted for privacy):
- You can now include the path of your submodule repo in the
.gitmodulesfile of the repository you're building:
For a more detailed explanation, check out our "SSH keys" page.
Turning off submodules
To turn off submodules for your build, include the following in your yml:
git: submodules: false