Add /remove-(approve|lgtm|hold) commands

[spiffxp]

/remove hold

Originally posted by @ameukam in kubernetes/k8s.io#1732 (comment)

Made me realize for these labels that while we do have "/foo cancel" as a consistent option, adding support for "/remove-foo" would be more consistent with other labels (priority, sig, lifecycle, area, etc)

/assign @cjwagner @chaodaiG @alvaroaleman
WDYT? Don't want to tag with /help until we agree it's worth doing

/area prow
/sig testing
/priority backlog
/kind cleanup

[spiffxp]

Also FYI @nikhita since you've been looking at /approve lately

[alvaroaleman]

From a technical standpoint there are no reasons not to do this. I personally think that its perfectly fine to have all of "/remove $command", "/un$command", "/$command cancel" and that it has the advantage that ppl will in 99% of the cases intuitively use one of those choices even if they didn't know it existed ahead of time.

But I also seem to remember that someone found it important that there is exactly one way to do these things. Maybe @fejta or @cblecker ?

[fejta]

We started with /lgtm cancel. This did not work with variable commands like /sig <variable>. Thus /remove-sig <variable>. Having everything support /remove-command seems like a reasonable idea, since I see that always makes sense.

I would also support retiring /lgtm cancel etc in favor of the more universal /remove-lgtm pattern, and doing this for all commands.

I see the main goal here to do something consistently and efficiently. Not the end of the world if we consistently support more than one way of invoking a command, but one way is easy to implement and support. It also comes with a clear limiting principle.

Without a limiting principle we are likely to forever find reasonable reasons to support N+1 ways of doing the same thing (like this request, for example). This seems like an inefficient use of time and complexity.

[nikhita]

I'm good with this. 👍

Without a limiting principle we are likely to forever find reasonable reasons to support N+1 ways of doing the same thing (like this request, for example).

For the limiting principle, we could maybe keep it simple to:

• /$command and /remove-$command for all commands.
• /un$command and /$command cancel only for commands where it makes sense

cc @mrbobbytables

[mrbobbytables]

+1 This seems like a pretty reasonable request.

[spiffxp]

I would also support retiring /lgtm cancel etc in favor of the more universal /remove-lgtm pattern, and doing this for all commands.

Maybe someday. For now I feel like too many humans have the other variants baked into muscle-memory. I'd rather respect that, but stop the bot from suggesting them. Stats on usage could inform when to retire, which is a heavier lift for now.

[nikhita]

Don't want to tag with /help until we agree it's worth doing

I see lots of +1s and we've had a slew of new contributors showing up in sig-contribex so I'd like to label this as help-wanted.
/help

If you are a new contributor picking up this issue, here's how you can go about this.

What needs to be done:

If a GitHub comment contains (at least one of) the following text on a new line:

• /remove-approve - the approved label should be removed
• /remove-lgtm - the lgtm label should be removed
• /remove-hold - the do-not-merge/hold label should be removed

Background:

• Each such slash command (like /lgtm, /approve and /hold) are written as plugins in prow. If you look at the code for the lgtm, approve and hold plugins, you'll notice that they follow a similar pattern.
• The list of all such slash commands and their usage can be found at https://prow.k8s.io/command-help
• The commands for each plugin to get triggered on are defined as a regular expressions -

  test-infra/prow/plugins/hold/hold.go

  Line 43 in e9bafa1

  labelCancelRe = regexp.MustCompile(`(?mi)^/(hold\s+cancel|unhold)\s*$`)

• To ensure that the lgtm, approve and hold plugins get triggered on the /remove-* pattern, these regular expressions need to be updated.

Changes to make:

The following steps walkthrough the hold plugin. Make similar changes to the lgtm and approve plugins too.

• Update the regular expression for the command:
  

  test-infra/prow/plugins/hold/hold.go

  Line 43 in e9bafa1

  labelCancelRe = regexp.MustCompile(`(?mi)^/(hold\s+cancel|unhold)\s*$`)

• Update the help text:
  

  test-infra/prow/plugins/hold/hold.go

  Lines 57 to 63 in e9bafa1

  	pluginHelp.AddCommand(pluginhelp.Command{
  	Usage: "/[un]hold [cancel]",
  	Description: "Adds or removes the `" + labels.Hold + "` Label which is used to indicate that the PR should not be automatically merged.",
  	Featured: false,
  	WhoCanUse: "Anyone can use the /hold command to add or remove the '" + labels.Hold + "' Label.",
  	Examples: []string{"/hold", "/hold cancel", "/unhold"},
  	})

• Add tests for the /remove-hold command in https://github.com/kubernetes/test-infra/blob/master/prow/plugins/hold/hold_test.go

If you have any questions or need help, feel free to ping me on the #sig-testing channel on slack.

[k8s-ci-robot]

@nikhita:
This request has been marked as needing help from a contributor.

Please ensure the request meets the requirements listed here.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-help command.

In response to this:

Don't want to tag with /help until we agree it's worth doing

I see lots of +1s and we've had a slew of new contributors showing up in sig-contribex so I'd like to label this as help-wanted.
/help

If you are a new contributor picking up this issue, here's how you can go about this.

What needs to be done:

If a GitHub comment contains (at least one of) the following text on a new line:

• /remove-approve - the approved label should be removed
• /remove-lgtm - the lgtm label should be removed
• /remove-hold - the do-not-merge/hold label should be removed

Background:

• Each such slash command (like /lgtm, /approve and /hold) are written as plugins in prow. If you look at the code for the lgtm, approve and hold plugins, you'll notice that they follow a similar pattern.
• The list of all such slash commands and their usage can be found at https://prow.k8s.io/command-help
• The commands for each plugin to get triggered on are defined as a regular expressions -

  test-infra/prow/plugins/hold/hold.go

  Line 43 in e9bafa1

  labelCancelRe = regexp.MustCompile(`(?mi)^/(hold\s+cancel|unhold)\s*$`)

• To ensure that the lgtm, approve and hold plugins get triggered on the /remove-* pattern, these regular expressions need to be updated.

Changes to make:

The following steps walkthrough the hold plugin. Make similar changes to the lgtm and approve plugins too.

• Update the regular expression for the command:
  

  test-infra/prow/plugins/hold/hold.go

  Line 43 in e9bafa1

  labelCancelRe = regexp.MustCompile(`(?mi)^/(hold\s+cancel|unhold)\s*$`)

• Update the help text:
  

  test-infra/prow/plugins/hold/hold.go

  Lines 57 to 63 in e9bafa1

  	pluginHelp.AddCommand(pluginhelp.Command{
  	Usage: "/[un]hold [cancel]",
  	Description: "Adds or removes the `" + labels.Hold + "` Label which is used to indicate that the PR should not be automatically merged.",
  	Featured: false,
  	WhoCanUse: "Anyone can use the /hold command to add or remove the '" + labels.Hold + "' Label.",
  	Examples: []string{"/hold", "/hold cancel", "/unhold"},
  	})

• Add tests for the /remove-hold command in https://github.com/kubernetes/test-infra/blob/master/prow/plugins/hold/hold_test.go

If you have any questions or need help, feel free to ping me on the #sig-testing channel on slack.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.