Show multiple lines of text in variable description when running a pipeline manually
Everyone can contribute. Help move this issue forward while earning points, leveling up and collecting rewards.
Release notes
N/A
Problem to solve
In current version of Gitlab you can add a description to a global variable specified in .gitlab-ci.yml. For example:
variables:
P_PARAM:
description: "This is the description of P_PARAM"
value: "This is the default value of P_PARAM"
...Doing this, when you run the pipeline manually (clicking on Pipelines / Run pipeline button), Gitlab shows a form presents you a form where each global variable declared as this is show with a one line description. For example, if I specify
variables:
P_PARAM:
description: |
This is the description of P_PARAM
this is the second line of description
and this is the third line of description
value: "This is the default value of P_PARAM"
...Gitlab shows in the form:
This is the description of P_PARAM this is the second line of description and this is the third line of descriptionIntended users
Gitlab pipeline users ad developers
User experience goal
See proposal
Proposal
As a Gitlab user, in the form shown when a pipeline is run manually (Pipelines / Run pipeline), I want to see the same lines as specified in the YAL file.
So, from my previous example, I want the form show thee lines instead of one:
This is the description of P_PARAM
this is the second line of description
and this is the third line of descriptionFurther details
N/A
Permissions and Security
N/A
Documentation
N/A
Availability & Testing
N/A
Available Tier
N/A
Feature Usage Metrics
N/A
What does success look like, and how can we measure that?
Success: if the YAML defines a multiline variable description, the form must show same lines
What is the type of buyer?
users and pipeline developers
Is this a cross-stage feature?
N/A
What is the competitive advantage or differentiation for this feature?
Pipeline paramemters could be explained more clear to the pileine user.
Links / references
N/A