Automated Dependency Updates for Git Submodules
Categories: no-category
Renovate supports updating Git Submodules dependencies.
Enabling¶
Git Submodules functionality is currently in beta testing, so you must opt-in to test it. To enable it, add a configuration like this to either your bot config or your renovate.json:
{
"git-submodules": {
"enabled": true
}
}
If you find any bugs, please create a new discussion first. If you find that it works well, then let us know too.
File Matching¶
By default, Renovate will check any files matching the following regular expression: (^|/)\.gitmodules$.
For details on how to extend a manager's fileMatch value, please follow this link.
Supported datasources¶
This manager supports extracting the following datasources: git-refs.
Default config¶
{
"enabled": false,
"versioning": "git",
"fileMatch": [
"(^|/)\\.gitmodules$"
]
}
Additional Information¶
Keeps Git submodules updated within a repository.
You can customize the per-submodule checks of the git-submodules manager like this:
{
"ignoreDeps": ["path/to/submodule", "path/to/submodule2"],
"git-submodules": {
"enabled": true
}
}
Private Modules Authentication¶
Before running the git commands to update the submodules, Renovate exports git insteadOf directives in environment variables.
The following logic is executed prior to "submodules" updating:
The token from the hostRules entry matching hostType=github and matchHost=api.github.com is added as the default authentication for github.com.
For those running against github.com, this token will be the default platform token.
Next, all hostRules with both a token or username/password and matchHost will be fetched, except for any github.com one from above.
Rules from this list are converted to environment variable directives if they match any of the following characteristics:
- No
hostTypeis defined, or hostTypeis a platform (github,gitlab,azure, etc.)
Open items¶
The below list of features and bugs were current when this page was generated on September 22, 2023.