Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

wiki: Improve GerritBot GitHub PR workflow instructions #30564

Open
bep opened this issue Mar 4, 2019 · 0 comments

Comments

@bep
Copy link
Contributor

commented Mar 4, 2019

@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.

@andybons andybons added the NeedsFix label Mar 9, 2019

@andybons andybons added this to the Unreleased milestone Mar 9, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.