<!-- The first section "Release notes" is required if you want to have your release post blog MR auto generated. Currently in BETA, details on the \\\*\\\*release post item generator\\\*\\\* can be found in the handbook: https://about.gitlab.com/handbook/marketing/blog/release-posts/#release-post-item-generator and this video: https://www.youtube.com/watch?v=rfn9ebgTwKg. The next four sections: "Problem to solve", "Intended users", "User experience goal", and "Proposal", are strongly recommended in your first draft, while the rest of the sections can be filled out during the problem validation or breakdown phase. However, keep in mind that providing complete and relevant information early helps our product team validate the problem and start working on a solution. --> ### Release notes For many users the same pipeline can be run with different variables or under different conditions creating very different outcomes from a successful pipeline. It has been hard to determine which version of that pipeline ran since there is no indication about the inputs used for that particular run. While tags for source like `scheduled` can help it is still difficult to identify specific pipelines. Now you can set a pipeline name using the keyword `workflow:name` to better identify the pipeline with string, a CI/CD variable or a combination of both. ### Problem to solve This issue was opened from the discussion in https://gitlab.com/gitlab-org/gitlab/-/issues/27133#note_1079444238. A pipeline run can have different jobs, depending on conditions like presence of environment variables. For example, there could be build pipelines, deployment pipelines, QA pipelines, etc. However, the pipeline list and details pages have no way to distinguish different pipelines, other than by manually checking which jobs are present in the pipeline. The ability to add a custom name to pipelines would allow users to distinguish between different pipelines with a human friendly name. The ability to filter pipelines (on the list page) by the name would allow users to view all similar pipelines (for example, all build pipelines or all deploy pipelines). <!-- What problem do we solve? Try to define the who/what/why of the opportunity as a user story. For example, "As a (who), I want (what), so I can (why/value)." --> ### Intended users Users who search for particular pipelines on the pipeline list page, or need to identify a pipeline without needing to know which jobs are part of which pipeline. * [Delaney (Development Team Lead)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#delaney-development-team-lead) * [Sasha (Software Developer)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#sasha-software-developer) * [Priyanka (Platform Engineer)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#priyanka-platform-engineer) * [Sidney (Systems Administrator)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#sidney-systems-administrator) * [Rachel (Release Manager)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#rachel-release-manager) * [Simone (Software Engineer in Test)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#simone-software-engineer-in-test) <!-- Who will use this feature? If known, include any of the following: types of users (e.g. Developer), personas, or specific company roles (e.g. Release Manager). It's okay to write "Unknown" and fill this field in later. Personas are described at https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/ \\\* \\\[Cameron (Compliance Manager)\\\](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#cameron-compliance-manager) \\\* \\\[Parker (Product Manager)\\\](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#parker-product-manager) \\\* \\\[Delaney (Development Team Lead)\\\](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#delaney-development-team-lead) \\\* \\\[Presley (Product Designer)\\\](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#presley-product-designer) \\\* \\\[Sasha (Software Developer)\\\](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#sasha-software-developer) \\\* \\\[Priyanka (Platform Engineer)\\\](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#priyanka-platform-engineer) \\\* \\\[Sidney (Systems Administrator)\\\](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#sidney-systems-administrator) \\\* \\\[Sam (Security Analyst)\\\](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#sam-security-analyst) \\\* \\\[Rachel (Release Manager)\\\](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#rachel-release-manager) \\\* \\\[Alex (Security Operations Engineer)\\\](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#alex-security-operations-engineer) \\\* \\\[Simone (Software Engineer in Test)\\\](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#simone-software-engineer-in-test) \\\* \\\[Allison (Application Ops)\\\](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#allison-application-ops) \\\* \\\[Ingrid (Infrastructure Operator)\\\](https://about.gitlab.com/handbook/product/personas/#ingrid-infrastructure-operator) \\\* \\\[Dakota (Application Development Director)\\\](https://about.gitlab.com/handbook/product/personas/#dakota-application-development-director) \\\* \\\[Dana (Data Analyst)\\\](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#dana-data-analyst) \\\* \\\[Eddie (Content Editor)\\\](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#eddie-content-editor) \\--> ### 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/ --> The user should be able to use the UI to: - Identify a pipeline on the list page without having to look at which jobs were included in the pipeline. - Filter pipelines on the list page so that only pipelines with a given `name` are shown. ### Proposal <!-- How are we going to solve the problem? Try to include the user journey! https://about.gitlab.com/handbook/journeys/#user-journey --> #### Define name attribute Allow an optional `name` attribute in `.gitlab-ci.yml` under `workflow`. This attribute defines the name of a pipeline. If the attribute is not present, the pipeline has no name. ```yaml workflow: name: '$PIPELINE_NAME' rules: - if: $SCHEDULED_BUILD_PIPELINE == 'true' PIPELINE_NAME: 'Scheduled build pipeline' - if: $DEPLOYMENT == 'true' PIPELINE_NAME: 'Deploy $VERSION' ``` In the above example, all pipelines where `$SCHEDULED_BUILD_PIPELINE` is set to true, will have their name set to `Scheduled build pipeline`. All pipelines where `$DEPLOYMENT` is set to `true` will have their name set to something like `Deploy v1.2.3`. The maximum length of the pipeline name will be 255 characters. #### Display name on pipelines list page Display the pipeline name on the list page. - Instead of the commit message? - What if the pipeline doesn't have a name? #### Display name on pipeline details page Display the name on the details page, if the pipeline has a name. #### Filter pipelines by name on list page - Should it be a full text search, similar to how we search through issue list by title or description? - Or should a list of all names be displayed when a user starts to filter by name, similar to how we search issues by label? Design issue for searching/filtering by name on pipelines list page: https://gitlab.com/gitlab-org/gitlab/-/issues/376097. ### Further details / Implementation plan * [x] Add a `title` column to the `ci_pipeline_metadata` table - https://gitlab.com/gitlab-org/gitlab/-/merge_requests/97139. * [x] Allow pipeline `name` to be defined under `workflow` in `.gitlab-ci.yml` - https://gitlab.com/gitlab-org/gitlab/-/merge_requests/97502. * [x] Rename `title` column in database to `name` - https://gitlab.com/gitlab-org/gitlab/-/merge_requests/101196. * [x] Allow variables to be used in `workflow:name` - https://gitlab.com/gitlab-org/gitlab/-/merge_requests/101399. * [x] Display name on pipeline list and details pages - https://gitlab.com/gitlab-org/gitlab/-/merge_requests/101194. * [ ] ~~Allow pipelines to be filtered by name on the list page.~~ (Will be implemented in [#376097](#)) * [x] Add pipeline name to Slack notifications - https://gitlab.com/gitlab-org/gitlab/-/merge_requests/103892. * [ ] ~~Add filtering by name to the public pipelines API.~~ (Will be implemented in https://gitlab.com/gitlab-org/gitlab/-/issues/376097) * [x] Roll out feature flag * [ ] ~~Remove feature flag~~ (Will be removed as part of https://gitlab.com/gitlab-org/gitlab/-/issues/376095) <!-- Include use cases, benefits, goals, or any other details that will help us understand the problem better. --> <!-- ### 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 Please consider performing a threat model for the code changes that are introduced as part of this feature. To get started, refer to our Threat Modeling handbook page https://about.gitlab.com/handbook/security/threat_modeling/#threat-modeling. Don't hesitate to reach out to the Application Security Team (\\\`@gitlab-com/gl-security/appsec\\\`) to discuss any security concerns. \\--> ### 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/workflow.html \\\* 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 Quality Engineering quad planning and test planning processes and reach out to your counterpart Software Engineer in Test for assistance. Quad Planning: https://about.gitlab.com/handbook/engineering/quality/quality-engineering/quad-planning Test Planning: https://about.gitlab.com/handbook/engineering/quality/quality-engineering/test-engineering/#test-planning --> ### Available Tier * Free <!-- This section should be used for setting the appropriate tier that this feature will belong to. Pricing can be found here: https://about.gitlab.com/pricing/ \\\* Free \\\* Premium/Silver \\\* Ultimate/Gold \\--> ### Feature Usage Metrics <!-- How are you going to track usage of this feature? Think about user behavior and their interaction with the product. What indicates someone is getting value from it? Create tracking issue using the Snowplow event tracking template. See https://gitlab.com/gitlab-org/gitlab/-/blob/master/.gitlab/issue_templates/Snowplow%20event%20tracking.md \\--> ### 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. Create tracking issue using the Snowplow event tracking template. See https://gitlab.com/gitlab-org/gitlab/-/blob/master/.gitlab/issue_templates/Snowplow%20event%20tracking.md \\--> <!-- ### 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/#three-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 --> ### What is the competitive advantage or differentiation for this feature? ### Links / references <!-- Label reminders - you should have one of each of the following labels. Use the following resources to find the appropriate labels: \\- https://gitlab.com/gitlab-org/gitlab/-/labels \\- https://about.gitlab.com/handbook/product/categories/features/ \\--> <!-- triage-serverless v3 PLEASE DO NOT REMOVE THIS SECTION --> _This page may contain information related to upcoming products, features and functionality. It is important to note that the information presented is for informational purposes only, so please do not rely on the information for purchasing or planning purposes. Just like with all projects, the items mentioned on the page are subject to change or delay, and the development, release, and timing of any products, features, or functionality remain at the sole discretion of GitLab Inc._ <!-- triage-serverless v3 PLEASE DO NOT REMOVE THIS SECTION -->