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

gerrit: improve revert commit message template, if possible #30530

Open
dmitshur opened this issue Mar 2, 2019 · 2 comments

Comments

@dmitshur
Copy link
Member

commented Mar 2, 2019

When using Gerrit UI to create a revert of a CL, it populates the commit message with the following template:

Revert "{{.OriginalTitle}}"

This reverts commit {{.CommitHash}}.

Reason for revert: <INSERT REASONING HERE>

For example:

image

In most contexts of the Go project, we refer to changes by the CL number or a shortlink of the form golang.org/cl/nnn. This has some advantages compared to using the commit hash:

  • shorter and less visual noise
  • CL page contains code review discussion, in addition to the change; commit requires one extra click to get to discussion

If possible, we should consider changing the template to be:

Revert "{{.OriginalTitle}}"

This reverts https://golang.org/cl/{{.OriginalCL}}.

Reason for revert: <INSERT REASONING HERE>

Or perhaps the This reverts CL {{.OriginalCL}}. form.

Revert CLs are generally created in situations that involve more time pressure and stress compared to normal CLs, so it's less reliable for us to depend on people to remember to do this manually, or to reference documentation like at https://golang.org/wiki/CommitMessage. It's better to adjust the template.

Implementation

I'm not very familiar with the configurability of our Gerrit instance and whether this is possible. /cc @andybons @bradfitz From looking at its source at https://gerrit.googlesource.com/gerrit/+/v2.16.6/polygerrit-ui/app/elements/change/gr-confirm-revert-dialog/gr-confirm-revert-dialog.js#50, it may be the case that this is not a configurable Gerrit feature, and so this may be blocked on a feature request for Gerrit.

This issue is to investigate whether this is possible, and whether we agree it's a good idea. /cc @ianlancetaylor

@dmitshur

This comment has been minimized.

Copy link
Member Author

commented Mar 2, 2019

As an idea to consider, if we can't easily control the template Gerrit UI uses, another approach could be to use our own infrastructure (maintner/gopherbot/gerritbot) to detect when a revert CL with that template is created, and have it automatically update the commit message to our preferred template.

However, this approach may involve significantly more work, and may not be reliable or have unintended side-effects.

@mvdan

This comment has been minimized.

Copy link
Member

commented Sep 2, 2019

I was about to file this exact same issue. I've created three revert CLs in the past week, and I'm getting tired of having to do this bit of extra work manually :)

@dmitshur dmitshur added the help wanted label Sep 2, 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.