Submodules
Sometimes you may want to use an external project from within your main repository, e.g. a library that generates code in your web app. Git addresses this issue with submodules that allow you to deploy changes from both main and external repositories.
Repository
The repository is cloned to the filesystem on two occasions:
- during the first pipeline run
- on the first run after clearing the pipeline's cache
Any other run only fetches the latest changes.
Supported protocols
If you use submodules in your project, Buddy will fetch them alongside the main repository. Currently, the following protocols are supported:
- HTTPS protocol
- SSH protocol – upon authorizing the Buddy Key
For HTTPS submodules, make sure that the submodule is a repository within the same integration, or it will not work. In other words, if your repository is hosted on GitHub you can only use repositories from the currently synchronized GitHub account.
Enabling submodules
By default, submodule deployments are disabled in Buddy. To enable them, go to the project settings and check the option in the Submodules field:
Submodules settings and location
Last modified on November 8, 2022