mirror of
https://github.com/renovatebot/renovate.git
synced 2026-10-27 07:50:47 +00:00
Jamie Tanna
128f446e08
* docs: skip validation on JSON files that aren't Renovate config
As part of future changes, we'll enable validation on all JSON code
snippets to run Config Validation.
Before we do that, we should opt-out JSON snippets that aren't anything
related to Renovate config.
* docs: don't validate invalid Renovate config
As it's intentionally referencing a manager that doesn't exist.
* docs: don't validate partial Renovate config
As part of future changes, we'll enable validation on all JSON code
snippets to run Config Validation.
There are several code snippets we have that are part of a Renovate JSON,
but it doesn't make sense to convert these to a fully passing config, as
it'd reduce clarity on what we're trying to explain.
* docs: convert `baseBranchPatterns` snippets to code blocks
So we can validate them.
* docs: make sure that `datasourceTemplate` is set
So this passes validation.
* docs: clarify that `force` is global config
As it may not be clear, so we can make it extra clear with a `.js` file,
and note that it's global self-hosted config.
* docs: make sure `packageRules` is an array
* docs: `matchBaseBranches` needs `baseBranchPatterns` to be set
* docs: correct typo for `prBodyColumns`
* docs: mark global config snippets as such
As part of future changes, we'll use this to detect whether it's global
self-hosted configuration.
* docs: make sure `packageRules` wraps its children
* docs: add `allowedHeaders`
* docs: ignore deprecation warnings
As part of future changes, we'll use this to note that we don't care
about the validation warnings.
* docs: make sure `customManagers` wraps its children
* docs: make sure `fleet` wraps its children
* docs: validate JSON snippets are valid Renovate config
To make sure that we're always presenting valid JSON configuration to
our users, we can validate them as part of `check-fenced-code`.
As well as configuration errors we can warn for warnings, but allow code
blocks to opt-out, for instance when there's a known deprecation
affecting the code block.
We need to make sure to set `allowedEnv` for various code snippets that
reference environment variables.
* docs(development): document fenced code block checks
* docs: wrap `configType` and `ignoreConfigWarnings` in `{ ... }`
As otherwise we see build failures i.e.
WARNING - Doc file 'modules/platform/gitlab/index.md' contains a link
'../../../self-hosted-configuration.md#autodiscoverrepoorder', but the doc
'self-hosted-configuration.md' does not contain an anchor '#autodiscoverrepoorder'.
This needs to be wrapped alongside all other options like `title`.
* fixup! docs: wrap `configType` and `ignoreConfigWarnings` in `{ ... }`
138 lines
5.6 KiB
Markdown
138 lines
5.6 KiB
Markdown
# Introduction
|
|
|
|
The `lib/data` folder has all our crowdsourced data files.
|
|
This readme explains what each file is used for.
|
|
|
|
## Summary
|
|
|
|
| File | What is the file about? |
|
|
| --------------------- | --------------------------------------------------- |
|
|
| `monorepo.json` | Group related packages into a single PR. |
|
|
| `replacements.json` | Rename old packages to new replacement. |
|
|
| `changelog-urls.json` | Tell Renovate where to find changelogs. |
|
|
| `source-urls.json` | Tell Renovate the source URL of packages. |
|
|
| `node-schedule.json` | Node.js versioning schedule. |
|
|
| `mise-registry.json` | Mise tool registry: short names mapped to backends. |
|
|
|
|
## Group related packages (`monorepo.json`)
|
|
|
|
The `monorepo.json` file has all the monorepo presets.
|
|
|
|
Monorepo presets group related packages, so they are updated with a single Renovate PR.
|
|
|
|
!!! note
|
|
We only accept monorepos when packages are released together.
|
|
So they should have all the same version or they strictly need to be merged together.
|
|
Otherwise those groupings would cause [immortal](https://docs.renovatebot.com/key-concepts/pull-requests/#immortal-prs) PR's.
|
|
Please add that information with links to source for validation.
|
|
|
|
### Ways to group packages
|
|
|
|
There are three ways to group packages:
|
|
|
|
| Group packages | Method |
|
|
| ----------------------------------- | --------------- |
|
|
| From the same source repository. | `repoGroups` |
|
|
| From the same organization. | `orgGroups` |
|
|
| Based on name patterns or prefixes. | `patternGroups` |
|
|
|
|
## Rename old packages (`replacements.json`)
|
|
|
|
The `replacements.json` file has all the replacement presets.
|
|
|
|
When a package gets renamed, you need to tell Renovate:
|
|
|
|
- the datasource of the package → `matchDatasources`
|
|
- the old package name → `matchPackageNames`
|
|
- the new package name → `replacementName`
|
|
- the last version available for the old package name → `matchCurrentVersion`
|
|
- the first version available for the new package name → `replacementVersion`
|
|
|
|
You can omit `replacementVersion` if the current version is the same as the new version.
|
|
|
|
Example:
|
|
|
|
```json
|
|
{
|
|
"packageRules": [
|
|
{
|
|
"matchCurrentVersion": ">=3.10.3",
|
|
"matchDatasources": ["npm"],
|
|
"matchPackageNames": [
|
|
"apollo-server",
|
|
"apollo-server-core",
|
|
"apollo-server-express"
|
|
],
|
|
"replacementName": "@apollo/server",
|
|
"replacementVersion": "4.0.0"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
## Tell Renovate where to find changelogs (`changelog-urls.json`)
|
|
|
|
The `changelog-urls.json` has all the changelog information.
|
|
|
|
Renovate nearly always finds, and displays, the changelog for a package update automatically.
|
|
|
|
Usually, the API for the package to be updated gives Renovate the correct info.
|
|
If this does not happen, for whatever reason, Renovate can not show the changelog.
|
|
|
|
You can use these config options to let Renovate find the correct changelog:
|
|
|
|
- [`changelogUrl`](https://docs.renovatebot.com/configuration-options/#packageruleschangelogurl)
|
|
|
|
Read the [Renovate docs, key concepts page for changelogs](https://docs.renovatebot.com/key-concepts/changelogs/) to learn more about how Renovate fetches and displays changelogs.
|
|
|
|
To locate the changelogs, Renovate requires:
|
|
|
|
- the name of the package (`packageName`)
|
|
- the datasource of the package
|
|
- the URL to the changelog file (`changelogUrl`)
|
|
|
|
Example:
|
|
For the `zone.js` package, the changelog URL is <https://github.com/angular/angular/blob/master/packages/zone.js/CHANGELOG.md>.
|
|
This will be added to the `npm` group in the `changelog-urls.json` file since the package's datasource is `npm`.
|
|
|
|
## Tell Renovate where to find source urls (`source-urls.json`)
|
|
|
|
The `source-urls.json` has the information on source URL of multiple packages.
|
|
|
|
Renovate nearly always finds, and displays, the source for a package update automatically.
|
|
Usually, the API for the package to be updated gives Renovate the correct info.
|
|
If this does not happen, for whatever reason, Renovate can not link to the source of the package and might not be able to lookup changelogs.
|
|
|
|
To check if Renovate can find the source URLs for your package:
|
|
|
|
1. Find the datasource for your package.
|
|
1. Read the Renovate docs for the datasource.
|
|
1. Look for a table in the docs that shows if the datasource returns source URLs.
|
|
|
|
If Renovate does not find the right source URls automatically: use the [`sourceUrl` config option](https://docs.renovatebot.com/configuration-options/#packagerulessourceurl).
|
|
|
|
To locate the source repository, Renovate requires:
|
|
|
|
- the name of the package (`packageName`)
|
|
- the datasource of the package
|
|
- the URL to the source repository (`sourceUrl`)
|
|
|
|
Example:
|
|
The source URL for the repository `cypress-io/cypress` is <https://github.com/cypress-io/cypress>.
|
|
This will be added to the `orb` group in the `source-urls.json` file since the package's datasource is `orb`.
|
|
|
|
## Node.js Versioning Schedule `node-schedule.json`
|
|
|
|
This file is automatically updated by a scheduled workflow.
|
|
It can be manually updated by running `pnpm update-static-data:node-schedule`.
|
|
|
|
## Mise tool registry (`mise-registry.json`)
|
|
|
|
This file is automatically updated by a scheduled workflow.
|
|
It can be manually updated by running `pnpm update-static-data:mise-registry`.
|
|
|
|
It maps `mise` tool short names (e.g. `zola`) to their available backends (e.g. `["aqua:getzola/zola", "asdf:salasrod/asdf-zola"]`).
|
|
The data is generated from `mise registry --json` using the [mise CLI](https://mise.jdx.dev).
|
|
|
|
This enables Renovate to automatically support all tools in the [mise registry](https://github.com/jdx/mise/tree/main/registry) without manual updates.
|