Variables File

To not repeat yourself (DRY,) we can define some variables in a var file and use the vars in the config file.

You can specify the path/to/your/variablesFile.yaml in the main config. See the config section for more details.

Default Variables File

No default variables file will be loaded. You must specify which var file to use explicitly in the main config.

Using a Variables File

To use these variables in a config file, use the following syntax:

[[ varNameHere ]]

Example Config File with the Use of Variables

variables.yaml:

gitlabUser: ironcore864
defaultBranch: main
gitlabCIGolangTemplate: https://gitlab.com/ironcore864/go-hello-world/-/raw/main/go.tpl

Example tool file with the variables defined in the above variables.yaml:

tools.yaml:

tools:
- name: gitlabci-generic
  instanceID: default
  options:
    pathWithNamespace: [[ gitlabUser ]]/go-hello-world
    branch: [[ defaultBranch ]]
    templateURL: [[ gitlabCIGolangTemplate ]]
    templateVariables:
      App: hello

DevStream will render the config with the provided var file. After rendering, the config above is equivalent to the following content:

tools:
- name: gitlabci-generic
  instanceID: default
  options:
    pathWithNamespace: ironcore864/go-hello-world
    branch: main
    templateURL: https://gitlab.com/ironcore864/go-hello-world/-/raw/main/go.tpl
    templateVariables:
      App: hello