mirror of
https://github.com/renovatebot/renovate.git
synced 2026-10-27 07:50:47 +00:00
Sebastian Poxhofer
a3d265d45d
* refactor(datasource): stop double-caching releases at the index level 15 datasources set `caching = true`, which makes the registry wrapper in `lib/modules/datasource/index.ts` store every `getReleases` result under `datasource-releases-<id>` for 15 minutes, while their own `cached()` wrapper already stores the same result under `datasource-<id>` with a longer TTL and stale-fallback. Drop `caching` from those 15; the four that rely on the index cache alone (dart-version, flutter-version, maven, pypi) keep it. `caching` is documented as requiring the datasource to return the `isPrivate` flag, and none of these 15 ever set it, so the index layer was caching private results unconditionally. The remaining `cached()` layer honours `cachePrivatePackages` as before. Also fix two cache-key/registry defects found alongside: - `galaxy-collection` declares `registryStrategy = 'hunt'` but keyed its cache on the package name only, so a `null` from the first hunted registry was replayed for the second one. The registry URL is now part of the key, which invalidates existing entries once. - `typst` ignores `config.registryUrl` and always reads its default registry, so it now sets `customRegistrySupport = false`. A configured `registryUrls` for typst is now warned about and ignored instead of being silently dropped. * Merge branch 'main' into secustor/refactor/datasource-remove-index-caching
Datasources
Datasources are used in Renovate primarily to fetch released versions of packages.
Follow the class-based programming style
New datasources must follow the class-based programming style.
Use the java-version datasource as a reference.
Add the datasource to the API in api.ts so that the new datasource is usable.
If you find Unused HTTP mocks errors in the Vitest tests and your mocked URLs are correct, make sure the datasource is correctly registered.
getReleases
The minimum exported interface for a datasource is a function called getReleases that takes a lookup config as input.
The config has:
packageName: the package's full name including scope if present (e.g.@foo/bar)registryUrls: an array of registry URLs to try
getReleases should return an object having:
releases: an array of strings of matched versions. This is the only mandatory fielddeprecationMessage: a string description of the package's deprecation notice, if applicablesourceUrl: a HTTP URL pointing to the source code (for example on GitHub)homepage: a HTTP URL for the package's homepage. Ideally should be empty if the homepage andsourceUrlare the samechangelogUrl: a URL pointing to the package's changelog (could be a Markdown file, for example). If not present then Renovate will search thesourceUrlfor a changelog filetags: an object mapping tag → version, for exampletags: { latest: '3.0.0' }. This is only used by thefollowTagsfunction
getDigest
Datasources that support digests (like Docker digests and Git commit hashes) can export a getDigest function.
The getDigest function has two inputs:
config: the Renovate config for the package being updated, has the same fields asgetReleasesnewValue: the version or value to retrieve the digest for
The getDigest function returns a string output representing the digest value.
If no digest is found, the getDigest function should return null.