Add ability to use config name as summary

Review Request #10105 — Created July 27, 2018 and updated

jcannon
ReviewBot
master
4714
reviewbot

Add ability to use config name as summary.

If more than one reviewbot configuration using the same tool has its conditions satisfied for a review request, multiple status updates will exist on the review request using the same summary. This can be confusing for users, and makes debugging issues more difficult (which configuration caused the issue?).

This change adds an additional toggle underneath each configuration's "TOOL OPTIONS" to specify if the status update should use the configuration name as the summary (instead of the tool name).
An example of client usage which would motivate using the configuration name might be 2 different buildbot configurations that use different builders or branches.

Created a few configurations, some of which used config name and some of which didn't. Noticed config name was used for the ones where the option was checked.

  • 1
  • 0
  • 1
  • 0
  • 2
Description From Last Updated
I've been thinking about this, and I'm not sure I like the particular UI here. It requires the user to ... david david
jcannon
chipx86
  1. 
      
  2. Can you elaborate on the purpose of the change in the description? It's not entirely clear from reading it what this change is providing.

    We have examples of how we like to see these structured (along with line length limits) here:

    https://www.notion.so/Writing-Good-Change-Descriptions-10529e7c207743fa8ca90153d4b21fea

  3. 
      
jcannon
Review request changed

Change Summary:

Updated description

Description:

   

Add ability to use config name as summary.

   
~  

This is useful if there exists several configurations that use the same tool, and there is a possibility of more than one configuration being used on a review request.

~   I.e. 2 flake8 configs, flake8 (nice) and flake8 (strict).

  ~

If more than one reviewbot configuration using the same tool has its conditions satisfied for a review request, multiple status updates will exist on the review request using the same summary. This can be confusing for users, and makes debugging issues more difficult (which configuration caused the issue?).

  ~
  +

This change adds an additional toggle underneath each configuration's "TOOL OPTIONS" to specify if the status update should use the configuration name as the summary (instead of the tool name).

  + An example of client usage which would motivate using the configuration name might be 2 different buildbot configurations that use different builders or branches.

jcannon
  1. bump

  2. 
      
david
  1. 
      
  2. I've been thinking about this, and I'm not sure I like the particular UI here. It requires the user to think a little too hard.

    Can we instead add a new field for this, separate from the config name? If empty, it would default to the tool name, and if present, use that. This way the config name can continue to be an internal reference for the admins, and if someone chooses to set it they only need to put text in the field.

  3. 
      
Loading...