Renaming to scoped priority and severity labels on 2020-08-27 10:00 UTC
What we're doing
We're renaming:
- ~P1 to priority1
- ~P2 to priority2
- ~P3 to priority3
- ~P4 to priority4
- ~S1 to severity1
- ~S2 to severity2
- ~S3 to severity3
- ~S4 to severity4
The plan is detailed at: gitlab-org/quality/triage-ops#330 (closed)
When we're doing it
On 2020-08-27 10:00 UTC.
Why we're doing it
Because it doesn't make sense to have multiple priority and severity labels, and renaming them to scoped labels can prevent this from happening, because whenever one label under the scoped is added, all the other labels with the same scope will be removed automatically.
Some examples:
- When we add
priority::1
to issues havingpriority::2
,priority::2
would be removed automatically - When we add
priority::2
to issues havingpriority::3
andpriority::4
, bothpriority::3
andpriority::4
would be removed automatically - It is not possible to add
priority::2
andpriority::3
at the same time
What is the impact for this renaming
- All of ~P1 ~P2 ~P3 ~P4 ~S1 ~S2 ~S3 ~S4 will no longer exist. We should update ALL the reference to be using the new name with the scopes. All the merge requests prepared so far can be found at gitlab-org/quality/triage-ops#330 (closed) We might miss something, and we can update it before or after the renaming
- Existing issues or merge requests having multiple priority or severity labels:
- We have a test at issue-reproduce/rename-to-scoped-label#1
- Renaming will not change any attached labels. This means issues or merge requests will keep the same priority or severity labels, even when they happen to share the same scope.
- Manually changing any unrelated labels will not touch the existing co-existed priority or severity labels.
- Manually changing the priority/severity label will then remove any other labels under the same scoped.
- Given above, it means there should have no impact for the existing issues or merge requests beside the name of the labels will change, only when one tries to change it manually.
Current issues or merge requests having multiple priority or severity labels
- Issues having both ~P1 and ~P2: (1 open 2 closed as for now) https://gitlab.com/groups/gitlab-org/-/issues?label_name[]=P1&label_name[]=P2
- Issues having both ~P2 and ~P3: (10 closed) https://gitlab.com/groups/gitlab-org/-/issues?label_name[]=P2&label_name[]=P3
- Issues having both ~P3 and ~P4: (13 open 12 closed) https://gitlab.com/groups/gitlab-org/-/issues?label_name[]=P3&label_name[]=P4
- Issues having both ~S1 and ~S2: (1 closed) https://gitlab.com/groups/gitlab-org/-/issues?label_name[]=S1&label_name[]=S2
- Issues having both ~S2 and ~S3: (7 open 9 closed) https://gitlab.com/groups/gitlab-org/-/issues?label_name[]=S2&label_name[]=S3
- Issues having both ~S3 and ~S4: (15 open 10 closed) https://gitlab.com/groups/gitlab-org/-/issues?label_name[]=S3&label_name[]=S4
- Merge requests having both ~P1 and ~P2: (1 merged 2 closed) https://gitlab.com/groups/gitlab-org/-/merge_requests?label_name[]=P1&label_name[]=P2
- Merge requests having both ~P2 and ~P3: (4 merged) https://gitlab.com/groups/gitlab-org/-/merge_requests?label_name[]=P2&label_name[]=P3
- Merge requests having both ~P3 and ~P4: (1 open 1 merged 1 closed) https://gitlab.com/groups/gitlab-org/-/merge_requests?label_name[]=P3&label_name[]=P4
- Merge requests having both ~S1 and ~S2: (2 merged 1 closed) https://gitlab.com/groups/gitlab-org/-/merge_requests?label_name[]=S1&label_name[]=S2
- Merge requests having both ~S2 and ~S3: (5 merged) https://gitlab.com/groups/gitlab-org/-/merge_requests?label_name[]=S2&label_name[]=S3
- Merge requests having both ~S3 and ~S4: (1 open) https://gitlab.com/groups/gitlab-org/-/merge_requests?label_name[]=S3&label_name[]=S4
This is not the exhaustive list because there are other combinations like having all of 4 priority labels, but above should be the ones which are more likely to happen.
Conclusion
This should be rather harmless but it may break some scripts or documentations here and there, so please update accordingly before or after the renaming, and let us know any questions and feedback in this issue.