renovate/lib/modules/datasource
2022-07-22 12:18:58 +00:00
..
__snapshots__ refactor: lib/modules () 2022-03-04 09:04:02 +01:00
adoptium-java refactor: rename lookupName -> packageName () 2022-03-04 09:04:02 +01:00
artifactory refactor: rename lookupName -> packageName () 2022-03-04 09:04:02 +01:00
aws-machine-image build(deps): update aws-sdk-js-v3 monorepo () 2022-06-27 05:31:34 +00:00
bitbucket-tags refactor(datasource): Prefer interface over type () 2022-07-22 12:18:58 +00:00
cdnjs refactor(modules/datasource): fix null-check issues () 2022-06-20 16:24:37 +02:00
clojure refactor: remove deprecated loadFixture calls () 2022-07-04 04:18:53 +00:00
conan refactor: fix prefer-nullish-coalescing () 2022-06-21 12:02:49 +00:00
conda refactor: rename lookupName -> packageName () 2022-03-04 09:04:02 +01:00
crate test(datasource): Avoid snapshots for testing EXTERNAL_HOST_ERROR () 2022-07-22 06:49:05 +02:00
dart test(datasource): Avoid snapshots for testing EXTERNAL_HOST_ERROR () 2022-07-22 06:49:05 +02:00
docker refactor(datasource/docker): types cleanup () 2022-07-14 22:27:31 +03:00
flutter-version refactor(modules/datasource): fix null-check issues () 2022-06-20 16:24:37 +02:00
galaxy test(datasource): Avoid snapshots for testing EXTERNAL_HOST_ERROR () 2022-07-22 06:49:05 +02:00
galaxy-collection refactor(modules/datasource): fix null-check issues () 2022-06-20 16:24:37 +02:00
git-refs fix(git-refs): gracefully ignore git-refs auth error () 2022-07-16 15:48:26 +02:00
git-tags refactor: fix prefer-nullish-coalescing () 2022-06-21 12:02:49 +00:00
github-releases refactor(datasource): Prefer interface over type () 2022-07-22 12:18:58 +00:00
github-tags fix(github-tags): Use releaseTimestamp from tagger object () 2022-07-02 09:46:48 +02:00
gitlab-packages refactor(modules/datasource): fix null-check issues () 2022-06-20 16:24:37 +02:00
gitlab-releases refactor(modules/datasource): fix null-check issues () 2022-06-20 16:24:37 +02:00
gitlab-tags refactor(datasource): Prefer interface over type () 2022-07-22 12:18:58 +00:00
go refactor: remove deprecated loadFixture calls () 2022-07-04 04:18:53 +00:00
golang-version refactor: strict datasource tests () 2022-06-20 13:15:02 +02:00
gradle-version test(datasource): remove unnecessary optional chaining in tests () 2022-07-14 05:28:51 +00:00
helm test(datasource): Avoid snapshots for testing EXTERNAL_HOST_ERROR () 2022-07-22 06:49:05 +02:00
hermit feat: add datasource for Hermit package manager () 2022-07-15 09:57:05 +00:00
hex refactor: strict datasource tests () 2022-06-20 13:15:02 +02:00
jenkins-plugins test(datasource): remove unnecessary optional chaining in tests () 2022-07-14 05:28:51 +00:00
maven docs: Maven - Ensure changelog is fetchable () 2022-07-03 15:31:23 +00:00
node refactor: strict datasource tests () 2022-06-20 13:15:02 +02:00
npm refactor(datasource): Prefer interface over type () 2022-07-22 12:18:58 +00:00
nuget refactor: remove deprecated loadFixture calls () 2022-07-04 04:18:53 +00:00
orb test: enforce lint style rules () 2022-04-12 14:49:49 +00:00
packagist refactor: remove deprecated loadFixture calls () 2022-07-04 04:18:53 +00:00
pod fix(pod): Massage only registry URLs that matched the GitHub regex 2022-04-20 14:49:08 +02:00
puppet-forge feat: add librarian-puppet support () 2022-07-17 05:27:35 +03:00
pypi refactor(datasource): Prefer interface over type () 2022-07-22 12:18:58 +00:00
repology test(datasource): remove unnecessary optional chaining in tests () 2022-07-14 05:28:51 +00:00
ruby-version refactor(datasources): strict null checks done () 2022-04-16 12:57:12 +01:00
rubygems test(datasource): remove unnecessary optional chaining in tests () 2022-07-14 05:28:51 +00:00
sbt-package refactor: strict datasource tests () 2022-06-20 13:15:02 +02:00
sbt-plugin refactor: strict datasource tests () 2022-06-20 13:15:02 +02:00
terraform-module feat(datasource:terraform): use official api for custom registries () 2022-05-16 19:31:02 +00:00
terraform-provider feat(datasource:terraform): use official api for custom registries () 2022-05-16 19:31:02 +00:00
api.ts feat: add librarian-puppet support () 2022-07-17 05:27:35 +03:00
common.ts refactor: lib/modules () 2022-03-04 09:04:02 +01:00
datasource.spec.ts refactor(modules/datasource): fix null-check issues () 2022-06-20 16:24:37 +02:00
datasource.ts refactor: redefine defaultRegistryUrls () 2022-06-16 13:00:11 +02:00
index.spec.ts fix: assign default versioning before applying package rules () 2022-07-03 18:11:20 +02:00
index.ts fix: assign default versioning before applying package rules () 2022-07-03 18:11:20 +02:00
metadata-manual.ts fix: switch changelog urls from http to https () 2022-07-01 04:57:07 +00:00
metadata.spec.ts test: enforce lint style rules () 2022-04-12 14:49:49 +00:00
metadata.ts refactor(darasource): checks and massage url in metadata () 2022-07-19 05:31:01 +00:00
readme.md docs: replace encounter with find () 2022-03-16 14:54:45 +01:00
types.ts refactor: redefine defaultRegistryUrls () 2022-06-16 13:00:11 +02:00

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 adoptium-java datasource as a reference.

Add the datasource to the API in api.ts so that the new datasource is usable. If you find Pending mocks! errors in the Jest tests and your mocked URLs are correct, ensure 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 field.
  • deprecationMessage: a string description of the package's deprecation notice, if applicable
  • sourceUrl: a HTTP URL pointing to the source code (e.g. on GitHub)
  • homepage: a HTTP URL for the package's homepage. Ideally should be empty if the homepage and sourceUrl are the same
  • changelogUrl: a URL pointing to the package's Changelog (could be a Markdown file, for example). If not present then Renovate will search the sourceUrl for a changelog file.
  • tags: an object mapping tag -> version, e.g. tags: { latest: '3.0.0' }. This is only used by the followTags function.

getDigest

Datasources that support the concept of digests (e.g. Docker digests and Git commit hashes) also can export a getDigest function.

The getDigest function has two inputs:

  • config: the Renovate config for the package being updated, has the same fields as getReleases
  • newValue: the version or value to retrieve the digest for

The getDigest function returns a string output representing the digest value. If none is found then a return value of null should be returned.