Skip to content

wiki: Improve GerritBot GitHub PR workflow instructions #30564

Closed as not planned
@bep

Description

@bep

@dmitshur better to track this in it's own issue, than in a random CL review.

I created some noise last night about my first code CL and my struggles with Gerrit -- I spent an hour trying to do a small edit of the commit message, only to see it overwritten by the GerritBot. #24887 talks about this issue.

So, the workaround for me was eventually to edit the first comment in the original GitHub PR.

If you read closely on the wki you may grasp this information in the FAQ (if you understand the difference between a PR and a CL), but I was looking for a reason why my commit message edits in Gerrit didn't stick (some StackOverflow thread suggested I needed to push a commit button). This was what I looked for in the documentation.

I suggest 2 changes to the Wiki page above to make this more in the face:

How does GerritBot determine the final commit message?
It uses the title and description of the PR to construct the commit message for the Gerrit Change.

To something like:

How does GerritBot determine the final commit message?
It uses the title and description (first comment) of the GitHub PR to construct the commit message for the Gerrit Change. Also note that any edits to the commit message must be done in the GitHub PR and not on Gerrit.

And in the workflow, add a bullet saying something like this:

Any change of the commit message must be done in the title and description (first comment) of the GitHub PR and not on Gerrit.

Metadata

Metadata

Assignees

No one assigned

    Labels

    FrozenDueToAgeNeedsFixThe path to resolution is known, but the work has not been done.WaitingForInfoIssue is not actionable because of missing required information, which needs to be provided.

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions