mirror of
https://github.com/renovatebot/renovate.git
synced 2024-09-18 19:16:54 +00:00
109 lines
4.2 KiB
Markdown
109 lines
4.2 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. |
|
|
|
|
## 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.
|
|
|
|
### 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`
|
|
|
|
Example:
|
|
|
|
```json
|
|
{
|
|
"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/#changelogurl)
|
|
|
|
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/#sourceurl).
|
|
|
|
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`.
|