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

Closed
bep opened this issue Mar 4, 2019 · 2 comments
Closed

wiki: Improve GerritBot GitHub PR workflow instructions #30564

bep opened this issue Mar 4, 2019 · 2 comments
Labels
NeedsFix The path to resolution is known, but the work has not been done. WaitingForInfo Issue is not actionable because of missing required information, which needs to be provided.
Milestone

Comments

@bep
Copy link
Contributor

bep 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 The path to resolution is known, but the work has not been done. label Mar 9, 2019
@andybons andybons added this to the Unreleased milestone Mar 9, 2019
@thepudds
Copy link
Contributor

thepudds commented Jul 13, 2023

Hi @bep, thanks for the detailed issue here.

FWIW, I updated the wiki in an attempt to incorporate your feedback:
https://github.com/golang/go/wiki/GerritBot/_compare/80daba480c8570e7e09695efbf760da3d157d25d...6b1fd1ae2491c172056f8a7d45900e72b5574e0a

Some minor notes:

  • I also mentioned people should avoid trying to edit the commit message in git, which I think is another point of confusion for people.
  • I mentioned it can take some time before Gerrit is updated after editing the PR title/description in GitHub.
  • I tried to avoid saying "first comment" for the PR description to avoid the small ambiguity around whether the "first comment" is the first thing after the description vs. the description itself.
  • While I was there, I made a couple of other minor edits (like removing the word "Issue" in one spot where it seemed to be an extra word, added the word "GitHub" to another bullet, etc.)

Does that look like something that would have helped you when you were initially reading it, or perhaps it is unclear after my attempt?

@thepudds thepudds added the WaitingForInfo Issue is not actionable because of missing required information, which needs to be provided. label Jul 25, 2023
@gopherbot
Copy link

Timed out in state WaitingForInfo. Closing.

(I am just a bot, though. Please speak up if this is a mistake or you have the requested information.)

@gopherbot gopherbot closed this as not planned Won't fix, can't repro, duplicate, stale Aug 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
NeedsFix The path to resolution is known, but the work has not been done. WaitingForInfo Issue is not actionable because of missing required information, which needs to be provided.
Projects
None yet
Development

No branches or pull requests

4 participants