Add tooltip to improve clarity of "detached" label/state in the merge request pipeline
Problem to solve
The "detached" label on pipelines is not clear and needs a rethink so that the UX is clear. The detached state means that it was a merge request pipeline, so ran in the context of the merge request, but did not run "attached", which means against the merge request result. The label serves to drive awareness of this status, but is mainly creating confusion now.
Intended users
This is a broad set of users who interact with pipelines. They can see the status and be confused.
Further details
Originally implemented in https://gitlab.com/gitlab-org/gitlab-ee/issues/7380 and documented at https://docs.gitlab.com/ee/ci/merge_request_pipelines/#pipelines-for-merged-results-premium.
UX Proposal
For the first iteration we will simply add tooltip to better explain what this Detached state is.
Detached label is meant for showing users a warning message that their MR state is not mergeable thus their code is tested against the source branch instead of merged results. Ideally, their MR should be tested against merged results because it provides more accurate results.
A more extensive solution will be proposed after UX research is conducted. Here is the UX research issue to clarify our questions related to this functionality https://gitlab.com/gitlab-org/ux-research/issues/244
What we will update
Current tooltip |
Updated tooltip |
---|---|
This pipeline is run on the source branch | The code of a detached pipeline is tested against the source branch instead of merged results |
Where it needs to be changed
-
All tooltips displayed on hover of
detached
labels, that appear on Pipelines page (all tabs, whenever applicable). -
Tooltip displayed on hover of
detached
label, that appear on Pipelines detail view. -
All tooltips displayed on hover of
detached
labels, that appear on Pipelines tab in the merge request widget.
Permissions and Security
N/A
Documentation
Does not require a documentation update.
Testing
There is possibility of UX testing to confirm this is more clear. Follow up issue scheduled here https://gitlab.com/gitlab-org/ux-research/issues/244
What does success look like, and how can we measure that?
People are able to understand the context of a detached
pipeline in the application interface.
Links / references
Slack channel #f_detached_pipeline