mirror of
https://github.com/renovatebot/renovate.git
synced 2026-11-01 10:09:50 +00:00
Sebastian Poxhofer
8f5f238b8f
* fix(datasource/crate): only query the crates.io web API for crates.io Private sparse registries such as Artifactory or CodeArtifact advertise an `api` URL in their `config.json` for publishing, but do not implement the crates.io-only read endpoints `api/v1/crates/<name>` and `api/v1/crates/<name>/<version>`. Since #41536 Renovate called both for every registry with an `api` field, producing 404s and a "Release interceptor failed" warning on each run. Restore the crates.io flavor guard for the crate metadata lookup and the release timestamp lookup. Reading `config.json` from a cloned registry is now unreachable, so drop that branch. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> * docs(datasource/crate): cite the registry web API specification in the guards * fix(datasource/crate): probe the registry web API once instead of guarding on flavor Keep the crates.io read endpoints for registries that implement them. Registries whose config.json points `api` at crates.io, such as index mirrors, are used without probing. Any other registry is probed on the first crate; a 404 for a crate that the index just returned means the endpoint does not exist, so the registry is remembered as unsupported in the memory cache and, for a day, in the package cache. The release timestamp lookup handles a 404 the same way instead of surfacing the generic "Release interceptor failed" warning. Restores the cloned config.json branch, since cloned registries can now advertise an API again. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> * fix(datasource/crate): key the unsupported web API marker by the api URL --------- Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
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.