feat: Support for Platform "Gerrit"

[NiasSt90]

Changes

Allow to use Renovate on the Gerrit-Platform.
The Pull-Request-Branch Model of Renovate is translated to Gerrit pre-Submit Model (push to refs/for/).

Context

• Closes Support for Gerrit #4109

Documentation (please check one with an [x])

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

How I've tested my work (please tick 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

[HonkingGoose]

Let's start with some simple changes. The docs need more work after merging my suggestions.

Some sections need more explanations.

[viceice]

the git changes definetly needs to be in seperate PR to be merged before

[Shegox]

I tested this today on our internal Gerrit. First: really awesome stuff and very much looking forward to seeing it in action.
Pretty much worked out-of-the-box in my tests.

Take the below please as small user feedback, not sure if that is in anyway feasible to easily implement or even needed :)

On open question we had, and might just be a documentation thing, is how to enable rebasing.
Currently it still shows the checkbox, and as far as I know you can't tick/edit the comment on Gerrit?

It might be worth to add some documentation if that works and maybe even adjust the PR-content to mention how to do it to have the information self-contained.

Again many thanks for your work on this, looking forward to seeing Gerrit-support.

---

Edit: I found a way to get it to "rebase/retry" the change.
Prefixing the change name (which is the first line of the commit message) with rebase! will force a rebase:

[Shegox]

@NiasSt90 I found that the azure devops platform uses this regex to "massage" the markdown and remove what is not needed. Maybe we can do something similar for removing the rebase checkbox and replace it with "Prefix the commit message with rebase! to force a rebase/retry." statement.

renovate/lib/modules/platform/azure/index.ts

Lines 741 to 750 in af3b203

	export function massageMarkdown(input: string): string {
	// Remove any HTML we use
	return smartTruncate(input, 4000)
	.replace(
	'you tick the rebase/retry checkbox',
	'rename PR to start with "rebase!"'
	)
	.replace(regEx(`\n---\n\n.*?<!-- rebase-check -->.*?\n`), '')
	.replace(regEx(/<!--renovate-(?:debug|config-hash):.*?-->/g), '');
	}

[NiasSt90]

@NiasSt90 I found that the azure devops platform uses this regex to "massage" the markdown and remove what is not needed. Maybe we can do something similar for removing the rebase checkbox and replace it with "Prefix the commit message with rebase! to force a rebase/retry." statement.

renovate/lib/modules/platform/azure/index.ts

Lines 741 to 750 in af3b203

	export function massageMarkdown(input: string): string {
	// Remove any HTML we use
	return smartTruncate(input, 4000)
	.replace(
	'you tick the rebase/retry checkbox',
	'rename PR to start with "rebase!"'
	)
	.replace(regEx(`\n---\n\n.*?<!-- rebase-check -->.*?\n`), '')
	.replace(regEx(/<!--renovate-(?:debug|config-hash):.*?-->/g), '');
	}

I've seen this.
But it feels more like a hack than a good solution. But as a last resort this could be used.

To your other "rebase.." question/answer:

if you can edit the commit-msg from the Gerrit-ui why you don't click on the rebase button to enforce a rebase?

How your "rebaseWhen" configuration looks like during your Gerrit-Tests?

[Shegox]

To your other "rebase.." question/answer:
if you can edit the commit-msg from the Gerrit-ui why you don't click on the rebase button to enforce a rebase?
How your "rebaseWhen" configuration looks like during your Gerrit-Tests?

For pure "git native" rebase the UI thing is sufficient. What I normally use the retry/rebase checkbox for is to actually retry a change. E.g. to explicitly tell Renovate, please recreate this change with the latest information now. This might be different from just a rebase.

This might be necessary if Renovate failed during the creation with an error like below (that explicit message is from GitHub, but the same can happen on Gerrit as well):

Anyway I think the current setup with the commit message fully satisfies this and it is probably just about documenting it.

[NiasSt90]

To your other "rebase.." question/answer:
if you can edit the commit-msg from the Gerrit-ui why you don't click on the rebase button to enforce a rebase?
How your "rebaseWhen" configuration looks like during your Gerrit-Tests?

For pure "git native" rebase the UI thing is sufficient. What I normally use the retry/rebase checkbox for is to actually retry a change. E.g. to explicitly tell Renovate, please recreate this change with the latest information now. This might be different from just a rebase.

This might be necessary if Renovate failed during the creation with an error like below (that explicit message is from GitHub, but the same can happen on Gerrit as well):

okay, rebuilding the complete change from current baseBranch is the same what is actually done with rebaseWhen=auto and Gerrit.getRepoForceRebase=true.
Therefore i'm wondering why a manual rebase/rebuild is needed.

See here for some details about the current default behavior, the comment was gone to the wrong conversation.

Anyway I think the current setup with the commit message fully satisfies this and it is probably just about documenting it.

okay, the commit-msg (prTitle) was checked independent of the rebaseWhen configuration.

[rvarun11]

Any update on this getting merged anytime soon?

[viceice]

• Blocked by feat: Move some Git commands behind a PlatformScm interface #19327

[NiasSt90]

For testing purpose i've pushed the current status (based on #19065) to this branch.

Improvements:

• no special configuration needed anymore (neither gitNoVerify nor platformCommit)
• better markdown handling (some replacements specific to Gerrit: PR -> Change-Request, ...)

[NiasSt90]

I've updated this branch to the latest version of #19065.

We are coming closer to a final version ;)

[sselberg]

Although we patched it to support Gerrit 2.14 (which we will consider to upstream if we can make it in a clean way).

2.14 has been EOL for > 4 years, I hope that there aren't that many installations of 2.14 anymore.

If you are having trouble upgrading I know that Luca and company over at GerritForge have helped a lot of Gerrit users upgrade to latest.

[rarkins]

@viceice please approve when ready

[HonkingGoose]

I'm happy with the docs.

[rarkins]

@NiasSt90 should be no need to merge from main unless there's a conflict now

[valodzka]

I'm not sure how many gerrit users beyond me have tested this Pr, but I'm sure this Pr can be go to production.

To add +1 datapoint, I tested it with my company gerrit setup (last 3.9.1 version) and can confirm that PR works well.

[renovate-release]

🎉 This PR is included in version 37.112.0 🎉

The release is available on:

• GitHub release
• 37.112.0

Your semantic-release bot 📦🚀

[elupus]

What happened to the docs? https://docs.renovatebot.com/modules/platform/gerrit/ is empty?

[valodzka]

What happened to the docs? https://docs.renovatebot.com/modules/platform/gerrit/ is empty?

I am not familiar with renovate docs structure, but my guess file index.md should be called readme.md.

[MindTooth]

I've created a pull request for the fix: #26479