Renovate

https://docs.renovatebot.com
Admin
Renovate is an open-source bot that automates dependency updates across multiple platforms and...
Tokens:586,860
Snippets:5,299
Trust Score:9.9
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Nested Hermit setup directory structure

Source: https://docs.renovatebot.com/modules/manager/hermit

Example directory structure for a nested Hermit setup in a single repository.

```plaintext
├bin
├─hermit
├─(other files)
├
├nested
├─bin
├──hermit
├──(other files)
```

--------------------------------

### configFileNames example

Source: https://docs.renovatebot.com/self-hosted-configuration

Example configuration for setting a custom repository config filename.

```json
{
  "configFileNames": ["myrenovate.json"]
}
```

--------------------------------

### ProjectVersion.txt example

Source: https://docs.renovatebot.com/modules/manager/unity3d

Example content of a ProjectVersion.txt file showing the two version references that Renovate updates together.

```yaml
m_EditorVersion: 2020.3.15f2
m_EditorVersionWithRevision: 2020.3.15f2 (6cf78cb77498)
```

--------------------------------

### migratePresets example

Source: https://docs.renovatebot.com/self-hosted-configuration

Example configuration for the migratePresets option, showing how to replace the '@company' preset with 'local>org/renovate-config'.

```javascript
module.exports = {
  migratePresets: {
    '@company': 'local>org/renovate-config',
  },
};

```

--------------------------------

### Example go.mod file

Source: https://docs.renovatebot.com/modules/manager/gomod

Example go.mod file showing module, go directive, and a require directive.

```go
module example

go 1.24.0

require golang.org/x/mod v0.32.0
```

--------------------------------

### Example .prototools file with tool versions

Source: https://docs.renovatebot.com/modules/manager/proto

Example of a .prototools file showing top-level key-value pairs for tool versions.

```toml
node = "22.14.0"
bun = "1.2.2"
go = "~1.22"
proto = "0.56.0"
```

--------------------------------

### Example config.js for Renovate on CodeCommit

Source: https://docs.renovatebot.com/modules/platform/codecommit

This configuration file sets the platform to 'codecommit', specifies repositories, and includes authentication credentials and package rules. Use this as a starting point for your Renovate configuration.

```javascript
module.exports = {
  endpoint: 'https://git-codecommit.us-east-1.amazonaws.com/',
  platform: 'codecommit',
  repositories: ['abc/def', 'abc/ghi'],
  username: 'ACCESS_KEY_ID_GOES_HERE',
  password: 'SECRET_ACCESS_KEY_GOES_HERE',
  token: 'AWS_SESSION_TOKEN_GOES_HERE',
  gitAuthor: 'your_email@domain',
  packageRules: [
    {
      matchPackageNames: ['package_name', 'package_name2'],
      enabled: false,
    },
  ],
};

```

--------------------------------

### Mintfile version syntax example

Source: https://docs.renovatebot.com/modules/manager/mint

Example Mintfile contents showing valid versioned dependencies and an invalid unversioned one.

```text
// Good:
SwiftGen/SwiftGen@6.6.1
realm/SwiftLint @ 0.48.0

// Bad:
yonaskolb/xcodegen
```

--------------------------------

### labels configuration example

Source: https://docs.renovatebot.com/configuration-options

Example configuration for the labels option, showing top-level labels and per-package overrides using packageRules.

```json
{
  "labels": ["dependencies"],
  "packageRules": [
    {
      "matchPackageNames": ["/eslint/"],
      "labels": ["linting"]
    }
  ]
}
```

--------------------------------

### autodiscoverProjects configuration example (Bitbucket)

Source: https://docs.renovatebot.com/self-hosted-configuration

Example configuration for autodiscoverProjects on Bitbucket, using minimatch-compatible globs or RE2-compatible regex strings.

```json
{
  "platform": "bitbucket",
  "autodiscoverProjects": ["a-group", "!another-group/some-subgroup"]
}
```

--------------------------------

### cacheTtlOverride example configuration

Source: https://docs.renovatebot.com/self-hosted-configuration

Example of the cacheTtlOverride object that maps cache namespaces to TTL values in minutes. Exact matches take priority, then longest matching pattern, then wildcard. The example shows datasource-rubygems gets 120 minutes, datasource-crate and datasource-go get 90, datasource-hex gets 60, changelog-github-release gets 45, and preset gets 30.

```json
{
  "cacheTtlOverride": {
    "datasource-rubygems": 120,
    "datasource-*": 60,
    "datasource-{crate,go}": 90,
    "/^changelog-/": 45,
    "*": 30
  }
}
```

--------------------------------

### Basic FROM instruction

Source: https://docs.renovatebot.com/modules/manager/dockerfile

Example of a `FROM` instruction that Renovate can update. This is the basic form for specifying a base image.

```dockerfile
FROM node:20.9.0
```

--------------------------------

### Pinned Terragrunt dependency example

Source: https://docs.renovatebot.com/modules/manager/terragrunt

Example of a pinned Terragrunt dependency using a GitHub source with a SemVer ref, which will get a PR when a newer version is available.

```hcl
terraform {
  source = "github.com/hashicorp/example?ref=v1.0.0"
}
```

--------------------------------

### HTTP call span calls metric example

Source: https://docs.renovatebot.com/examples/opentelemetry

Example of a calls metric generated for an HTTP call span, showing a count of 5 for a successful GET request to prometheus-community.github.io.

```promql
traces_span_metrics_calls_total{http_host="prometheus-community.github.io:443", http_method="GET", http_status_code="200", job="renovatebot.com/renovate", service_name="renovate", span_kind="SPAN_KIND_CLIENT", span_name="GET", status_code="STATUS_CODE_UNSET"} 5

```

--------------------------------

### FROM with --platform and AS flags

Source: https://docs.renovatebot.com/modules/manager/dockerfile

Example of a `FROM` instruction with advanced flags `--platform` and `AS <name>`. Renovate supports updating images with these flags.

```dockerfile
FROM --platform=linux/amd64 node:20.9.0 AS installer
```

--------------------------------

### Utilise constraints for tool requirements

Source: https://docs.renovatebot.com/configuration-options

Example of utilising constraints for tool requirements. Sets a node version constraint and installs the node tool before running npm install and npm run update-readme.

```json
{
  "constraints": {
    "node": "^18.0.0 || >=20.0.0"
  },
  "postUpgradeTasks": {
    "commands": ["npm install", "npm run update-readme"],
    "installTools": {
      "node": {}
    }
  }
}

```

--------------------------------

### matchCurrentValue regex example

Source: https://docs.renovatebot.com/configuration-options

Uses a regular expression (enclosed in slashes) to match currentValue starting with '1.'.

```json
{
  "packageRules": [
    {
      "matchPackageNames": ["io.github.resilience4j**"],
      "matchCurrentValue": "/^1\./"
    }
  ]
}
```

--------------------------------

### Crate extension variable declarations

Source: https://docs.renovatebot.com/modules/manager/bazel-module

Examples of declaring the crate extension variable, which must start with 'crate'.

```starlark
crate = use_extension("@rules_rust//crate_universe:extension.bzl", "crate")
```

```starlark
crate_1 = use_extension("@rules_rust//crate_universe:extension.bzl", "crate")
```

--------------------------------

### Maven extension variable declarations

Source: https://docs.renovatebot.com/modules/manager/bazel-module

Examples of declaring the Maven extension variable, which must start with 'maven'.

```starlark
maven = use_extension("@rules_jvm_external//:extensions.bzl", "maven")
```

```starlark
maven_1 = use_extension("@rules_jvm_external//:extensions.bzl", "maven")
```

--------------------------------

### matchCurrentValue negated regex example

Source: https://docs.renovatebot.com/configuration-options

Uses the special negated regex syntax '!/ /' to ignore versions starting with '0.'.

```json
{
  "packageRules": [
    {
      "matchPackageNames": ["io.github.resilience4j**"],
      "matchCurrentValue": "!/^0\./"
    }
  ]
}
```

--------------------------------

### repositories configuration example

Source: https://docs.renovatebot.com/self-hosted-configuration

Example of the repositories array in a Renovate config file, showing how to mix repository names and objects with overrides.

```javascript
module.exports = {
  repositories: [
    // we trust this repository's authors to run `make generate` in some cases
    {
      repository: 'g/r1',
      allowedCommands: ['^make generate$'],
    },
    // this repository doesn't get any specific configuration
    'g/r2',
  ],
};

```

--------------------------------

### Example postUpgradeTasks configuration

Source: https://docs.renovatebot.com/configuration-options

Example configuration for postUpgradeTasks. Commands must match patterns in allowedCommands (global-only) to be executed; if allowedCommands is empty, no tasks run.

```json
{
  "postUpgradeTasks": {
    "commands": ["tslint --fix"],
    "fileFilters": ["yarn.lock", "**/*.js"],
    "executionMode": "update"
  }
}
```

--------------------------------

### matchCurrentAge example

Source: https://docs.renovatebot.com/configuration-options

Groups dependencies whose current version is older than 2 years. The string must start with >, >=, <, or <= and support only one date part.

```json
{
  "packageRules": [
    {
      "matchCurrentAge": "> 2 years",
      "groupName": "old dependencies"
    }
  ]
}
```

--------------------------------

### Override goGetDirs

Source: https://docs.renovatebot.com/configuration-options

Overrides the default `./...` value for the `goGetDirs` option to run `go get` on specific directories, for example to ignore certain directories.

```json
{
  "goGetDirs": ["./some-project/", "./tools/..."]
}
```

--------------------------------

### Multiple dependencies from one step

Source: https://docs.renovatebot.com/modules/manager/github-actions

A single step can yield more than one dependency. This example shows `pnpm/setup` declaring both the pnpm version and the JavaScript runtime to install.

```yaml
steps:
  - uses: pnpm/setup@v1
    with:
      version: '12.0.0'
      runtime: 'node@24.1.0'

```

--------------------------------

### Example package directory path

Source: https://docs.renovatebot.com/modules/manager/regex

Shows a single package directory path with a version.txt file. This is used to illustrate how packageFileDir can be used in the depNameTemplate.

```text
packages/my-lib/version.txt

```

--------------------------------

### matchBaseBranches regex example

Source: https://docs.renovatebot.com/configuration-options

Uses a regular expression (enclosed in slashes) to match branches starting with 'release/'. The rule disables updates for packages not matching the eslint pattern.

```json
{
  "baseBranchPatterns": ["main", "/^release\\/.*/"],
  "packageRules": [
    {
      "matchBaseBranches": ["/^release/.*/"],
      "matchPackageNames": ["!/^eslint/"],
      "enabled": false
    }
  ]
}
```

--------------------------------

### Schedule configuration example

Source: https://docs.renovatebot.com/configuration-options

Example repository-level configuration that restricts Renovate to run outside typical business hours. Uses Cron syntax with the required '*' wildcard for minutes.

```json
{
  "description": "Schedule on weekdays at night (10 PM - 4 AM) and anytime on weekends",
  "schedule": ["* 22-23,0-4 * * *", "* * * * 0,6"]
}
```

--------------------------------

### Run Renovate with Docker tags

Source: https://docs.renovatebot.com/examples/self-hosting

Shows example Docker tags for running Renovate. The tags are outdated; use the latest from Docker Hub.

```bash
docker run --rm renovate/renovate
docker run --rm renovate/renovate:44
docker run --rm renovate/renovate:44.115
docker run --rm renovate/renovate:44.115.13

```

--------------------------------

### Add tool requirement for postUpgradeTasks

Source: https://docs.renovatebot.com/configuration-options

Example of adding a tool requirement for postUpgradeTasks. Installs the 'golang' tool before executing the command 'make generate'. Note: installTools options do not take effect when binarySource=global.

```json
{
  "postUpgradeTasks": {
    "commands": ["make generate"],
    "installTools": {
      "golang": {}
    }
  }
}

```

--------------------------------

### hostRules.readOnly example

Source: https://docs.renovatebot.com/configuration-options

Matches read-only requests (e.g., GET, HEAD, certain GraphQL queries) and uses the readOnly token. If multiple tokens match a read-only request, the readOnly token is preferred.

```json
{
  "hostRules": [
    {
      "matchHost": "api.github.com",
      "readOnly": true,
      "token": "********"
    }
  ]
}
```

--------------------------------

### Enable trace logs on hosted app with logLevelRemap

Source: https://docs.renovatebot.com/modules/datasource/custom

Configuration to get trace level logs on the Mend Renovate app by remapping log messages starting with 'Custom datasource' to info level.

```json
{
  "logLevelRemap": [
    {
      "matchMessage": "/^Custom datasource/",
      "newLogLevel": "info"
    }
  ]
}

```

--------------------------------

### Example project.toml with Docker reference URIs

Source: https://docs.renovatebot.com/modules/manager/buildpacks

Example project.toml file with Docker reference URIs. Shows how to specify a builder and buildpack group entries. The file:// URI is ignored by Renovate.

```toml
[_]
schema-version = "0.2"

[io.buildpacks]
builder = "registry.corp/builder/noble:1.1.1"

[[io.buildpacks.group]]
uri = "docker://buildpacks/java:2.2.2"

[[io.buildpacks.group]]
uri = "buildpacks/nodejs:3.3.3"

[[io.buildpacks.group]]
uri = "file://local.oci" # will be ignored
```

--------------------------------

### Example of a group/organization level preset configuration

Source: https://docs.renovatebot.com/config-presets

This snippet shows an example of a preset configuration that might be suggested when Renovate finds a repository named like '.{{platform}}' with a 'renovate-config.json' file. The preset is extended using the 'extends' key with a 'local>' prefix.

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

--------------------------------

### Configure npm version constraint in package.json

Source: https://docs.renovatebot.com/node

Use the engines.npm property in package.json to control the npm version Renovate installs when binarySource=install. The example sets a minimum of 8.1.0 and allows newer 8.x versions.

```json
{
  "engines": {
    "npm": "^8.1.0"
  }
}
```

--------------------------------

### Configuring registryUrls with packageRules

Source: https://docs.renovatebot.com/configuration-options

Example of configuring `registryUrls` manually using `packageRules`.

```json
{
  "packageRules": [
    {
      "matchDatasources": ["docker"],
      "registryUrls": ["https://docker.mycompany.domain"]
    }
  ]
}
```

--------------------------------

### hostRules.headers example

Source: https://docs.renovatebot.com/configuration-options

Configures a host rule that forwards a custom header to the HTTP request headers for the matching host. The header name starts with "X-" so it is allowed by default; headers not permitted by allowedHeaders are dropped with a warning.

```json
{
  "hostRules": [
    {
      "matchHost": "https://domain.com/all-versions",
      "headers": {
        "X-custom-header": "secret"
      }
    }
  ]
}

```

--------------------------------

### Example directory structure with version.txt files

Source: https://docs.renovatebot.com/modules/manager/regex

Shows a directory layout where each package has a version.txt file. The regex manager may need to derive the dependency name from the directory or filename.

```text
packages/
  <package-name-1>/
    version.txt
  <package-name-2>/
    version.txt

```

--------------------------------

### Install Renovate CLI via npm

Source: https://docs.renovatebot.com/examples/self-hosting

Installs Renovate globally via npm. Requires Node.js and npm. After installation, ensure required package managers and third-party tools are installed globally.

```bash
npm install -g renovate

```

--------------------------------

### bumpVersions configuration example

Source: https://docs.renovatebot.com/configuration-options

Example configuration for the bumpVersions option. It scans files named .release-version, matches the entire file content as the version string, and bumps the version to the next minor release.

```json
{
  "bumpVersions": [
    {
      "name": "Updating release version file",
      "filePatterns": [".release-version"],
      "bumpType": "minor",
      "matchStrings": ["^(?<version>.+)$"]
    }
  ]
}
```

--------------------------------

### Dockerfile: Install Google Cloud SDK

Source: https://docs.renovatebot.com/docker

Placeholder for installing the Google Cloud SDK in a Dockerfile. The comment references the official installation instructions for Debian/Ubuntu.

```dockerfile
RUN ...
```

--------------------------------

### gitIgnoredAuthors configuration example

Source: https://docs.renovatebot.com/configuration-options

Configuration example for gitIgnoredAuthors. Entries can be exact RFC5322 strings, glob patterns, or regex patterns. Use this to ignore commit authors from other bots so Renovate does not treat their PRs as modified.

```json
{
  "gitIgnoredAuthors": ["some-bot@example.org"]
}

```

--------------------------------

### Bitrise configuration example

Source: https://docs.renovatebot.com/modules/datasource/bitrise

Example Bitrise configuration showing how to use the Bitrise datasource. The `packageName` is `script` and the `registryUrl` is `https://github.com/bitrise-io/bitrise-steplib.git`.

```yaml
format_version: 11
default_step_lib_source: https://github.com/bitrise-io/bitrise-steplib.git
project_type: android
app:
  envs:
    - MY_NAME: My Name
workflows:
  test:
    steps:
      - script@1.1.5:
          inputs:
            - content: echo "Hello ${MY_NAME}!"

```

--------------------------------

### autodiscoverNamespaces configuration example

Source: https://docs.renovatebot.com/self-hosted-configuration

Example configuration for autodiscoverNamespaces, filtering by GitLab groups or subgroups.

```json
{
  "platform": "gitlab",
  "autodiscoverNamespaces": ["a-group", "another-group/some-subgroup"]
}
```

--------------------------------

### Disable Debian package updates with matchDepTypes

Source: https://docs.renovatebot.com/modules/manager/dockerfile

Renovate configuration to disable updates for Debian packages. Packages installed by a system package manager use the install depType, so matchDepTypes: ["install"] targets them.

```json
{
  "packageRules": [
    {
      "description": "Disable Debian package updates",
      "matchDepTypes": ["install"],
      "matchDatasources": ["deb"],
      "enabled": false
    }
  ]
}

```
Tokens:
Raw