mirror of
https://github.com/renovatebot/renovate.git
synced 2026-11-02 02:29:51 +00:00
Jamie Tanna
dac1985b96
We've previously been incorrectly caching the error responses from the Go proxy occurs, which leads to a lot of "flapping" of PRs on Mend-hosted apps, and can be rather frustrating as a user (and a service owner). Per the Go proxy protocol[0], a `,` fallback strategy should only continue to the next entry on 404/410, and otherwise propagate the error. However, we currently break out of the loop and return `result` (which may be `null` if no successful requests have been performed yet). This `null` would be cached, leading to a "no releases found" (`no-result`), stored in the "hard TTL" cache, which could lead to many days without an update for given packages. To fix this, we can make sure that we propagate errors, which would mean that on an error: - if we've previously successfully retrieved the package, serve the "last good" result - if we haven't, it's a full error, and the datasource can retry [0]: https://go.dev/ref/mod#goproxy-protocol Co-authored-by: Claude Sonnet 5 <jamie.tanna+claude-code@mend.io>
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.