Include "how to contribute" reference when using CI/CD Templates
Release notes
Users of GitLab CI templates can easily add common CI/CD templates for programming languages and deployment types to their project. Now you can easily access a link for the source of that template so you can always be aware of how to contribute any improvements you might make to these standard templates.
Problem to solve
Today templates, both GitLab provided and custom instance provided, are difficult to maintain because users of those templates find it non-intuitive to suggest improvements to them. Once adding a template there is no reference back to the original source of that template.
Intended users
Personas are described at https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/
User experience goal
Provide a reference to the source of the template when adding templates to a .gitlab-ci.yaml file in a project. Ideally this reference would work whether the template is GitLab or custom provided.
Proposal
Derive the source repo and location from the template based on whether it is GitLab or custom provided and insert a comment at the top of any template when inserted that contains a link to that location.
Alternate Proposal
It might be quicker, but less useful, to enforce a CI job where each template has to include a link to how to contribute.
Permissions and Security
Documentation
Availability & Testing
What does success look like, and how can we measure that?
What is the type of buyer?
Is this a cross-stage feature?
Links / references
- Discussed in Product Scaling Agenda