[SERVER-74759] Update suggested variant names Created: 10/Mar/23  Updated: 19/Jan/24  Resolved: 19/Jan/24

Status: Closed
Project: Core Server
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Bug Priority: Major - P3
Reporter: Jeffrey Zambory Assignee: [DO NOT ASSIGN] Backlog - DevProd Correctness
Resolution: Won't Fix Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Assigned Teams:
Correctness
Operating System: ALL
Participants:

 Description   

It's the convention for all suggested build variants to have "–-suggested" as a suffix on them, similar to how required variants have "–-required".

Some variants are not following this convention currently, causing the BF scorer some issues when scoring BFs and causing some confusion for folks trying to reason about what variants are in what category.

All required and suggested variants should be updated to follow the conventions above. 



 Comments   
Comment by Steven Vannelli [ 20/Mar/23 ]

This ticket is dependent on teams moving away from the -required / -suggested naming to the display name convention (i.e. display_name).

Comment by Alex Neben [ 20/Mar/23 ]

Maybe we should have one painful rename where we drop the -require and -suggested from variant names. Either way I think modifying the supporting infra will be helpful.

Comment by Jeffrey Zambory [ 20/Mar/23 ]

Gotcha - I think if that's the way we want to go we should define that somewhere. I checked the wiki and I'm not sure if we currently have a single source of truth that says what a required and suggested variant are or how to find them. Some places mention the ! or * but more in passing.

Also, this will affect both the BF scorer the TPMs (and we) own and also git-co-evg-base. There's likely others as well I'm not aware of. So, there will likely be some follow up work on this to bring those in line with the new policy. We might need to do a wider announcement just to catch any people that are using the old naming conventions.

Comment by Alex Neben [ 11/Mar/23 ]

The reason they are not updated is the variant display name (* vs ! vs ~, etc…) doesn’t matter for tracking old BFs. We do use the name -suggested or -required etc for tracking purposes so we basically don’t want to change those. So my suggestion is just to leave them as is even though it is misleading

Generated at Thu Feb 08 06:28:27 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.