Skip to content

renovate

Docs Site

Renovate

Docs Site

Docs site

The Renovate docs site is built from this repository.

The publishing process is triggered automatically on commits to main. If you have submitted a documentation PR and your changes are not published within a day feel free to ping the maintainers, on the PR that introduced the docs change.

Fenced code blocks

JSON code blocks will be validated to ensure that they are:

  • well-formed JSON
  • Renovate config which does not need config migration
  • valid Renovate configuration (with no warnings or errors)

This is validated through pnpm run doc-fence-check.

It is possible to completely ignore this validation check by using a <!-- schema-validation-disable-next-block --> comment before the code block.

Where a JSON code block is not Renovate config, you can specify:

```json {configType=none}
{
  "in": "valid"
}
```

By default, the validation treats a JSON code block as Repository Config. When writing a JSON snippet for Global Self-Hosted config, you will need to note that:

```json {configType=global}
{
  "allowedEnv": ["foo"]
}
```

It may be the case that there is a configuration warning that appears which may be safe to ignore, which can be done so with:

```json {ignoreConfigWarnings=true}
{
  "example-deprecated": true
}
```