mirror of
https://github.com/renovatebot/renovate.git
synced 2026-10-26 15:31:53 +00:00
Sebastian Poxhofer
b8f6dbb83e
* refactor(datasource): expose the source URL of the git host tags datasources getSourceUrl() becomes a public instance method of every git host tags datasource. github-tags and gitlab-tags gain it next to a static getSourceUrl(), and the Gitea base derives it from its default registry. * refactor(datasource/gitea-tags): extend GitHostTagsDigestDatasource The Gitea and Forgejo tags and releases datasources keep their cache keys and only cache lookups against the public instance, through a new isCacheable() hook of the base class. The cache key of a releases lookup now ends in ':tags' like every other one, in its own namespace. * refactor(datasource/gitlab-tags): extend GitHostTagsDigestDatasource The tags, digests and tag commits are cached under the '<registryUrl>:<repo>:<type>' keys of the base class, so the first lookup after the upgrade misses the package cache. * refactor(datasource/github-tags): extend GitHostTagsDigestDatasource getReleases() and getDigest() skip the package cache of the base class, because the GraphQL fetcher already caches the tags with their commits and the HTTP client caches the latest commit in memory. The releases now carry their registryUrl like the other tags datasources. * fix(datasource): only cache git host tags lookups known to be public A tags lookup may read a private repository, so GitHostTagsDatasource no longer writes it to the package cache by default. Gitea and Forgejo keep caching their public instance; Bitbucket Cloud, Bitbucket Data Center, Azure DevOps and GitLab lookups are cached only with cachePrivatePackages. The Bitbucket main branch cache follows the same rule. * test(datasource): cover the default registry of github-tags and gitlab-tags * docs(datasource/github-tags): drop the cache note from getDigest * refactor(datasource): keep caching git host tags lookups by default * refactor(datasource): keep getSourceUrl of the git host tags datasources protected * refactor(datasource): default getRegistryUrl and resolve the URL for isCacheable * fix(datasource/gitlab-tags): normalise the registry URL like main * refactor(datasource): cache tag digests only once * refactor(datasource/github-tags): skip the package cache through a base hook * refactor(datasource): document getSourceUrl once in the base class * refactor(datasource/bitbucket-tags): inline the static registry URL helper * refactor(datasource): rename usePackageCache to useGitHostTagCaching * refactor(datasource): drop isCacheableFor and useGitHostTagCaching
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.