diff options
Diffstat (limited to 'docs/usage/configuration-options.md')
| -rw-r--r-- | docs/usage/configuration-options.md | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/docs/usage/configuration-options.md b/docs/usage/configuration-options.md index c6205f400ec..d96d93cf9e2 100644 --- a/docs/usage/configuration-options.md +++ b/docs/usage/configuration-options.md @@ -456,11 +456,19 @@ For `sbt` note that Renovate will update the version string only for packages th ## cloneSubmodules -Enabling this option will mean that any detected Git submodules will be cloned at time of repository clone. +Enabling this option will mean that detected Git submodules will be cloned at time of repository clone. +By default all will be cloned, but this can be customized by configuring `cloneSubmodulesFilter` too. Submodules are always cloned recursively. Important: private submodules aren't supported by Renovate, unless the underlying `ssh` layer already has the correct permissions. +## cloneSubmodulesFilter + +Use this option together with `cloneSubmodules` if you wish to clone only a subset of submodules. + +This config option supports regex and glob filters, including negative matches. +For more details on this syntax see Renovate's [string pattern matching documentation](./string-pattern-matching.md). + ## commitBody Configure this if you wish Renovate to add a commit body, otherwise Renovate uses a regular single-line commit. |