Renovate marks nearly all PRs as "edited" with platformCommit: true

[marcus-griep-simplisafe]

What would you like help with?

I think I found a bug

How are you running Renovate?

Self-hosted

If you're self-hosting Renovate, tell us which platform (GitHub, GitLab, etc) and which version of Renovate.

GitHub, Renovate EE 7.1.0, Renovate 37.340.10

Please tell us more about your question or problem

When enabling the platformCommit option, Renovate will mark PRs as "edited" on the next hourly run-though, even if there has only been one commit, and that commit is by the Renovate bot itself. I've woken up to a bunch of Renovate PRs opened for automerging, but left like that because Renovate decided that they were edited when it next came by.

I believe that this is a result of the fact that the non-platform commit will update the git cache of branch modifications after completing its push, but no such operation is completed when using the platform commit.

renovate/lib/util/git/index.ts

Lines 1149 to 1155 in 99ba857

	if (pushResult) {
	const { branchName } = commitConfig;
	const { commitSha } = commitResult;
	config.branchCommits[branchName] = commitSha;
	config.branchIsModified[branchName] = false;
	return commitSha;
	}

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

Lines 2078 to 2086 in 99ba857

	const pushResult = await pushFiles(config, commitResult);
	if (!pushResult) {
	return null;
	}
	// Replace locally created branch with the remotely created one
	// and return the remote commit SHA
	await git.resetToCommit(commitResult.parentCommitSha);
	const commitSha = await git.fetchBranch(branchName);
	return commitSha;

The cache inside the git module is explicitly trusted when determining whether the commit found is the commit expected, so when it detects the platform commit, it finds it different from the expectation in the git cache, thus marking the commit as edited, and no longer processing the branch.

renovate/lib/util/git/index.ts

Lines 631 to 639 in 99ba857

	export async function isBranchModified(branchName: string): Promise<boolean> {
	if (!branchExists(branchName)) {
	logger.debug('branch.isModified(): no cache');
	return false;
	}
	// First check local config
	if (config.branchIsModified[branchName] !== undefined) {
	return config.branchIsModified[branchName];
	}

I have also tried disabling the repository cache on the workers in case this was the reason for the issue, but from that logic above, the repository cache is a secondary check, meaning that the cache inside the git module will have already returned a decision that the branch was modified. After disabling the platformCommit option, the issues with Edited/Blocked PRs seems to have stopped.

Logs (if relevant)

No response

[github-actions[bot]]

Hi there,

This issue or discussion is missing some logs, making it difficult or impossible to help you. Depending on which situation applies follow one, some or all of these instructions.

No logs at all

If you haven't posted any log yet, we need you to find and copy/paste the log into the issue template.

Finding logs on hosted app

Select me to read instructions

If you use the Mend Renovate app (GitHub):

1. Log in to the Mend Developer Portal
2. Navigate to the correct organization and repository
3. Locate the appropriate log (it may not always be the latest one)
4. Copy/paste the log contents
5. Follow the steps in the formatting your logs section

Finding logs when self-hosting

Select me to read instructions

Read the Renovate docs, troubleshooting, self-hosted to learn how to find the logs.

Insufficient logs

Select me to read instructions

If you already gave us a log, and the Renovate team said it's not enough, then follow the instructions from the No logs at all section.

Formatting your logs

Select me to read instructions

Please put your logs in a <details> and <summary> element like this:

<details><summary>Select me to see logs</summary>

```
Copy/paste your logs here, between the starting and ending backticks
```

</details>

If you feel the logs are too large to paste here, please use a service like GitHub Gist and paste the link here.

Good luck,

The Renovate team

[rarkins]

The renovate app uses platform commit and doesn't have this problem. Not has anyone else reported it. Most likely you have a config problem, such as configuring wrong gitAuthor

[marcus-griep-simplisafe]

TL;DR: I think that the issue comes from how Renovate-EE Server (and potentially CE, but not checked) sets the gitAuthor before invoking the Renovate CLI.

We do not have any explicit configuration that modifies the gitAuthor. The default gitAuthor is inferred from our GitHub App integration, as I understand it.

Here's an example of one such platform commit, which was listed as verified in the GitHub UI:

Author:     my-renovate[bot] <REDACTED+my-renovate[bot]@users.noreply.github.com>
AuthorDate: Tue May 14 05:00:41 2024 +0000
Commit:     GitHub <noreply@github.com>
CommitDate: Tue May 14 05:00:41 2024 +0000

It looks like this is inferred by this section of code.

When Renovate came around at 06:00 UTC, it added the edited/blocked comment. I did find this log:

{
    "name": "renovate",
    "hostname": "mend-renovate-worker-75c889ff98-vbkvc",
    "pid": 13437,
    "level": 20,
    "logContext": "20c6806a35",
    "repository": "org/repo"
    "branch": "renovate/nginxinc-nginx-unprivileged-alpine-slim",
    "branchName": "renovate/nginxinc-nginx-unprivileged-alpine-slim",
    "lastAuthor": "REDACTED+my-renovate[bot]@users.noreply.github.com",
    "gitAuthorEmail": "my-renovate[bot]@users.noreply.github.com",
    "msg": "branch.isModified() = true",
    "time": "2024-05-14T06:00:33.092Z",
    "v": 0
}

When platform commit is off, I receive the following as the header for a Renovate commit.

Author:     my-renovate[bot] <my-renovate[bot]@users.noreply.github.com>
AuthorDate: Wed May 1 19:22:25 2024 +0000
Commit:     my-renovate[bot] <my-renovate[bot]@users.noreply.github.com>
CommitDate: Wed May 1 19:22:25 2024 +0000

Looking in the logs, I see this entry that indicates the gitAuthor was explicitly configured, which is surprising because, as I mentioned, we don't explicitly configure a gitAuthor.

{
    "name": "renovate",
    "hostname": "mend-renovate-worker-75c889ff98-vbkvc",
    "pid": 13437,
    "level": 20,
    "logContext": "20c6806a35",
    "msg": "Using configured gitAuthor (my-renovate[bot]@users.noreply.github.com)",
    "time": "2024-05-14T06:00:02.675Z",
    "v": 0
}

What I discovered was this piece of code in Renovate EE Server (minified source):

return {
  id: r.id,
  name: n,
  botName: `${n}[bot]`,
  endpoint: e,
  gitAuthor: `${n}[bot]@users.noreply.${a}`,
  platform: "github",
};

That ${n} without the app ID is probably the root of the issue here, as it is then providing that as implicit configuration when sending a job to a Renovate EE worker.

Thus, you are right. Something is setting up a gitAuthor that is causing the mismatch, in this case Renovate EE Server. This probably needs to be fixed in Renovate-EE to provide the correct, full, email for the GitHub App, or, based on this conditional, not setting gitAuthor may be best, as then the Renovate CLI would correctly infer the appropriate gitAuthor at that time.

As a workaround, I can add REDACTED+my-renovate[bot]@users.noreply.github.com into gitIgnoredAuthors, and I likely will need to add both in order to transition back to platformCommits regardless.

[rarkins]

My recollection is that platformCommit adds the app ID to the git author, so that's why renovate EE provisions adds it. I'm a bit confused about when/why that ID is being dropped at times