Skip to content

Commit b4e7700

Browse files
authored
docs(config overview): improve onboarding behavior section (#28579)
1 parent 9bffdb1 commit b4e7700

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

docs/usage/config-overview.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -253,13 +253,25 @@ Importantly, logs for all Renovate jobs by the Mend Renovate App are available t
253253

254254
### Onboarding behavior
255255

256+
#### Installing Renovate into all repositories leads to silent mode
257+
256258
If an Organization installed Renovate with "All repositories" (instead of "Selected repositories"), then Renovate will default to "Silent" mode (`dryRun=lookup`).
257259
We chose this behavior because:
258260

259261
- Too often an account or org administrator selects the "All repositories" option and accidentally onboards hundreds of repositories, and
260-
- By offering this option, it means that org administrators _can_ install Renovate into "All repositories" without worrying about the noise, and then let individual Repository admins decide if/when to start onboarding
262+
- By offering this option, it means that org administrators _can_ install Renovate into "All repositories" without worrying about the noise, and let individual repository admins decide if/when to start onboarding
263+
264+
##### Why we call this silent mode
265+
266+
- It's not just no PRs, it's also no Issues
267+
- It's a common term across other Mend capabilities, such as OSS security and SAST security, where status checks also use silent/non-silent
268+
269+
#### Get onboarding PRs from Renovate by getting out of silent mode
270+
271+
If Renovate is installed, _and_ you can see a job log, but Renovate is _not_ onboarding your repository: look for `dryRun` in the logs to confirm you are in Silent mode.
272+
To get a onboarding PR from Renovate, change to Interactive mode either at the Repository level or Organization level.
261273

262-
If Renovate is installed, and you can see a job log, but Renovate is not onboarding your repository, look for `dryRun` in the logs to confirm you are in Silent mode and then change to Interactive mode either at the Repository level or Organization level.
274+
#### Installing Renovate into selected repositories always leads to onboarding PRs
263275

264276
Additionally, if an Organization is installed with "Selected repositories" then the app will change `onboardingNoDeps` to `true` so that an Onboarding PR is created even if no dependencies are detected.
265277

0 commit comments

Comments
 (0)