Update dependencies with Renovate

Automate dependency updates with Renovate in CI pipeline on Gitlab, Azure, Gitea, Bitbucket, or GitHub. Because almost every program contains dependencies that are not updated so often, as they should be.

🇨🇿 V češtině si lze článek přečíst na kutac.cz

---

Vulnerabilities were, are, and will be also in the best libraries and packages. Because of that, it is really important to do an update as soon as possible after releasing the fix. However, it is hard to do those checks manually. From Github, you might know Dependabot.

But there is another option called Renovate Bot, which can be self-hosted and supports a wide range of git platforms.

Renovate Bot in Gitlab CI

Renovate can handle dependencies for many languages with managers. For example for Java, there are 2 possible managers supported - Gradle and Maven. It is not surprising, that Renovate offers tons of configurable options.

Following tutorial will inform about the usage of Docker image. However, there is a possibility to use directly the Renovate core written in JavaScript.

Step 1 - New project with bot and pipeline

As a starting point, you need to create a new Gitlab project/repository. That will contain the base Renovate pipeline, which you can trigger automatically by CI/CD Schedules. The minimum configuration consists of the files below.

I highly suggest setting environment variables via CI/CD Variables, not hardcode them into the CI file. RENOVATE_TOKEN grants bot access into repositories and GITHUB_COM_TOKEN is used to download Release notes from Github. See how to create those tokens in Getting started.

Pipeline file .gitlab-ci.yml

update_repositories:
  # I use concrete version here, Renovate updates itself as configured in config.js
  image: renovate/renovate:24.12.4
  # variables: # I highly suggest to set them via CI/CD Variables
  #   RENOVATE_TOKEN: ""
  #   GITHUB_COM_TOKEN: ""
  script:
    - docker-entrypoint.sh
  artifacts:
    when: always
    paths:
      - renovate.log.json
  only:
    - schedules

Config of Renovate bot config.js

module.exports = {
  onboardingConfig: { // This will be placed into repositories without config
    extends: ["config:base"],
  },
  platform: "gitlab",
  endpoint: process.env.CI_API_V4_URL, // Needed only for self-hosted Gitlab
  logFile: "renovate.log.json", // Path to log file, must be same as in .gitlab-ci.yml in artifacts
  // Author cannot be the same as any developer, the best is to have own account for Renovate bot
  // Optionally it is possible to change just email
  // See here: https://github.com/renovatebot/config-help/issues/839
  gitAuthor: "RenovateBot <[e-mail]>",
  baseBranches: ["master"],
  assignees: ["pavel.kutac"], // New MR are assigned into this person(s)
  // All repositories where Renovate will operate
  repositories: [
    "pavel.kutac/renovate-bot", // Updating itself, ie version in .gitlab-ci.yml
    "pavel.kutac/docker-ftp-deployer",
    "pavel.kutac/kutac_cz",
  ],
};

Example of Renovate Onboarding MR

Optionally renovate.json config file

The renovate.json file is required only in the repositories, which are checked by the Renovate bot. But because this bot will update itself, this file must be placed into the repo as well.

{
  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
  // Enables Docker major updates, disabled by default
  "extends": ["config:base", "docker:enableMajor"], 
  "enabledManagers": ["gitlabci"], // Only 1 manager will be run
  "requiredStatusChecks": null,
  // If the update is not major, do the merge automatically
  "packageRules": [{ "updateTypes": ["minor", "patch", "pin", "digest"], "automerge": true }]
}

Step 2 - Setting the Renovate per-repo

As above, the renovate.json file must be placed into all repositories, which are checked and updated by the Renovate bot - ie into all mentioned under the repositories key in config.js. The following config is taken from my personal portfolio.

{
  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
  "extends": [ "config:base" ],
  "prHourlyLimit": 0, // Unlimited MRs per hour
  "prConcurrentLimit": 0, // Unlimited opened MRs in every moment
  "baseBranches": [ "devel" ], // Base branch, MR is merged into this one
  "enabledManagers": [ "npm", "docker-compose", "dockerfile", "gitlabci", "composer" ],
  // Add labels to every MR based on language and update type
  "packageRules": [
    { "updateTypes": ["major"], "addLabels": ["SemVer Major"] },
    { "updateTypes": ["minor"], "addLabels": ["SemVer Minor"] },
    { "updateTypes": ["patch", "digest", "bump"], "addLabels": ["SemVer Patch"] },
    { "languages": ["php"], "addLabels": ["Lang PHP"] },
    { "languages": ["js"], "addLabels": ["Lang JS"] }
  ]
}

Open MRs created by Renovate with labels

Step 3 - Renovate behavior

When the Renovate bot is run, it checks if every repository contains per-repo config file renovate.json (there are few other possible names). If the config is not present, it will first create Onboarding MR with that file. No other actions are done until this MR is merged and config is created.

The next step is to check if there are no version ranges, but all versions are pinned. It means that "laravel/framework": "^8.0" is replaced into "laravel/framework": "8.21.0". See more why it is happening in Version pinning chapter. If there are some versions to pin, it will create Pinning MR. And as in the previous step, no further actions are executed until this MR is merged.

If all checks pass, Renovate will create Merge requests for libraries with newly published versions. If the library published a new minor and major version, Renovate will create 2 MRs. And it is up to you which one will be merged. If the major MR is merged, in the next run Renovate will do cleanup and close another MR and remove the branch.

Detail of MR created by Renovate

---

In my case, I set to run Renovate every 1st day of a month by Gitlab CI/CD Schedules. Then I do merges of all updates, tests, and deploy. I do not recommend to do automatically merges if the project is not fully tested. Otherwise, it can cause much more trouble, which does not worth it.

Comments

[José Díaz]

Hi Pavel. Congrats for your article, I am using renovate bot thanks to it.
I have some projects in GitHub and all have renovate bot configured. But these using public and private dependencies. I received the PR when a public dependency is updated in the maven central. But How can I do to update my private dependencies?

I see in the documentation it information:

docs.renovatebot.com/java/

Should I add a config.js in my repo with it configuration? I want to have updates of maven central + updates of my own repositories mvnrepo.cantara.no/content/reposit...

Please, give me some advice about this.
Thanks in advance.

Joe

[Pavel Kutáč]

Thanks José, nice to hear that this article help someone to use Renovate. However, I don't have any experience with that.

I would suggest you to check this page docs.renovatebot.com/getting-start... and/or search in Github Renovate discussion github.com/renovatebot/renovate/di...