mirror
/
renovate
mirror of https://github.com/renovatebot/renovate
2
0
Fork 0
Code Releases Activity
renovate/docs/usage/mend-hosted/hosted-apps-config.md

5.5 KiB
Raw Permalink Blame History

Mend-hosted Apps Configuration

The Mend-hosted apps (Renovate App on GitHub and Mend App on Bitbucket) are popular ways to use Renovate on the cloud.

This page:

  • covers all non-default Renovate behavior of these Mend-hosted apps
  • is a supplement to the CLI documentation

!!! note For general configuration of the Renovate CLI, read the main Configuration/Overview section.

Finding the logs

The Renovate logs for the Mend-hosted apps are on the Mend Developer Portal.

Reading the logs can help you understand the configuration that Renovate used.

Renovate Version

The Renovate version used by the Mend-hosted apps is updated manually by the maintainers of the app. The maintainers don't follow any release schedule or release cadence, but try to update at least once a week. This means the Mend Renovate App can lag a few hours to a week behind the open source version.

Major releases of Renovate are held back until the maintainers are reasonably certain it works for most users.

Which version is the Mend Renovate app using?

Follow these steps to see which version the Mend Renovate app used for a specific job:

  1. Sign in to the Mend Developer Portal with your GitHub or Bitbucket account

  2. Select your organization

  3. Select a installed repository

  4. Select a job from the Recent jobs overview

  5. Select the Info Log Level from the dropdown menu

  6. You should see something like this:

    INFO: Repository started
{
  "renovateVersion": "39.11.5"
}

!!! tip The PRs that Renovate creates have a link to the "repository job log" in the footer of the PR body text.

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 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
  • 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

Why we call this silent mode

  • It's not just no PRs, it's also no Issues
  • It's a common term across other Mend capabilities, such as OSS security and SAST security, where status checks also use silent/non-silent

Get onboarding PRs from Renovate by getting out of silent mode

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. To get a onboarding PR from Renovate, change to Interactive mode either at the Repository level or Organization level.

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". This change causes Renovate to create an Onboarding PR, even if Renovate does not detect any dependencies.

Fork Processing

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", 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 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 the organization has installed the Mend Renovate app. The repository does not need to be onboarded
  2. Renovate finds a file called org-inherited-config.json in the renovate-config repository

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 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 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. The commands are not documented, as they may change over time.

You can find the allowed postUpgradeTasks commands in Renovate's log output.