Add description field to CI/CD Catalog Component (backend)
What does this MR do and why?
Adds an optional description field to the CI/CD Catalog Component spec (backend only). This allows component authors to provide a short description directly in the YAML file, which can then be exposed via the GraphQL API.
Previously, component descriptions had to be documented separately in the README. This change enables inline documentation that can be automatically shown in the Catalog UI.
Note: Frontend changes to display the description in the UI are in a separate follow-up MR for multi-version compatibility.
References
How to set up and validate locally
- Create a new project with a component in
templates/my-component.ymlthat includesspec: description: "Your description" - Add a
README.mdand project description - Go to Settings > General > Visibility, project features, permissions
- Enable CI/CD Catalog project
- Create a release with a semantic version tag (e.g.,
1.0.0) - Query the component via GraphQL and verify the
descriptionfield is returned
MR acceptance checklist
Evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.
Edited by Norman Debald