Backend: More user-friendly error messages for CI includes
Release notes
Problem to solve
We don't provide clear error messages to help developers troubleshoot problems with CI includes. See the proposal section with the details of the errors to improve.
This issue originated in this discussion
Proposal
Problem | Current error screenshot | Proposed new error text |
---|---|---|
We have these include types: local , file , remote , and template . All of them have their own structure and syntax. Your "include" does not match any of our include types. |
![]() |
abc is not a valid subkey for include . Valid subkeys are local , file , remote , or template . Learn more. |
When a user includes different types of includes in the same entry (like project and template in this case), we show the same error. |
![]() |
Each include must use only one of local , file , remote , or template . Learn more. |
Intended users
Feature Usage Metrics
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.
Edited by Nadia Sotnikova