renovate-config

This repository contains some shared renovate configurations.

The shared configurations are baselines. Each project is free to set their own rules on top of this configuration.

Usage

Extending the base configuration:

Renovate's documentation on leveraging shareable presets.

{
  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
  "extends": [
    "github>gsoft-inc/renovate-config"
  ]
}

Enabling Auto-Merge Functionality

There are multiple configurations you can extend to enable auto-merge on different packages. Here's a fully working example of all of them together:

{
  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
  "extends": [
    "github>gsoft-inc/renovate-config"
    "github>gsoft-inc/renovate-config//microsoft-automerge.json",
    "github>gsoft-inc/renovate-config//workleap-automerge.json",
    "github>gsoft-inc/renovate-config//dotnet-trusted-thirdparty-dependencies-automerge.json",
    "github>gsoft-inc/renovate-config//all-automerge.json"
  ]
}

Auto-merge has been set up using the branch approach to minimize noise and bypass PR review requirements. If your main branch has branch protection rules, you may need to allow your build agent's service account to bypass pull request creation.

With the branch approach, at least one status check must run on every Renovate branch when it is created, usually through your CI pipeline. If no status check is registered, Renovate will create the update branches but won't attempt to merge them into the main branch, as it will detect the absence of completed status checks.

To ensure one or more pipelines execute when a Renovate branch is created, add the Renovate branches as triggers. Since the branch names follow a standard pattern, they would look something like this:

# Pipeline trigger in Azure DevOps
trigger:
  branches:
    include:
    - renovate/*


# Pipeline trigger in Github
on:
  push:
    branches:
      - 'renovate/*'

System tests

In order to run the system tests you will need the workflow scope on this repository.

To request this scope you can run the following command in your CLI

gh auth login --scopes workflow

If you do not have this scope, you will run into the following error

! [remote rejected] main -> main (refusing to allow an OAuth App to create or update workflow `.github/workflows/ci.yml` without `workflow` scope)