Skip to content

Conflicting info in documentation on array types in .spec.inputs of .gitlab-ci.yml

Problem to solve

GitLab CI/CD supports to define .spec.inputs to parameterize a .gitlab-ci.yml, but the documentation has conflicting information if array is an allowed value for .spec.inputs.type or not.

According to CI/CD YAML syntax reference, the allowed values for .spec.inputs.type are:

  • string
  • number
  • boolean

According to Define inputs for configuration added with include, the allowed values for .spec.inputs.type are:

  • array
  • boolean
  • number
  • string

There's also an example for the array type.

When trying to use the array type, GitLab shows an error instead of creating the pipeline, so it appears like the second doc page is wrong (or not yet right):

templates/helm/template.yml: header:spec:inputs:workflowrules input type unknown value: array

Further details

Not sure if array should work or not, so maybe thats a seperate bug as well!

This issue here mainly tries to point out that it's inclear if array should work or not.

I'm using template.yml currently through include: local instead of include: component for testing like this in my component pipeline:

include:
- local: templates/helm/template.yml
  inputs:
    chartDir: test/charts/test-chart

Proposal

I love if the fix would be to include it in CI/CD YAML syntax reference, but if array is not working (yet), it should be removed from Define inputs for configuration added with include for now.

Who can address the issue

Other links/references

Edited by Markus Möslinger