Provide better error messages for metric reports
Release notes
Problem to solve
Metric reports work as expected only if you have a premium or ultimate license AND if the target branch for the merge request needs to have a baseline metrics report for comparison AND you're in a public project. If you set up a test on a project that does not meet 1 or all of those criteria, the metrics report will just say Metrics reports did not change
, and will not provide further indication of the error or how to solve it.
Here are examples of the scenarios:
- Trying to use a feature which isn't licensed
- If the code is unable to run a comparison with the target branch
- Set up metrics for a public project, change it to private
Intended users
User experience goal
Provide a message that accurately describes the scenario and how to fix it.
Proposal
TBD
Provide empty states that describe accurate messaging and next steps. Examples include:
- Trying to use a feature which isn't licensed should return, say: "upgrade your subscription to use this feature"
- If the code is unable to run a comparison with the target branch, it should provide guidance on how to fix that issue.
Further details
Merge request metrics reports shows "Metrics reports did not change" on private projects pipelines.
The test was done on this repo https://gitlab.com/ian.girouard/metrics-testing
- Let's assume the project is public
- Create a branch, do a change on test.txt
- Push the changes
- Create a merge request
- Metrics report shows metrics changed on one point
- Go to the project settings, set the project to private
- Run the merge request pipeline again
- Metrics report shows metrics did not change
Example project: https://gitlab.com/ian.girouard/metrics-testing , you can fork it to test the private-public settings
Permissions and Security
Documentation
Availability & Testing
Available Tier
Feature Usage Metrics
What does success look like, and how can we measure that?
More metric reports will be set up and work as expected.
What is the type of buyer?
Is this a cross-stage 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.