Rename CI component file `template.yml` to `component.yml`
Context
From internal discussion we agreed on dropping the prefix gitlab-
for the component YAML file, naming it template.yml
This makes the file shorter and concise while still allowing us to infer the component type.
Problem
The term template
is ambiguous for various reasons:
- the template component is used via
include:
which is different thaninclude:template
. So, do we considerinclude:local
,include:remote
, etc. also templates? - the name of the component type should be inclusive of all supported
include:
strategies. What do we call something that can beinclude:
d? This first component type is no different than otherinclude:
s, except where the YAML comes from. - GitLab CI templates today have different forms. They can primarily be used as tutorials (copy-paste and customize) or as extensions (simply include). This adds to the confusion.
Context
The original proposal for components used the type config.yml
to indicate that the content is a generic CI configuration. Being a generic CI configuration we are not treating it any different than other configurations being include
d.
The include
is a method to merge configurations coming from different locations: local
, project/file
, remote
, template
, component
.
Proposal
As config.yml
, on the other hand, can be ambiguous we decided for now to use component.yml
which is in line with the ubiquitous language.