Skip to content

cici config file format

This page is a reference for cici config file syntax. For a tutorial, see the Getting started section of the site

File

Top-level cici configuration object.

Field Default Description
name*
string

Name of the component. All lower-case, hyphen-separated expected.

crosstool-ng
repo_url*
string

Web URL for the source repository for this component.

https://gitlab.com/saferatday0/library/cxx
gitlab_project_path*
string
(deprecated)

Full project path for this component on Gitlab.

saferatday0/library/python
brief*
string

Short, one-line description of a component. Supports Markdown.
description*
string

Multi-line description of a component. Supports Markdown.
groups
Group array		 []

List of groups to declare.
targets
Target array		 []

List of pipeline targets to declare.
variables
object		 {}

Dictionary of input variables to declare.

Container

Container runtime configuration for this target.

Field Default Description
image*
string

Container image to use for this target.
entrypoint
string array		 []

Container entrypoint to use for this target.

GitLabIncludeTarget

Custom name for a GitLab CI/CD Include target.

Field Default Description
name*
string

Name of GitLab include target.

Group

A logical set of pipeline targets.

Field Default Description
name*
string

Name of this group.
brief*
string

Short, one-line description of this group. Supports Markdown.
description*
string

Multi-line, long-form description of this group. Supports Markdown.

PreCommitHookTarget

Custom name for a pre-commit hook target.

Field Default Description
name*
string

Name of pre-commit hook.

Target

Defines a target pipeline to be generated.

Field Default Description
name*
string

Name of a pipeline target. All lower-case, hyphen-separated (kebab-case) is expected.
brief*
string

Short, one-line description of a pipeline target. Supports Markdown.
description*
string

Multi-line, long-form description of a pipeline target. Supports Markdown.
groups
string array		 []

Denote a logical grouping of pipeline targets.
tags
string array		 []

Tags for curating jobs according to their purpose.
container
Container		 None

Container runtime configuration for this pipeline target.
precommit_hook
PreCommitHookTarget
(deprecated)		 None

Configuration for the pre-commit hook.
gitlab_include
GitLabIncludeTarget
(deprecated)		 None

Configuration for the GitLab CI/CD include.

Variable

Defines a variable to be consumed by the target.

Field Default Description
name*
string

Name of a variable.

PYTHON_VERSION
brief*
string

Short, one-line description of a variable. Supports Markdown.
default*
string

Default value for this variable.
description*
string

Multi-line, long-form description of this variable. Support Markdown.
required
boolean		 False

Is this variable required to use the pipeline?
examples
VariableExample array		 []

List of examples to demonstrate this variable.

VariableExample

An example of how the provided variable should be used.

Field Default Description
value*
string

Example value for the variable.
brief*
string

Short, one-line description of a variable example.