Skip to content
Snippets Groups Projects
Name Last commit Last update
lib/modules/datasource/__snapshots__
lib/modules/datasource/adoptium-java
lib/modules/datasource/artifactory
lib/modules/datasource/aws-machine-image
lib/modules/datasource/aws-rds
lib/modules/datasource/azure-pipelines-tasks
lib/modules/datasource/bitbucket-tags
lib/modules/datasource/cdnjs
lib/modules/datasource/clojure
lib/modules/datasource/conan
lib/modules/datasource/conda
lib/modules/datasource/cpan
lib/modules/datasource/crate
lib/modules/datasource/dart-version
lib/modules/datasource/dart
lib/modules/datasource/deno
lib/modules/datasource/docker
lib/modules/datasource/dotnet
lib/modules/datasource/flutter-version
lib/modules/datasource/galaxy-collection
lib/modules/datasource/galaxy
lib/modules/datasource/git-refs
lib/modules/datasource/git-tags
lib/modules/datasource/github-releases
lib/modules/datasource/github-tags
lib/modules/datasource/gitlab-packages
lib/modules/datasource/gitlab-releases
lib/modules/datasource/gitlab-tags
lib/modules/datasource/go
lib/modules/datasource/golang-version
lib/modules/datasource/gradle-version
lib/modules/datasource/helm
lib/modules/datasource/hermit
lib/modules/datasource/hex
lib/modules/datasource/hexpm-bob
lib/modules/datasource/jenkins-plugins
lib/modules/datasource/kubernetes-api
lib/modules/datasource/maven
lib/modules/datasource/node
lib/modules/datasource/npm
lib/modules/datasource/nuget
lib/modules/datasource/orb
lib/modules/datasource/packagist
lib/modules/datasource/pod
lib/modules/datasource/puppet-forge
lib/modules/datasource/pypi
lib/modules/datasource/repology
lib/modules/datasource/ruby-version
lib/modules/datasource/rubygems
lib/modules/datasource/sbt-package
lib/modules/datasource/sbt-plugin
lib/modules/datasource/terraform-module
lib/modules/datasource/terraform-provider
lib/modules/datasource/api.ts
lib/modules/datasource/common.ts
lib/modules/datasource/datasource.spec.ts
lib/modules/datasource/datasource.ts
lib/modules/datasource/index.spec.ts
lib/modules/datasource/index.ts
lib/modules/datasource/metadata-manual.ts
lib/modules/datasource/metadata.spec.ts
lib/modules/datasource/metadata.ts
lib/modules/datasource/readme.md
lib/modules/datasource/types.ts

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.