changelog for git submodules

[lkwg82]

What would you like Renovate to be able to do?

I would like to have insights into updates offered by a new submodule version besides "hash is different" ;)

Did you already have any implementation ideas?

yes

1. Add some parsing around git diff --submodule=diff.
2. Add Link to compare e.g. for gitlab https://instance/namespace/project/-/compare/07dc597c73f81bcbb370678209871f990b6c94e8...0d760e9d823c33f30649e32967d2f06f5da91710

Requirements:
Have a summary of what has changed either as commit list or as diff.

[rarkins]

This is not really a changelog by the usual definition. Sounds like you want a list of commits, which could also apply to other types of updates too. We stopped including them in repos at one point because it can introduce a huge amount of noise in some cases

[jruuttun]

I would think it's a special case for git submodules – if it were a "regular" release dependency, the changelog would be available by other means. I think a log (--oneline) of commits between the two digests would be a good baseline. Maybe there could be a configuration option for diffs as well. Just a big +1 from me, cheers and thanks for this excellent piece of software.

[lkwg82]

@rarkins added a requirement.

[rarkins]

I think a diff compare link would definitely be good

[lkwg82]

I tried already to build the link with the template variables, however the link was only given as markdown. Unwrapping markdown and adding parameters was not successfull :/.

[goodtune]

It would be nice to add a comment on the submodule path as markdown with inline code flagged as a diff -- for example, when this is the diff

diff --git a/renovate b/renovate
index 9e28ef3..70084a6 160000
--- a/renovate
+++ b/renovate
@@ -1 +1 @@
-Subproject commit 9e28ef32752536501af3fbff8a63ccbe5343591c
+Subproject commit 70084a61ef43a8d927b30b99577dd26ae40950d3

We could comment by using the output of git diff --submodule=diff like so:

Submodule renovate 9e28ef3..70084a6 (rewind):
diff --git a/renovate/lib/modules/datasource/datasource.ts b/renovate/lib/modules/datasource/datasource.ts
index 3d7fa807a..eb9ffa1ce 100644
--- a/renovate/lib/modules/datasource/datasource.ts
+++ b/renovate/lib/modules/datasource/datasource.ts
@@ -19,7 +19,7 @@ export abstract class Datasource implements DatasourceApi {
 
   defaultConfig: Record<string, unknown> | undefined;
 
-  defaultRegistryUrls?: string[] | (() => string[]);
+  defaultRegistryUrls: string[] | undefined;
 
   defaultVersioning: string | undefined;
 
diff --git a/renovate/lib/modules/datasource/index.spec.ts b/renovate/lib/modules/datasource/index.spec.ts
index ace1cba91..c2054c683 100644
--- a/renovate/lib/modules/datasource/index.spec.ts
+++ b/renovate/lib/modules/datasource/index.spec.ts
@@ -43,47 +43,6 @@ class DummyDatasource extends Datasource {
   }
 }
 
-class DummyDatasource2 extends Datasource {
-  override defaultRegistryUrls = function () {
-    return ['https://reg1.com'];
-  };
-
-  constructor(private registriesMock: RegistriesMock = defaultRegistriesMock) {
-    super(datasource);
-  }
-
-  override getReleases({
-    registryUrl,
-  }: GetReleasesConfig): Promise<ReleaseResult | null> {
-    const fn = this.registriesMock[registryUrl];
-    if (typeof fn === 'function') {
-      return Promise.resolve(fn());
-    }
-    return Promise.resolve(fn ?? null);
-  }
-}
-
-class DummyDatasource3 extends Datasource {
-  override customRegistrySupport = false;
-  override defaultRegistryUrls = function () {
-    return ['https://reg1.com'];
-  };
-
-  constructor(private registriesMock: RegistriesMock = defaultRegistriesMock) {
-    super(datasource);
-  }
-
-  override getReleases({
-    registryUrl,
-  }: GetReleasesConfig): Promise<ReleaseResult | null> {
-    const fn = this.registriesMock[registryUrl];
-    if (typeof fn === 'function') {
-      return Promise.resolve(fn());
-    }
-    return Promise.resolve(fn ?? null);
-  }
-}
-
 jest.mock('./metadata-manual', () => ({
   manualChangelogUrls: {
     dummy: {
@@ -253,30 +212,6 @@ describe('modules/datasource/index', () => {
       expect(res).toMatchObject({ releases: [{ version: '0.0.1' }] });
     });
 
-    it('defaultRegistryUrls function works', async () => {
-      datasources.set(datasource, new DummyDatasource2());
-      const res = await getPkgReleases({
-        datasource,
-        depName,
-      });
-      expect(res).toMatchObject({
-        releases: [{ version: '1.2.3' }],
-        registryUrl: 'https://reg1.com',
-      });
-    });
-
-    it('defaultRegistryUrls function with customRegistrySupport works', async () => {
-      datasources.set(datasource, new DummyDatasource3());
-      const res = await getPkgReleases({
-        datasource,
-        depName,
-      });
-      expect(res).toMatchObject({
-        releases: [{ version: '1.2.3' }],
-        registryUrl: 'https://reg1.com',
-      });
-    });
-
     it('applies extractVersion', async () => {
       const registries: RegistriesMock = {
         'https://reg1.com': {
diff --git a/renovate/lib/modules/datasource/index.ts b/renovate/lib/modules/datasource/index.ts
index ece88626a..b55b1c2e1 100644
--- a/renovate/lib/modules/datasource/index.ts
+++ b/renovate/lib/modules/datasource/index.ts
@@ -209,9 +209,7 @@ function resolveRegistryUrls(
         'Custom registries are not allowed for this datasource and will be ignored'
       );
     }
-    return is.function_(datasource.defaultRegistryUrls)
-      ? datasource.defaultRegistryUrls()
-      : datasource.defaultRegistryUrls ?? [];
+    return datasource.defaultRegistryUrls ?? [];
   }
   const customUrls = registryUrls?.filter(Boolean);
   let resolvedUrls: string[] = [];
@@ -220,9 +218,6 @@ function resolveRegistryUrls(
   } else if (is.nonEmptyArray(defaultRegistryUrls)) {
     resolvedUrls = [...defaultRegistryUrls];
     resolvedUrls.concat(additionalRegistryUrls ?? []);
-  } else if (is.function_(datasource.defaultRegistryUrls)) {
-    resolvedUrls = [...datasource.defaultRegistryUrls()];
-    resolvedUrls.concat(additionalRegistryUrls ?? []);
   } else if (is.nonEmptyArray(datasource.defaultRegistryUrls)) {
     resolvedUrls = [...datasource.defaultRegistryUrls];
     resolvedUrls.concat(additionalRegistryUrls ?? []);
diff --git a/renovate/lib/modules/datasource/types.ts b/renovate/lib/modules/datasource/types.ts
index 867c8829f..be5e106ec 100644
--- a/renovate/lib/modules/datasource/types.ts
+++ b/renovate/lib/modules/datasource/types.ts
@@ -76,7 +76,7 @@ export interface DatasourceApi extends ModuleApi {
   id: string;
   getDigest?(config: DigestConfig, newValue?: string): Promise<string | null>;
   getReleases(config: GetReleasesConfig): Promise<ReleaseResult | null>;
-  defaultRegistryUrls?: string[] | (() => string[]);
+  defaultRegistryUrls?: string[];
   defaultVersioning?: string;
   defaultConfig?: Record<string, unknown>;

This would give reviewers of the pull request the context of the change between the two revisions.

We could also do the commit log with git diff --submodule=log as below.

Submodule renovate 9e28ef3..70084a6 (rewind):
  < refactor: redefine defaultRegistryUrls (#15856)

This is all from a very toy repository I made locally, added this project as a submodule, and rewound it by a single commit.

[agners]

A changelog would be very much appreciated here as well!

I am using git submodule summary currenlty. There is a --summary-limit option which limits the summary to a certain amount of commits.