diff --git a/docs/usage/mend-hosted/hosted-apps-config.md b/docs/usage/mend-hosted/hosted-apps-config.md index 77ba6c48164fdb392e5463bbb6d6625af09ebfb4..4d183fab6f1f8bb9b40fd850a9b39c5b7565984b 100644 --- a/docs/usage/mend-hosted/hosted-apps-config.md +++ b/docs/usage/mend-hosted/hosted-apps-config.md @@ -1,20 +1,27 @@ # Mend-hosted Apps Configuration The Mend-hosted apps ([Renovate App on GitHub](https://github.com/apps/renovate) and [Mend App on Bitbucket](https://marketplace.atlassian.com/apps/1232072/mend)) are popular ways to use Renovate on the cloud. -This documentation page covers all non-default Renovate behavior of these Mend-hosted apps and is a supplement to the CLI documentation. -Logs for all Renovate jobs by the Mend-hosted apps are available through the [Mend Developer Portal](https://developer.mend.io). -Accessing such logs can assist users to understand the config that has been applied. +This page: + +- covers all non-default Renovate behavior of these Mend-hosted apps +- is a supplement to the CLI documentation <!-- prettier-ignore --> !!! note - For general configuration of the Renovate CLI, refer to the documentation in the main [Configuration/Overview](../config-overview.md) section. + For general configuration of the Renovate CLI, read the main [Configuration/Overview](../config-overview.md) section. + +## Finding the logs + +The Renovate logs for the Mend-hosted apps are on the [Mend Developer Portal](https://developer.mend.io). + +Reading the logs can help you understand the configuration that Renovate used. ## Onboarding behavior ### Installing Renovate into all repositories leads to silent mode -If an Organization installed Renovate with "All repositories" (instead of "Selected repositories"), then Renovate will default to "Silent" mode (`dryRun=lookup`). +If an Organization installed Renovate with "All repositories" (instead of "Selected repositories"), then Renovate defaults to "Silent" mode (`dryRun=lookup`). We chose this behavior because: - Too often an account or org administrator selects the "All repositories" option and accidentally onboards hundreds of repositories, and @@ -32,37 +39,41 @@ To get a onboarding PR from Renovate, change to Interactive mode either at the R ### Installing Renovate into selected repositories always leads to onboarding PRs -Additionally, if an Organization is installed with "Selected repositories" then the app will change `onboardingNoDeps` to `"enabled"` so that an Onboarding PR is created even if no dependencies are detected. +Additionally, if an Organization is installed with "Selected repositories" then the app will change `onboardingNoDeps` to `"enabled"`. +This change causes Renovate to create an Onboarding PR, even if Renovate does not detect any dependencies. ## Fork Processing -If an Organization install Renovate with the "All repositories" option, then `forkProcessing` will remain as the default value `false`. -This means forked repositories are _not_ onboarded, Renovate essentially ignores them. -To change this behavior you need to manually push a `renovate.json` to the repository with `"forkProcessing": true`. +If an Organization installs Renovate with the "All repositories" option, then `forkProcessing` will remain set to its default value `false`. +This means forked repositories are _not_ onboarded, Renovate ignores them. +To change this behavior, push a `renovate.json` file to the repository with `"forkProcessing": true`. -If an Organization installs Renovate with "Selected repositories" then we assume the organization wants all of the selected repositories onboarded (even forked repositories), so `forkProcessing` is set to `true`. +If an Organization installs Renovate with "Selected repositories", we assume the organization wants to onboard _all_ of the selected repositories, even forked repositories. +Therefore we set `forkProcessing` to `true`. ## Inherited config -The Mend Renovate app will automatically apply inherited config to all installed repositories in an organization when the following conditions are met: +The Mend Renovate app automatically applies inherited config to all installed repositories in an organization, if these conditions are met: -1. A repository called `renovate-config` exists in the same organization and has the Mend Renovate app installed. It is not necessary for this repository to be onboarded. -2. The file `org-inherited-config.json` is detected in the `renovate-config` repository. +1. A repository called `renovate-config` exists in the same organization, and the organization has installed the Mend Renovate app. The repository does not need to be onboarded +1. Renovate finds a file called `org-inherited-config.json` in the `renovate-config` repository -Unlike with self-hosted Renovate, the values of the `inheritConfigFileName` and the `inheritConfigRepoName` cannot be changed in Mend apps. +If you use a Mend-hosted app, you can _not_ change the values for the `inheritConfigFileName` and the `inheritConfigRepoName` config options. -To avoid wasted API calls, Mend apps will enable `inheritConfig` in an org only once a commit has been detected for the `inheritConfig` file. -Therefore, the `inheritConfig` file will not be detected if the Mend Renovate app is not installed on the `renovate-config` repository at the time of adding or changing the file. -If you have such a file but the Mend app has not enabled `inheritConfig` in your org, then try pushing a commit to that file and waiting a minute to see if it gets detected. +To avoid wasted API calls, Mend apps will enable `inheritConfig` in an org only when Renovate detects a commit for the `inheritConfig` file. +This means the `inheritConfig` file will not be detected if the Mend Renovate app is not installed on the `renovate-config` repository at the time of adding or changing the file. +If you have such a file but the Mend app has not enabled `inheritConfig` in your org, try pushing a commit to that file and wait a minute to see if Renovate detects the change. ## Default presets The Mend Renovate app automatically adds the `mergeConfidence:all-badges` preset to the `extends` array. -If you don't want the Merge Confidence badges, then add the `mergeConfidence:all-badges` preset to the `ignorePresets` array. +If you do not want the Merge Confidence badges: add the `mergeConfidence:all-badges` preset to the `ignorePresets` array. Additionally, the preset `config:recommended` is added to `onboardingConfig`. ## Allowed Post-upgrade commands A limited set of approved `postUpgradeTasks` commands are allowed in the app. -They are not documented here as they may change over time - please consult the logs to see them. +The commands are not documented, as they may change over time. + +You can find the allowed `postUpgradeTasks` commands in Renovate's log output.