From a62e119a376877ba43f45c65b0fbf6d731e99e32 Mon Sep 17 00:00:00 2001
From: Bryan Mishkin <698306+bmish@users.noreply.github.com>
Date: Sun, 1 Sep 2019 19:19:46 -0700
Subject: [PATCH] =?UTF-8?q?docs:=20clarify=20default=20value=20for=20`lock?=
=?UTF-8?q?FileMaintenance`=20config=20op=E2=80=A6=20(#4416)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
This option is off by default.
https://docs.renovatebot.com/configuration-options/#lockfilemaintenance
---
website/docs/configuration-options.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/website/docs/configuration-options.md b/website/docs/configuration-options.md
index d3d0868912..aff7df1af9 100644
--- a/website/docs/configuration-options.md
+++ b/website/docs/configuration-options.md
@@ -487,12 +487,12 @@ The default behaviour for Renovate is to only use group names for branches and P
## lockFileMaintenance
-By setting enabled=true, this means that the default behaviour is to "maintain" lock files for each `package.json` if they exist already. "Maintaining" a lock file means recreating it to get an up-to-date version and committing that. Supported lock files include `package-lock.json` (npm >= 5) and `yarn.lock` (yarn).
+This feature can be used to "maintain" lock files for each `package.json` if they exist already. "Maintaining" a lock file means recreating it to get an up-to-date version and committing that. Supported lock files include `package-lock.json` (npm >= 5) and `yarn.lock` (yarn).
-If you wish to disable this feature then you could add this to your configuration:
+This feature is off by default. If you wish to enable this feature then you could add this to your configuration:
```json
- "lockFileMaintenance": { "enabled": false }
+ "lockFileMaintenance": { "enabled": true }
```
To reduce "noise" in the repository, it defaults its schedule to "before 5am on monday", i.e. to achieve once per week semantics. Renovate may run a few times within that time - even possibly updating the lock file more than once - but it hopefully leaves enough time for tests to run and automerge to apply, if configured.
--
GitLab