Skip to content

Commit

Permalink
feat(git-submodules): default cloneSubmodules to false (#10514)
Browse files Browse the repository at this point in the history
Defaults cloneSubmodules to false.

BREAKING CHANGE: Git Submodules cloning now needs to be explicitly enabled.
  • Loading branch information
rarkins committed Aug 17, 2021
1 parent 2fe4946 commit 365ed05
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
4 changes: 4 additions & 0 deletions docs/usage/configuration-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -306,6 +306,10 @@ 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.

Important: private submodules aren't supported by Renovate, unless the underlying `ssh` layer already has the appropriate permissions.

## commitBody

Configure this if you wish Renovate to add a commit body, otherwise Renovate just uses a regular single-line commit.
Expand Down
4 changes: 2 additions & 2 deletions lib/config/definitions.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2009,9 +2009,9 @@ const options: RenovateOptions[] = [
{
name: 'cloneSubmodules',
description:
'Set to false to disable initialization of submodules during repository clone.',
'Set to true to enable initialization of submodules during repository clone.',
type: 'boolean',
default: true,
default: false,
},
{
name: 'ignorePrAuthor',
Expand Down

0 comments on commit 365ed05

Please sign in to comment.