### Release notes <!-- What is the problem and solution you're proposing? This content sets the overall vision for the feature and serves as the release notes that will populate in various places, including the [release post blog](https://about.gitlab.com/releases/categories/releases/) and [Gitlab project releases](https://gitlab.com/gitlab-org/gitlab/-/releases). " --> Previously when you wanted to manually run a pipeline, you needed to know the relevant variables and then enter them on the "Run Pipeline" page. This can be tediously and error-prone if there are numerous key/value pairs to enter. Now the Run Pipeline form wil generate with pre-filled variables for your pipeline based on the variable definitions in your .gitlab-ci.yml file. ### Problem to solve On the Pipelines page ([example](https://gitlab.com/gitlab-org/gitlab/-/pipelines)) when `Run Pipeline` button is selected, the "Run Pipeline" form ([example](https://gitlab.com/gitlab-org/gitlab/-/pipelines/new)) only displays a simplistic form that assumes the user knows every variable name (key) and value that needs to be entered which is problematic for these reasons: - user may not know all the required variable key/values that must be entered - the task is tedious and inefficient when there are many key/values to enter - manual entry is error-prone ### Intended users * [Sasha (Software Developer)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#sasha-software-developer) * [Devon (DevOps Engineer)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#devon-devops-engineer) * Any user that needs to manually trigger pipelines, typically a developer or devops engineer ### User experience goal <!-- What is the single user experience workflow this problem addresses? For example, "The user should be able to use the UI/API/.gitlab-ci.yml with GitLab to <perform a specific task>" https://about.gitlab.com/handbook/engineering/ux/ux-research-training/user-story-mapping/ --> ### Proposal When `Run Pipeline` is selected, the form that allows the user to add variable definitions for running a pipeline or playing a job has pre-filled key/value pairs in the input fields based on variable definitions in the .gitlab-ci.yml file. Example: ```yaml variables: TEST: value: "some value" # this would be the default value description: "This variable makes cakes delicious" # makes this variable appear on the Run Pipeline form ``` NOTE: Only variables with keyword `description` will pre-fill on the Run Pipeline form. This is to differentiate variables to surface as "inputs" vs variables just for passing information between jobs; we want to avoid surfacing **all** variables in a `.gitlab-ci.yml` as "inputs". ### Further details Clarifications and notes from comments: 1. Variables defined in `.gitlab-ci.yml` are pipeline inputs at the root level (not job inputs) 1. "Play manual job" button is not in scope for this issue [Original author's note] We have about 100 developers who are running pipelines or playing jobs daily and need to set 6-10 variables every time they do so. Having to cut and paste each variable name in addition to the value is tedious, and potentially time consuming if they leave out a required variable and have to start another pipeline. ### Permissions and Security <!-- What permissions are required to perform the described actions? Are they consistent with the existing permissions as documented for users, groups, and projects as appropriate? Is the proposed behavior consistent between the UI, API, and other access methods (e.g. email replies)? Consider adding checkboxes and expectations of users with certain levels of membership https://docs.gitlab.com/ee/user/permissions.html * [ ] Add expected impact to members with no access (0) * [ ] Add expected impact to Guest (10) members * [ ] Add expected impact to Reporter (20) members * [ ] Add expected impact to Developer (30) members * [ ] Add expected impact to Maintainer (40) members * [ ] Add expected impact to Owner (50) members --> ### Documentation <!-- See the Feature Change Documentation Workflow https://docs.gitlab.com/ee/development/documentation/workflow.html#for-a-product-change * Add all known Documentation Requirements in this section. See https://docs.gitlab.com/ee/development/documentation/feature-change-workflow.html#documentation-requirements * If this feature requires changing permissions, update the permissions document. See https://docs.gitlab.com/ee/user/permissions.html --> ### Availability & Testing <!-- This section needs to be retained and filled in during the workflow planning breakdown phase of this feature proposal, if not earlier. What risks does this change pose to our availability? How might it affect the quality of the product? What additional test coverage or changes to tests will be needed? Will it require cross-browser testing? Please list the test areas (unit, integration and end-to-end) that needs to be added or updated to ensure that this feature will work as intended. Please use the list below as guidance. * Unit test changes * Integration test changes * End-to-end test change See the test engineering planning process and reach out to your counterpart Software Engineer in Test for assistance: https://about.gitlab.com/handbook/engineering/quality/test-engineering/#test-planning --> * Unit test changes - Yes, there should be unit tests created for any new added logics * Integration test changes - Yes, there should be integration feature specs to see variable render in UI with the expected description. * End-to-end test change - Not required. ### What does success look like, and how can we measure that? <!-- Define both the success metrics and acceptance criteria. Note that success metrics indicate the desired business outcomes, while acceptance criteria indicate when the solution is working correctly. If there is no way to measure success, link to an issue that will implement a way to measure this. --> ### What is the type of buyer? <!-- What is the buyer persona for this feature? See https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/buyer-persona/ In which enterprise tier should this feature go? See https://about.gitlab.com/handbook/product/pricing/#four-tiers --> ### Is this a cross-stage feature? <!-- Communicate if this change will affect multiple Stage Groups or product areas. We recommend always start with the assumption that a feature request will have an impact into another Group. Loop in the most relevant PM and Product Designer from that Group to provide strategic support to help align the Group's broader plan and vision, as well as to avoid UX and technical debt. https://about.gitlab.com/handbook/product/#cross-stage-features --> ### Links / references https://gitlab.com/gitlab-org/gitlab-ce/issues/24935 Specify variables when running a manual job https://gitlab.com/gitlab-org/gitlab-ce/issues/35896 Passing variables to CI/CD pipelines in all possible scenarios https://gitlab.com/gitlab-org/gitlab-ce/issues/48974 Pipeline variables to be shown on the pipeline run page