From 7165abd046c15a561128cb3b455d80e21202aa4d Mon Sep 17 00:00:00 2001
From: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Date: Fri, 26 Feb 2021 16:59:56 +0100
Subject: [PATCH] docs: improve dependencyDashboardApproval section (#8841)
Co-authored-by: Rhys Arkins <rhys@arkins.net>
---
docs/usage/configuration-options.md | 47 ++++++++++++++++++++++++++---
1 file changed, 42 insertions(+), 5 deletions(-)
diff --git a/docs/usage/configuration-options.md b/docs/usage/configuration-options.md
index 856d7663a3..caedf1edc0 100644
--- a/docs/usage/configuration-options.md
+++ b/docs/usage/configuration-options.md
@@ -367,13 +367,50 @@ The Dependency Dashboard therefore provides visibility as well as additional con
## dependencyDashboardApproval
-Setting `dependencyDashboardApproval` to `true` means that Renovate will no longer create branches/PRs automatically but instead wait for manual approval from within the Dependency Dashboard.
+This feature allows you to use Renovate's Dependency Dashboard to force approval of updates before they are created.
-In this case, the Dependency Dashboard _does_ change the flow of Renovate, because PRs will stop appearing until you approve them within the issue.
-Instead of enabling this repository-wide, you may instead with to use package rules to enable it selectively, e.g. for major updates only, or for certain package managers, etc.
-i.e. it is possible to require approval for only certain types of updates only.
+By setting `dependencyDashboardApproval` to `true` in config (including within `packageRules`), you can tell Renovate to wait for your approval from the Dependency Dashboard before creating a branch/PR.
+You can approve a pending PR by ticking the checkbox in the Dependency Dashboard issue.
-Note: Enabling Dependency Dashboard Approval implicitly enables `dependencyDashboard` too, so it is not necessary to configure both to `true`.
+Note: When you set `dependencyDashboardApproval` to `true` the Dependency Dashboard issue will be created automatically, you do not need to turn on `dependencyDashboard` explictly.
+
+You can configure Renovate to wait for approval for:
+
+- all package upgrades
+- major, minor, patch level upgrades
+- specific package upgrades
+- upgrades coming from specific package managers
+
+If you want to approve _all_ upgrades, set `dependencyDashboardApproval` to `true`:
+
+```json
+{
+ "dependencyDashboardApproval": true
+}
+```
+
+If you want to require approval for _major_ updates, set `dependencyDashboardApproval` to `true` within a `major` object:
+
+```json
+{
+ "major": {
+ "dependencyDashboardApproval": true
+ }
+}
+```
+
+If you want to approve _specific_ packages, set `dependencyDashboardApproval` to `true` within a `packageRules` entry where you have defined a specific package or pattern.
+
+```json
+{
+ "packageRules": [
+ {
+ "matchPackagePatterns": ["^@package-name"],
+ "dependencyDashboardApproval": true
+ }
+ ]
+}
+```
## dependencyDashboardAutoclose
--
GitLab