Search for environment name in the Environments overview page
Release notes
You can now search the list of environments in the Environments page by name. Previously, there was no search functionality. This sometimes required you to scroll through many pages to find a specific environment and its latest deployment. Please note that this feature is not yet complete, and you can only search for an exact match of the environment name.
Problem to solve
As a user, I want to search for environments in GitLab, so that I can quickly find an environment and its deployments.
Intended users
- Rachel (Release Manager)
- Delaney (Development Team Lead)
- Priyanka (Platform Engineer)
- Anyone who uses the Environments page at an organization that has a lot of environments.
User experience goal
The user should be able to use the search bar in the Environments page to search and see a match with the user's search query.
Proposal
- In the Environments page, user should see a Search box placed below the tabbed navigation.
- The search bar is added only to the Environments overview page with this proposal.
- frontend: Use the search-by-type component.
- See Pajamas guidelines for Search
- If the search return no results, an empty state should be displayed together with a CTA button to create an environment (which takes the user to the Create environment page).
- See Pajamas guidelines for Empty Search results - please follow the UI text from Pajamas.
- The Search box only return results for either Available OR Stopped environments. That means users need to be on a specific tab to search for these type of environments. (known limitation)
- The user can search by typing.
- The keyword needs to match with the exact user's search query so that the result can be displayed. (known limitation)
- The minimum limit on the length of the search is 3 characters
- When the user type into the search box, the system scans both environments and scoped environments.
- When returning the results, the environment folders remain collapsed, even if the matched result is part of a scoped environment. (known limitation)
- When returning scoped environments in the results, the folder structure should be persistent. That means the UI should display the the parent and child structure in the UI, when returning a child (scoped) environment.
- The badge counter in the Tab navigation should updated to match the number of results being displayed.
- The badge counter in the scoped environment folder should updated to match the number of results being displayed.
- Some characters cannot be used in environment names and therefore should not return a result during search. For more information about the environment keywords, see the .gitlab-ci.yml keyword reference.
Further details
Today, when searching for a particular environment on GitLab.com, users have to manually to step through all 56 pages to find the one they're looking for. See https://gitlab.com/gitlab-org/gitlab-ee/environments/
A PoC MR has been done by @vshushlin and @afontaine to add a search bar to environments. See #330865 (closed) and !86115 (closed)
Permissions and Security
-
Add expected impact to members with no access, if the project is public. -
Add expected impact to Guest, if the project is public. -
Add expected impact to Reporter -
Add expected impact to Developer -
Add expected impact to Maintainer -
Add expected impact to Owner
Documentation
Yes, we will need to update the documentation to include information about searching for environments.
Availability & Testing
Available Tier
Feature Usage Metrics
What does success look like, and how can we measure that?
See proposal for acceptance criteria.
What is the type of buyer?
Is this a cross-stage feature?
No.
What is the competitive advantage or differentiation for this feature?
Links / references
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.