refactor(lib/data): move metadata-manual to lib/data (#30260)

renovatebot · Jul 30, 2024 · 5d262a9 · 5d262a9
1 parent e1b5c42
commit 5d262a9
Show file tree

Hide file tree

Showing 5 changed files with 181 additions and 142 deletions.
diff --git a/docs/usage/key-concepts/changelogs.md b/docs/usage/key-concepts/changelogs.md
@@ -10,7 +10,7 @@ This page explains how Renovate fetches changelogs, when it can display them, an
 Renovate detects and populates changelogs by:
 
 1. Identifying a source URL from the datasource response for a package, and saving that internally as `sourceUrl` if found
-1. Checking if Renovate's internal [_manual_ metadata](https://github.com/renovatebot/renovate/blob/main/lib/modules/datasource/metadata-manual.ts) for the package includes a source URL
+1. Checking if Renovate's internal [_sourceUrl_ data](https://github.com/renovatebot/renovate/blob/main/lib/data/source-urls.json) for the package includes a source URL
 1. Looking up the source URL, if it resides on a supported platform (e.g. GitHub)
 1. Checking for both "Releases" metadata in the repository and any commonly known "changelog" file names
 1. Filtering the found releases to only include those versions being updated by the current PR

diff --git a/lib/data/changelog-urls.json b/lib/data/changelog-urls.json
@@ -0,0 +1,54 @@
+{
+  "npm": {
+    "babel-preset-react-app": "https://github.com/facebook/create-react-app/releases",
+    "firebase": "https://firebase.google.com/support/release-notes/js",
+    "flow-bin": "https://github.com/facebook/flow/blob/master/Changelog.md",
+    "gatsby": "https://github.com/gatsbyjs/gatsby/blob/master/packages/gatsby/CHANGELOG.md",
+    "react-native": "https://github.com/react-native-community/react-native-releases/blob/master/CHANGELOG.md",
+    "sharp": "https://github.com/lovell/sharp/blob/main/docs/changelog.md",
+    "tailwindcss-classnames": "https://github.com/muhammadsammy/tailwindcss-classnames/blob/master/CHANGELOG.md",
+    "zone.js": "https://github.com/angular/angular/blob/master/packages/zone.js/CHANGELOG.md"
+  },
+  "pypi": {
+    "beautifulsoup4": "https://bazaar.launchpad.net/~leonardr/beautifulsoup/bs4/view/head:/CHANGELOG",
+    "flake8": "https://flake8.pycqa.org/en/latest/release-notes/index.html",
+    "django-storages": "https://github.com/jschneier/django-storages/blob/master/CHANGELOG.rst",
+    "lxml": "https://git.launchpad.net/lxml/plain/CHANGES.txt",
+    "mypy": "https://mypy-lang.blogspot.com/",
+    "phonenumbers": "https://github.com/daviddrysdale/python-phonenumbers/blob/dev/python/HISTORY.md",
+    "psycopg2": "https://initd.org/psycopg/articles/tag/release/",
+    "psycopg2-binary": "https://initd.org/psycopg/articles/tag/release/",
+    "pycountry": "https://github.com/flyingcircusio/pycountry/blob/master/HISTORY.txt",
+    "django-debug-toolbar": "https://django-debug-toolbar.readthedocs.io/en/latest/changes.html",
+    "requests": "https://github.com/psf/requests/blob/master/HISTORY.md",
+    "sqlalchemy": "https://docs.sqlalchemy.org/en/latest/changelog/",
+    "uwsgi": "https://uwsgi-docs.readthedocs.io/en/latest/#release-notes"
+  },
+  "docker": {
+    "gitlab/gitlab-ce": "https://gitlab.com/gitlab-org/gitlab-foss/-/blob/master/CHANGELOG.md",
+    "gitlab/gitlab-runner": "https://gitlab.com/gitlab-org/gitlab-runner/-/blob/master/CHANGELOG.md",
+    "google/cloud-sdk": "https://cloud.google.com/sdk/docs/release-notes",
+    "neo4j": "https://neo4j.com/release-notes/",
+    "whitesource/renovate": "https://github.com/whitesource/renovate-on-prem"
+  },
+  "maven": {
+    "ch.qos.logback:logback-access": "https://logback.qos.ch/news.html",
+    "ch.qos.logback:logback-classic": "https://logback.qos.ch/news.html",
+    "ch.qos.logback:logback-core": "https://logback.qos.ch/news.html",
+    "org.slf4j:jcl-over-slf4j": "https://www.slf4j.org/news.html",
+    "org.slf4j:jul-over-slf4j": "https://www.slf4j.org/news.html",
+    "org.slf4j:jul-to-slf4j": "https://www.slf4j.org/news.html",
+    "org.slf4j:log4j-over-slf4j": "https://www.slf4j.org/news.html",
+    "org.slf4j:slf4j": "https://www.slf4j.org/news.html",
+    "org.slf4j:slf4j-android": "https://www.slf4j.org/news.html",
+    "org.slf4j:slf4j-api": "https://www.slf4j.org/news.html",
+    "org.slf4j:slf4j-bom": "https://www.slf4j.org/news.html",
+    "org.slf4j:slf4j-ext": "https://www.slf4j.org/news.html",
+    "org.slf4j:slf4j-jcl": "https://www.slf4j.org/news.html",
+    "org.slf4j:slf4j-jdk-platform-logging": "https://www.slf4j.org/news.html",
+    "org.slf4j:slf4j-migrator": "https://www.slf4j.org/news.html",
+    "org.slf4j:slf4j-nop": "https://www.slf4j.org/news.html",
+    "org.slf4j:slf4j-reload4j": "https://www.slf4j.org/news.html",
+    "org.slf4j:slf4j-simple": "https://www.slf4j.org/news.html"
+  }
+}
diff --git a/lib/data/readme.md b/lib/data/readme.md
@@ -5,10 +5,12 @@ This readme explains what each file is used for.
 
 ## Summary
 
-| File                | What is the file about?                  |
-| ------------------- | ---------------------------------------- |
-| `monorepo.json`     | Group related packages into a single PR. |
-| `replacements.json` | Rename old packages to new replacement.  |
+| File                  | What is the file about?                   |
+| --------------------- | ----------------------------------------- |
+| `monorepo.json`       | Group related packages into a single PR.  |
+| `replacements.json`   | Rename old packages to new replacement.   |
+| `changelog-urls.json` | Tell Renovate where to find changelogs.   |
+| `source-urls.json`    | Tell Renovate the source URL of packages. |
 
 ## Group related packages (`monorepo.json`)
 
@@ -53,3 +55,54 @@ Example:
   "replacementVersion": "4.0.0"
 }
 ```
+
+## Tell Renovate where to find changelogs (`changelog-urls.json`)
+
+The `changelog-urls.json` has all the changelog information.
+
+Renovate nearly always finds, and displays, the changelog for a package update automatically.
+
+Usually, the API for the package to be updated gives Renovate the correct info.
+If this does not happen, for whatever reason, Renovate can not show the changelog.
+
+You can use these config options to let Renovate find the correct changelog:
+
+- [`changelogUrl`](https://docs.renovatebot.com/configuration-options/#changelogurl)
+
+Read the [Renovate docs, key concepts page for changelogs](https://docs.renovatebot.com/key-concepts/changelogs/) to learn more about how Renovate fetches and displays changelogs.
+
+To locate the changelogs, Renovate requires:
+
+- the name of the package (`packageName`)
+- the datasource of the package
+- the URL to the changelog file (`changelogUrl`)
+
+Example:
+For the `zone.js` package, the changelog URL is <https://github.com/angular/angular/blob/master/packages/zone.js/CHANGELOG.md>.
+This will be added to the `npm` group in the `changelog-urls.json` file since the package's datasource is `npm`.
+
+## Tell Renovate where to find source urls (`source-urls.json`)
+
+The `source-urls.json` has the information on source URL of multiple packages.
+
+Renovate nearly always finds, and displays, the source for a package update automatically.
+Usually, the API for the package to be updated gives Renovate the correct info.
+If this does not happen, for whatever reason, Renovate can not link to the source of the package and might not be able to lookup changelogs.
+
+To check if Renovate can find the source URLs for your package:
+
+1. Find the datasource for your package.
+1. Read the Renovate docs for the datasource.
+1. Look for a table in the docs that shows if the datasource returns source URLs.
+
+If Renovate does not find the right source URls automatically: use the [`sourceUrl` config option](https://docs.renovatebot.com/configuration-options/#sourceurl).
+
+To locate the source repository, Renovate requires:
+
+- the name of the package (`packageName`)
+- the datasource of the package
+- the URL to the source repository (`sourceUrl`)
+
+Example:
+The source URL for the repository `cypress-io/cypress` is <https://github.com/cypress-io/cypress>.
+This will be added to the `orb` group in the `source-urls.json` file since the package's datasource is `orb`.
diff --git a/lib/data/source-urls.json b/lib/data/source-urls.json
@@ -0,0 +1,58 @@
+{
+  "orb": {
+    "cypress-io/cypress": "https://github.com/cypress-io/circleci-orb",
+    "hutson/library-release-workflows": "https://github.com/hyper-expanse/library-release-workflows"
+  },
+  "docker": {
+    "amd64/registry": "https://github.com/distribution/distribution",
+    "amd64/traefik": "https://github.com/containous/traefik",
+    "confluentinc/ksqldb-cli": "https://github.com/confluentinc/ksql",
+    "confluentinc/ksqldb-server": "https://github.com/confluentinc/ksql",
+    "crossplanecontrib/provider-helm": "https://github.com/crossplane-contrib/provider-helm",
+    "crossplanecontrib/provider-kubernetes": "https://github.com/crossplane-contrib/provider-kubernetes",
+    "coredns/coredns": "https://github.com/coredns/coredns",
+    "docker/compose": "https://github.com/docker/compose",
+    "drone/drone": "https://github.com/drone/drone",
+    "drone/drone-runner-docker": "https://github.com/drone-runners/drone-runner-docker",
+    "drone/drone-runner-kube": "https://github.com/drone-runners/drone-runner-kube",
+    "drone/drone-runner-ssh": "https://github.com/drone-runners/drone-runner-ssh",
+    "gcr.io/kaniko-project/executor": "https://github.com/GoogleContainerTools/kaniko",
+    "gitlab/gitlab-ce": "https://gitlab.com/gitlab-org/gitlab-foss",
+    "gitlab/gitlab-runner": "https://gitlab.com/gitlab-org/gitlab-runner",
+    "gitea/gitea": "https://github.com/go-gitea/gitea",
+    "hashicorp/terraform": "https://github.com/hashicorp/terraform",
+    "mcr.microsoft.com/dotnet/aspnet": "https://github.com/dotnet/aspnetcore",
+    "mcr.microsoft.com/dotnet/monitor": "https://github.com/dotnet/dotnet-monitor",
+    "mcr.microsoft.com/dotnet/runtime": "https://github.com/dotnet/runtime",
+    "mcr.microsoft.com/dotnet/runtime-deps": "https://github.com/dotnet/runtime",
+    "mcr.microsoft.com/dotnet/sdk": "https://github.com/dotnet/sdk",
+    "node": "https://github.com/nodejs/node",
+    "registry": "https://github.com/distribution/distribution",
+    "traefik": "https://github.com/containous/traefik",
+    "kudobuilder/kuttl": "https://github.com/kudobuilder/kuttl",
+    "prom/blackbox-exporter": "https://github.com/prometheus/blackbox_exporter",
+    "xpkg.upbound.io/upbound/provider-gcp": "https://github.com/upbound/provider-gcp"
+  },
+  "helm": {
+    "crossplane": "https://github.com/crossplane/crossplane",
+    "interoperator": "https://github.com/cloudfoundry/service-fabrik-broker",
+    "kyverno": "https://github.com/kyverno/kyverno"
+  },
+  "kubernetes": {
+    "node": "https://github.com/nodejs/node"
+  },
+  "maven": {
+    "com.figure.gradle.semver-plugin:com.figure.gradle.semver-plugin.gradle.plugin": "https://github.com/FigureTechnologies/gradle-semver-plugin"
+  },
+  "npm": {
+    "node": "https://github.com/nodejs/node"
+  },
+  "nvm": {
+    "node": "https://github.com/nodejs/node"
+  },
+  "pypi": {
+    "mkdocs": "https://github.com/mkdocs/mkdocs",
+    "mkdocs-material": "https://github.com/squidfunk/mkdocs-material",
+    "mypy": "https://github.com/python/mypy"
+  }
+}
diff --git a/lib/modules/datasource/metadata-manual.ts b/lib/modules/datasource/metadata-manual.ts
@@ -1,140 +1,14 @@
-// Use this object to define changelog URLs for packages
+import changelogUrls from '../../data/changelog-urls.json';
+import sourceUrls from '../../data/source-urls.json';
+
 // Only necessary when the changelog data cannot be found in the package's source repository
-export const manualChangelogUrls: Record<string, Record<string, string>> = {
-  npm: {
-    'babel-preset-react-app':
-      'https://github.com/facebook/create-react-app/releases',
-    firebase: 'https://firebase.google.com/support/release-notes/js',
-    'flow-bin': 'https://github.com/facebook/flow/blob/master/Changelog.md',
-    gatsby:
-      'https://github.com/gatsbyjs/gatsby/blob/master/packages/gatsby/CHANGELOG.md',
-    'react-native':
-      'https://github.com/react-native-community/react-native-releases/blob/master/CHANGELOG.md',
-    sharp: 'https://github.com/lovell/sharp/blob/main/docs/changelog.md',
-    'tailwindcss-classnames':
-      'https://github.com/muhammadsammy/tailwindcss-classnames/blob/master/CHANGELOG.md',
-    'zone.js':
-      'https://github.com/angular/angular/blob/master/packages/zone.js/CHANGELOG.md',
-  },
-  pypi: {
-    beautifulsoup4:
-      'https://bazaar.launchpad.net/~leonardr/beautifulsoup/bs4/view/head:/CHANGELOG',
-    flake8: 'https://flake8.pycqa.org/en/latest/release-notes/index.html',
-    'django-storages':
-      'https://github.com/jschneier/django-storages/blob/master/CHANGELOG.rst',
-    lxml: 'https://git.launchpad.net/lxml/plain/CHANGES.txt',
-    mypy: 'https://mypy-lang.blogspot.com/',
-    phonenumbers:
-      'https://github.com/daviddrysdale/python-phonenumbers/blob/dev/python/HISTORY.md',
-    psycopg2: 'https://initd.org/psycopg/articles/tag/release/',
-    'psycopg2-binary': 'https://initd.org/psycopg/articles/tag/release/',
-    pycountry:
-      'https://github.com/flyingcircusio/pycountry/blob/master/HISTORY.txt',
-    'django-debug-toolbar':
-      'https://django-debug-toolbar.readthedocs.io/en/latest/changes.html',
-    requests: 'https://github.com/psf/requests/blob/master/HISTORY.md',
-    sqlalchemy: 'https://docs.sqlalchemy.org/en/latest/changelog/',
-    uwsgi: 'https://uwsgi-docs.readthedocs.io/en/latest/#release-notes',
-  },
-  docker: {
-    'gitlab/gitlab-ce':
-      'https://gitlab.com/gitlab-org/gitlab-foss/-/blob/master/CHANGELOG.md',
-    'gitlab/gitlab-runner':
-      'https://gitlab.com/gitlab-org/gitlab-runner/-/blob/master/CHANGELOG.md',
-    'google/cloud-sdk': 'https://cloud.google.com/sdk/docs/release-notes',
-    neo4j: 'https://neo4j.com/release-notes/',
-    'whitesource/renovate': 'https://github.com/whitesource/renovate-on-prem',
-  },
-  maven: {
-    'ch.qos.logback:logback-access': 'https://logback.qos.ch/news.html',
-    'ch.qos.logback:logback-classic': 'https://logback.qos.ch/news.html',
-    'ch.qos.logback:logback-core': 'https://logback.qos.ch/news.html',
-    'org.slf4j:jcl-over-slf4j': 'https://www.slf4j.org/news.html',
-    'org.slf4j:jul-over-slf4j': 'https://www.slf4j.org/news.html',
-    'org.slf4j:jul-to-slf4j': 'https://www.slf4j.org/news.html',
-    'org.slf4j:log4j-over-slf4j': 'https://www.slf4j.org/news.html',
-    'org.slf4j:slf4j': 'https://www.slf4j.org/news.html',
-    'org.slf4j:slf4j-android': 'https://www.slf4j.org/news.html',
-    'org.slf4j:slf4j-api': 'https://www.slf4j.org/news.html',
-    'org.slf4j:slf4j-bom': 'https://www.slf4j.org/news.html',
-    'org.slf4j:slf4j-ext': 'https://www.slf4j.org/news.html',
-    'org.slf4j:slf4j-jcl': 'https://www.slf4j.org/news.html',
-    'org.slf4j:slf4j-jdk-platform-logging': 'https://www.slf4j.org/news.html',
-    'org.slf4j:slf4j-migrator': 'https://www.slf4j.org/news.html',
-    'org.slf4j:slf4j-nop': 'https://www.slf4j.org/news.html',
-    'org.slf4j:slf4j-reload4j': 'https://www.slf4j.org/news.html',
-    'org.slf4j:slf4j-simple': 'https://www.slf4j.org/news.html',
-  },
-};
+export const manualChangelogUrls: Record<
+  string,
+  Record<string, string>
+> = changelogUrls;
 
-// Use this object to define manual source URLs for packages
 // Only necessary if the datasource is unable to locate the source URL itself
-export const manualSourceUrls: Record<string, Record<string, string>> = {
-  orb: {
-    'cypress-io/cypress': 'https://github.com/cypress-io/circleci-orb',
-    'hutson/library-release-workflows':
-      'https://github.com/hyper-expanse/library-release-workflows',
-  },
-  docker: {
-    'amd64/registry': 'https://github.com/distribution/distribution',
-    'amd64/traefik': 'https://github.com/containous/traefik',
-    'confluentinc/ksqldb-cli': 'https://github.com/confluentinc/ksql',
-    'confluentinc/ksqldb-server': 'https://github.com/confluentinc/ksql',
-    'crossplanecontrib/provider-helm':
-      'https://github.com/crossplane-contrib/provider-helm',
-    'crossplanecontrib/provider-kubernetes':
-      'https://github.com/crossplane-contrib/provider-kubernetes',
-    'coredns/coredns': 'https://github.com/coredns/coredns',
-    'docker/compose': 'https://github.com/docker/compose',
-    'drone/drone': 'https://github.com/drone/drone',
-    'drone/drone-runner-docker':
-      'https://github.com/drone-runners/drone-runner-docker',
-    'drone/drone-runner-kube':
-      'https://github.com/drone-runners/drone-runner-kube',
-    'drone/drone-runner-ssh':
-      'https://github.com/drone-runners/drone-runner-ssh',
-    'gcr.io/kaniko-project/executor':
-      'https://github.com/GoogleContainerTools/kaniko',
-    'gitlab/gitlab-ce': 'https://gitlab.com/gitlab-org/gitlab-foss',
-    'gitlab/gitlab-runner': 'https://gitlab.com/gitlab-org/gitlab-runner',
-    'gitea/gitea': 'https://github.com/go-gitea/gitea',
-    'hashicorp/terraform': 'https://github.com/hashicorp/terraform',
-    'mcr.microsoft.com/dotnet/aspnet': 'https://github.com/dotnet/aspnetcore',
-    'mcr.microsoft.com/dotnet/monitor':
-      'https://github.com/dotnet/dotnet-monitor',
-    'mcr.microsoft.com/dotnet/runtime': 'https://github.com/dotnet/runtime',
-    'mcr.microsoft.com/dotnet/runtime-deps':
-      'https://github.com/dotnet/runtime',
-    'mcr.microsoft.com/dotnet/sdk': 'https://github.com/dotnet/sdk',
-    node: 'https://github.com/nodejs/node',
-    registry: 'https://github.com/distribution/distribution',
-    traefik: 'https://github.com/containous/traefik',
-    'kudobuilder/kuttl': 'https://github.com/kudobuilder/kuttl',
-    'prom/blackbox-exporter': 'https://github.com/prometheus/blackbox_exporter',
-    'xpkg.upbound.io/upbound/provider-gcp':
-      'https://github.com/upbound/provider-gcp',
-  },
-  helm: {
-    crossplane: 'https://github.com/crossplane/crossplane',
-    interoperator: 'https://github.com/cloudfoundry/service-fabrik-broker',
-    kyverno: 'https://github.com/kyverno/kyverno',
-  },
-  kubernetes: {
-    node: 'https://github.com/nodejs/node',
-  },
-  maven: {
-    'com.figure.gradle.semver-plugin:com.figure.gradle.semver-plugin.gradle.plugin':
-      'https://github.com/FigureTechnologies/gradle-semver-plugin',
-  },
-  npm: {
-    node: 'https://github.com/nodejs/node',
-  },
-  nvm: {
-    node: 'https://github.com/nodejs/node',
-  },
-  pypi: {
-    mkdocs: 'https://github.com/mkdocs/mkdocs',
-    'mkdocs-material': 'https://github.com/squidfunk/mkdocs-material',
-    mypy: 'https://github.com/python/mypy',
-  },
-};
+export const manualSourceUrls: Record<
+  string,
+  Record<string, string>
+> = sourceUrls;