feat(gerrit): Add gitUrl support by spmiller · Pull Request #42672 · renovatebot/renovate

spmiller · 2026-04-15T23:37:38Z

Changes

This change adds support for the existing gitUrl parameter to the gerrit platform.

The existing behaviour (when gitUrl is not specified) is left unchanged, and is mapped to the default and endpoint values of gitUrl.

Context

Please select one of the following:

This closes an existing Issue, Closes: #
This doesn't close an Issue, but I accept the risk that this PR may be closed if maintainers disagree with its opening or implementation

AI assistance disclosure

Did you use AI tools to create any part of this pull request?

Please select one option and, if yes, briefly describe how AI was used (e.g., code, tests, docs) and which tool(s) you used.

No — I did not use AI for this contribution.
Yes — minimal assistance (e.g., IDE autocomplete, small code completions, grammar fixes).
Yes — substantive assistance (AI-generated non‑trivial portions of code, tests, or documentation).
Yes — other (please describe):
I asked Claude which API provided the download schemes in Gerrit. No AI was used for the coding.

Documentation (please check one with an [x])

I have updated the documentation, or
No documentation update is required

I added Gerrit as a supported platform for the parameter gitUrl in config/options/index.ts

How I've tested my work (please select one)

I have verified these changes via:

Code inspection only, or
Newly added/modified unit tests, or
No unit tests, but ran on a real repository, or
Both unit tests + ran on a real repository

My Gerrit server is not publicly available, but with my changes Renovate was able to clone the repo over SSH.

This change adds support for the gitUrl parameter to the gerrit platform. It queries the gerrit server to check what download options are available. If ssh is selected but not available, it will throw an error.

This removes support for querying the supported download schemes and instead hard-codes the default ssh port.

felipecrs

Otherwise, LGTM.

felipecrs · 2026-04-16T10:32:29Z

  );
+
+  const sshUrl = new URL(
+    `ssh://${endpointUrl.host}:29418${joinUrlParts(endpointUrl.pathname, repository)}`,


Can you please extract the port number to a constant?

felipecrs · 2026-04-16T10:47:24Z

-  url.password = opts.password;
-  url.pathname = joinUrlParts(
-    url.pathname,
+  const httpUrl = new URL(endpointUrl.toString());


Nitpick, but maybe using clone from util/clone.ts would be nicer.

felipecrs · 2026-04-16T10:48:49Z

    encodeURIComponent(repository),
  );
+
+  const sshUrl = new URL(


You should probably use parseUrl here too.

felipecrs · 2026-04-16T10:58:23Z

@spmiller, this reminded me of a very old discussion:

Support Git remote providers running behind a reverse proxy gitkraken/vscode-gitlens#1964

In that discussion, the Gerrit URL would be something like <host>/gerrit/<projectPath>, as well as the HTTP clone URL, while the SSH clone URL would be something like <host>/<projectPath>, without the path prefix.

Maybe you can extract the prefix from the configured platform URL and "subtract" it from the generated SSH URL?

spmiller · 2026-04-17T00:32:55Z

@spmiller, this reminded me of a very old discussion:

Maybe you can extract the prefix from the configured platform URL and "subtract" it from the generated SSH URL?

Hey @felipecrs, this old discussion is gold! Having some actual config examples makes it much easier to solve the problem. I think the behaviour in my PR would not work for their server.

It got me thinking, maybe my original approach (query the server to get the download schemes) wasn't so bad after all? It was an extra API call (config/server/info) but I could Promise.all them quite easily to get it in parallel. We wouldn't have to have extra logic to extract the prefix.

The trade-off is more code in the client/types files. Perhaps it's worth it?

This is the original commit I made in case you want to compare:
spmiller@bb187fa#diff-9e28b3970977a05aec269cd0b4fb67427dc51bdb6a1e10281f1dc214c69c56f8

marquisesenior383-ctrl · 2026-04-17T00:52:18Z

No stop whatever you doing now 5019

…

On Thu, Apr 16, 2026, 18:33 spmiller ***@***.***> wrote: *spmiller* left a comment (renovatebot/renovate#42672) <#42672 (comment)> @spmiller <https://github.com/spmiller>, this reminded me of a very old discussion: Maybe you can extract the prefix from the configured platform URL and "subtract" it from the generated SSH URL? Hey @felipecrs <https://github.com/felipecrs>, this old discussion is gold! Having some actual config examples makes it much easier to solve the problem. I think the behaviour in my PR would not work for their server. It got me thinking, maybe my original approach (query the server to get the download schemes) wasn't so bad after all? It was an extra API call ( config/server/info) but I could Promise.all them quite easily to get it in parallel. We wouldn't have to have extra logic to extract the prefix. The trade-off is more code in the client/types files. Perhaps it's worth it? This is the original commit I made in case you want to compare: ***@***.*** #diff-9e28b3970977a05aec269cd0b4fb67427dc51bdb6a1e10281f1dc214c69c56f8 <spmiller@bb187fa#diff-9e28b3970977a05aec269cd0b4fb67427dc51bdb6a1e10281f1dc214c69c56f8> — Reply to this email directly, view it on GitHub <#42672 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/CBXT7ICNFUE2GFVOFJZZRVD4WF3U7AVCNFSM6AAAAACX23P6QCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHM2DENRUGM4DANBYGE> . You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>

felipecrs · 2026-04-17T02:25:23Z

@spmiller, you only need to make these changes:

diff --git a/lib/modules/platform/gerrit/utils.spec.ts b/lib/modules/platform/gerrit/utils.spec.ts
index a6f7b7a72..7515b781f 100644
--- a/lib/modules/platform/gerrit/utils.spec.ts
+++ b/lib/modules/platform/gerrit/utils.spec.ts
@@ -100,7 +100,7 @@ describe('modules/platform/gerrit/utils', () => {
           'https://gerrit.example.com/context',
           'ssh',
         );
-        expect(repoUrl).toBe('ssh://gerrit.example.com:29418/context/web/apps');
+        expect(repoUrl).toBe('ssh://gerrit.example.com:29418/web/apps');
       });
     });
   });
diff --git a/lib/modules/platform/gerrit/utils.ts b/lib/modules/platform/gerrit/utils.ts
index 5f24e3635..9d7ffde83 100644
--- a/lib/modules/platform/gerrit/utils.ts
+++ b/lib/modules/platform/gerrit/utils.ts
@@ -62,7 +62,7 @@ export function getGerritRepoUrl(
   );
 
   const sshUrl = new URL(
-    `ssh://${endpointUrl.host}:29418${joinUrlParts(endpointUrl.pathname, repository)}`,
+    `ssh://${endpointUrl.host}:29418/${repository}`,
   );
 
   const url = pickUrlFromGitUrl(gitUrl, sshUrl, httpUrl);

Addresses feedback left in review: - constants for ports - better SSH url creation - more consistent util method usage

felipecrs

LGTM.

felipecrs · 2026-04-17T03:53:15Z

+  const sshUrl = parseUrl(
+    `ssh://${endpointUrl.host}:${DEFAULT_SSH_PORT}/${repository}`,
+  );
+  if (!sshUrl) {
+    throw new Error(CONFIG_GIT_URL_UNAVAILABLE);
+  }
+
+  const url = pickUrlFromGitUrl(gitUrl, sshUrl, httpUrl);
  logger.trace(
    { url: url.toString() },
    'using URL based on configured endpoint',
  );


Coverage is now failing because of the change I asked (to use parseUrl). Sorry about that.

https://app.codecov.io/gh/renovatebot/renovate/pull/42672?dropdown=coverage&src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=checks&utm_campaign=pr+comments&utm_term=renovatebot#598202c3fbcb3052e676a66671afb2ec-R71

Feel free to change it back to new URL() for now, then let's see what the maintainers think.

Feel free to change it back to new URL() for now, then let's see what the maintainers think.

Thanks, I think that's the pragmatic option. I rewrote the method to allow testing the coverage and it looked dreadful!

Addresses feedback left in review: - Reverts SSH URL creation to ensure coverage target

spmiller · 2026-04-17T05:56:37Z

@spmiller, you only need to make these changes:

Okay, I've made those changes and addressed your other review comments. Thanks for your help so far!

viceice · 2026-04-17T15:19:24Z

+    case 'ssh':
+      return sshUrl.toString();
+    case 'endpoint':
+      return httpUrl.toString();


Suggested change

return httpUrl.toString();

let fall through when same

viceice · 2026-04-17T15:21:14Z

-  url.password = opts.password;
-  url.pathname = joinUrlParts(
-    url.pathname,
+  const httpUrl = clone(endpointUrl);


why cloning? the endpointUrl is only used in this function, so use it here again?

better do the switch case here and don't compute multiple urls to later throw the other away. only compute ssh when gitUrl=ssh, use current otherwise. will make the code much simpler

spmiller and others added 2 commits April 15, 2026 17:43

feat: Gerrit supports gitUrl

bb187fa

This change adds support for the gitUrl parameter to the gerrit platform. It queries the gerrit server to check what download options are available. If ssh is selected but not available, it will throw an error.

Merge branch 'renovatebot:main' into feat-gerrit-gitUrl

fe82e72

github-actions bot requested a review from viceice April 15, 2026 23:37

feat: Gerrit supports gitUrl

4affe89

This removes support for querying the supported download schemes and instead hard-codes the default ssh port.

spmiller changed the title ~~Add gitUrl support to Gerrit platform~~ feat(gerrit): Add gitUrl support Apr 16, 2026

felipecrs suggested changes Apr 16, 2026

View reviewed changes

fix: Review feedback

55c482f

Addresses feedback left in review: - constants for ports - better SSH url creation - more consistent util method usage

felipecrs approved these changes Apr 17, 2026

View reviewed changes

felipecrs reviewed Apr 17, 2026

View reviewed changes

fix: Review feedback

ee3a7d0

Addresses feedback left in review: - Reverts SSH URL creation to ensure coverage target

viceice reviewed Apr 17, 2026

View reviewed changes

Conversation

spmiller commented Apr 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Context

AI assistance disclosure

Documentation (please check one with an [x])

How I've tested my work (please select one)

Uh oh!

felipecrs left a comment

Choose a reason for hiding this comment

Uh oh!

felipecrs Apr 16, 2026

Choose a reason for hiding this comment

Uh oh!

felipecrs Apr 16, 2026

Choose a reason for hiding this comment

Uh oh!

felipecrs Apr 16, 2026

Choose a reason for hiding this comment

Uh oh!

felipecrs commented Apr 16, 2026

Uh oh!

spmiller commented Apr 17, 2026

Uh oh!

marquisesenior383-ctrl commented Apr 17, 2026 via email

Uh oh!

felipecrs commented Apr 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

felipecrs left a comment

Choose a reason for hiding this comment

Uh oh!

felipecrs Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

spmiller Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

spmiller commented Apr 17, 2026

Uh oh!

viceice Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

viceice Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

spmiller commented Apr 15, 2026 •

edited

Loading

felipecrs commented Apr 17, 2026 •

edited

Loading