feat: add changelogContent property (renovatebot#36340)

Author: bdovaz

lib/modules/datasource/types.ts

@@ -55,6 +55,7 @@ export interface GetPkgReleasesConfig {
 }
 
 export interface Release {
+  changelogContent?: string;
   changelogUrl?: string;
   checksumUrl?: string;
   downloadUrl?: string;
@@ -81,6 +82,7 @@ export interface ReleaseResult {
   isPrivate?: boolean;
   releases: Release[];
   tags?: Record<string, string> | undefined;
+  changelogContent?: string;
   // URL metadata
   changelogUrl?: string;
   dependencyUrl?: string;

lib/workers/repository/changelog/index.spec.ts

@@ -19,12 +19,27 @@ describe('workers/repository/changelog/index', () => {
       partial<BranchUpgradeConfig>({ logJSON: null }),
       partial<BranchUpgradeConfig>(),
       partial<BranchUpgradeConfig>(),
+      partial<BranchUpgradeConfig>({ changelogContent: 'testContent' }),
     ];
     await expect(embedChangelogs(branches)).toResolve();
     expect(branches).toEqual([
       { logJSON: null },
       { logJSON: { hasReleaseNotes: true } },
       { logJSON: null },
+      {
+        changelogContent: 'testContent',
+        logJSON: {
+          hasReleaseNotes: true,
+          project: {},
+          versions: [
+            {
+              releaseNotes: {
+                body: 'testContent',
+              },
+            },
+          ],
+        },
+      },
     ]);
   });
 });

lib/workers/repository/changelog/index.ts

@@ -9,7 +9,38 @@ export async function embedChangelog(
   if (upgrade.logJSON !== undefined) {
     return;
   }
-  upgrade.logJSON = await getChangeLogJSON(upgrade);
+
+  if (upgrade.changelogContent === undefined) {
+    upgrade.logJSON = await getChangeLogJSON(upgrade);
+  } else {
+    upgrade.logJSON = {
+      hasReleaseNotes: true,
+      project: {
+        packageName: upgrade.packageName,
+        depName: upgrade.depName,
+        type: undefined!,
+        apiBaseUrl: undefined!,
+        baseUrl: undefined!,
+        repository: upgrade.repository!,
+        sourceUrl: upgrade.sourceUrl!,
+        sourceDirectory: upgrade.sourceDirectory,
+      },
+      versions: [
+        {
+          changes: undefined!,
+          compare: undefined!,
+          date: undefined!,
+          releaseNotes: {
+            body: upgrade.changelogContent,
+            notesSourceUrl: undefined!,
+            url: upgrade.changelogUrl!,
+          },
+          gitRef: undefined!,
+          version: upgrade.newVersion!,
+        },
+      ],
+    };
+  }
 }
 
 export async function embedChangelogs(

lib/workers/repository/process/lookup/index.spec.ts

@@ -5452,5 +5452,51 @@ describe('workers/repository/process/lookup/index', () => {
         },
       ]);
     });
+
+    it('handles changelog with content', async () => {
+      config.currentValue = '8.0.0';
+      config.packageName = 'node';
+      config.datasource = DockerDatasource.id;
+      getDockerReleases.mockResolvedValueOnce({
+        releases: [
+          {
+            version: '8.0.0',
+          },
+          {
+            changelogContent: 'testContent',
+            changelogUrl: 'http://testChangelogUrl',
+            version: '8.1.0',
+          },
+        ],
+      });
+
+      const res = await Result.wrap(
+        lookup.lookupUpdates(config),
+      ).unwrapOrThrow();
+
+      expect(res).toEqual({
+        changelogContent: 'testContent',
+        changelogUrl: 'http://testChangelogUrl',
+        currentVersion: '8.0.0',
+        fixedVersion: '8.0.0',
+        isSingleVersion: true,
+        registryUrl: 'https://index.docker.io',
+        sourceUrl: 'https://github.com/nodejs/node',
+        updates: [
+          {
+            bucket: 'non-major',
+            isBreaking: false,
+            newMajor: 8,
+            newMinor: 1,
+            newPatch: 0,
+            newValue: '8.1.0',
+            newVersion: '8.1.0',
+            updateType: 'minor',
+          },
+        ],
+        versioning: 'npm',
+        warnings: [],
+      });
+    });
   });
 });

lib/workers/repository/process/lookup/index.ts

@@ -760,6 +760,18 @@ export async function lookupUpdates(
           /* istanbul ignore next */ update.updateType !== 'rollback',
       );
     }
+
+    const release =
+      res.updates.length > 0
+        ? dependency?.releases.find(
+            (r) => r.version === res.updates[0].newValue,
+          )
+        : null;
+
+    if (release?.changelogContent) {
+      res.changelogContent = release.changelogContent;
+      res.changelogUrl = release.changelogUrl;
+    }
   } catch (err) /* istanbul ignore next */ {
     if (err instanceof ExternalHostError) {
       return Result.err(err);

lib/workers/repository/process/lookup/types.ts

@@ -58,6 +58,7 @@ export interface LookupUpdateConfig
 
 export interface UpdateResult {
   sourceDirectory?: string;
+  changelogContent?: string;
   changelogUrl?: string;
   dependencyUrl?: string;
   homepage?: string;

lib/workers/types.ts

@@ -79,6 +79,7 @@ export interface BranchUpgradeConfig
 
   hasReleaseNotes?: boolean;
   homepage?: string;
+  changelogContent?: string;
   changelogUrl?: string;
   dependencyUrl?: string;
   sourceUrl?: string;