schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
config.json
trimsuffix
TrimSuffix removes the suffix from the transformer input value
{"type": "string"}
config.json
replacers
Replacers specifies a list of replacer instruction
{"items": {"properties": {"from": {"type": "string"}, "to": {"type": "string"}}, "additionalProperties": false, "type": "object", "required": ["from", "to"]}, "type": "array"}
config.json
items
Replacer is struct used to feed strings.Replacer
{"properties": {"from": {"type": "string"}, "to": {"type": "string"}}, "additionalProperties": false, "type": "object", "required": ["from", "to"]}
config.json
from
From defines the source value which need to be replaced
{"type": "string"}
config.json
to
To defines the "to what" a "from" value needs to be replaced
{"type": "string"}
config.json
replacer
Replacer specifies what value needs to be changed and how
{"properties": {"from": {"type": "string"}, "to": {"type": "string"}}, "additionalProperties": false, "type": "object", "required": ["from", "to"]}
config.json
from
From defines the source value which need to be replaced
{"type": "string"}
config.json
to
To defines the "to what" a "from" value needs to be replaced
{"type": "string"}
config.json
find
Find searches for a specific value if it exists and return false if it doesn't
{"type": "string"}
config.json
findsubmatch
Find searches for a specific value if it exists then return the value using regular expression
{"properties": {"pattern": {"type": "string"}, "captureindex": {"type": "integer"}}, "additionalProperties": false, "type": "object", "required": ["pattern"]}
config.json
pattern
Pattern defines regular expression to use for retrieving a submatch
{"type": "string"}
config.json
captureindex
CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`.
{"type": "integer"}
config.json
semverinc
SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded.
{"type": "string"}
config.json
spec
"yaml" defines the specification for manipulating "yaml" files.
{"$schema": "http://json-schema.org/draft-04/schema", "properties": {"file": {"type": "string"}, "files": {"items": {"type": "string"}, "type": "array"}, "key": {"type": "string"}, "value": {"type": "string"}, "keyonly": {"type": "boolean"}}, "additionalProperties": false, "type": "object"}
config.json
file
"file" defines the yaml file path to interact with. compatible: * source * condition * target remark: * "file" and "files" are mutually exclusive * scheme "https://", "http://", and "file://" are supported in path for source and condition
{"type": "string"}
config.json
files
"files" defines the list of yaml files path to interact with. compatible: * condition * target remark: * file and files are mutually exclusive * protocols "https://", "http://", and "file://" are supported in file path for source and condition
{"items": {"type": "string"}, "type": "array"}
config.json
key
"key" defines the yaml keypath. compatible: * source * condition * target remark: * key is a simpler version of yamlpath accepts keys. example: * key: $.name * key: $.agent.name * key: $.agents[0].name * key: $.agents[*].name * key: $.'agents.name' remark: field path with key/value is not supported at the moment. some help would be useful on https://github.com/goccy/go-yaml/issues/290
{"type": "string"}
config.json
value
"value" is the value associated with a yaml key. compatible: * source * condition * target default: When used from a condition or a target, the default value is set to linked source output.
{"type": "string"}
config.json
keyonly
"keyonly" allows to only check if a key exist and do not return an error otherwise compatible: * condition default: false
{"type": "boolean"}
config.json
scmid
scmid specifies the scm configuration key associated to the current resource
{"type": "string"}
config.json
dependson
dependson specifies which resources must be executed before the current one
{"items": {"type": "string"}, "type": "array"}
config.json
name
name specifies the resource name
{"type": "string"}
config.json
transformers
transformers defines how the default input value need to be transformed
{"items": {"properties": {"addprefix": {"type": "string"}, "addsuffix": {"type": "string"}, "trimprefix": {"type": "string"}, "trimsuffix": {"type": "string"}, "replacers": {"items": {"properties": {"from": {"type": "string"}, "to": {"type": "string"}}, "additionalProperties": false, "type": "object", "required": ["from", "to"]}, "type": "array"}, "replacer": {"properties": {"from": {"type": "string"}, "to": {"type": "string"}}, "additionalProperties": false, "type": "object", "required": ["from", "to"]}, "find": {"type": "string"}, "findsubmatch": {"properties": {"pattern": {"type": "string"}, "captureindex": {"type": "integer"}}, "additionalProperties": false, "type": "object", "required": ["pattern"]}, "semverinc": {"type": "string"}}, "additionalProperties": false, "type": "object"}, "type": "array"}
config.json
items
Transformer holds a transformer rule
{"properties": {"addprefix": {"type": "string"}, "addsuffix": {"type": "string"}, "trimprefix": {"type": "string"}, "trimsuffix": {"type": "string"}, "replacers": {"items": {"properties": {"from": {"type": "string"}, "to": {"type": "string"}}, "additionalProperties": false, "type": "object", "required": ["from", "to"]}, "type": "array"}, "replacer": {"properties": {"from": {"type": "string"}, "to": {"type": "string"}}, "additionalProperties": false, "type": "object", "required": ["from", "to"]}, "find": {"type": "string"}, "findsubmatch": {"properties": {"pattern": {"type": "string"}, "captureindex": {"type": "integer"}}, "additionalProperties": false, "type": "object", "required": ["pattern"]}, "semverinc": {"type": "string"}}, "additionalProperties": false, "type": "object"}
config.json
addprefix
AddPrefix adds a prefix to the transformer input value
{"type": "string"}
config.json
addsuffix
AddSuffix adds a suffix to the transformer input value
{"type": "string"}
config.json
trimprefix
TrimPrefix removes a prefix to the transformer input value
{"type": "string"}
config.json
trimsuffix
TrimSuffix removes the suffix from the transformer input value
{"type": "string"}
config.json
replacers
Replacers specifies a list of replacer instruction
{"items": {"properties": {"from": {"type": "string"}, "to": {"type": "string"}}, "additionalProperties": false, "type": "object", "required": ["from", "to"]}, "type": "array"}
config.json
items
Replacer is struct used to feed strings.Replacer
{"properties": {"from": {"type": "string"}, "to": {"type": "string"}}, "additionalProperties": false, "type": "object", "required": ["from", "to"]}
config.json
from
From defines the source value which need to be replaced
{"type": "string"}
config.json
to
To defines the "to what" a "from" value needs to be replaced
{"type": "string"}
config.json
replacer
Replacer specifies what value needs to be changed and how
{"properties": {"from": {"type": "string"}, "to": {"type": "string"}}, "additionalProperties": false, "type": "object", "required": ["from", "to"]}
config.json
from
From defines the source value which need to be replaced
{"type": "string"}
config.json
to
To defines the "to what" a "from" value needs to be replaced
{"type": "string"}
config.json
find
Find searches for a specific value if it exists and return false if it doesn't
{"type": "string"}
config.json
findsubmatch
Find searches for a specific value if it exists then return the value using regular expression
{"properties": {"pattern": {"type": "string"}, "captureindex": {"type": "integer"}}, "additionalProperties": false, "type": "object", "required": ["pattern"]}
config.json
pattern
Pattern defines regular expression to use for retrieving a submatch
{"type": "string"}
config.json
captureindex
CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`.
{"type": "integer"}
config.json
semverinc
SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded.
{"type": "string"}
config.json
file
[s][c][t] File specifies the csv file
{"type": "string"}
config.json
files
[c][t] Files specifies a list of Json file to manipulate
{"items": {"type": "string"}, "type": "array"}
config.json
key
[s][c][t] Key specifies the csv query
{"type": "string"}
config.json
query
[s][c][t] Query allows to used advanced query. Override the parameter key
{"type": "string"}
config.json
value
[s][c][t] Key specifies the csv value, default to source output
{"type": "string"}
config.json
comma
[s][c][t] Comma specifies the csv separator character, default ","
{"type": "integer"}
config.json
comment
[s][c][t] Comma specifies the csv comment character, default "#"
{"type": "integer"}
config.json
versionfilter
[s]VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest.
{"properties": {"kind": {"type": "string"}, "pattern": {"type": "string"}, "strict": {"type": "boolean"}}, "additionalProperties": false, "type": "object"}
config.json
kind
specifies the version kind such as semver, regex, or latest
{"type": "string"}
config.json
pattern
specifies the version pattern according the version kind
{"type": "string"}
config.json
strict
strict enforce strict versioning rule. Only used for semantic versioning at this time
{"type": "boolean"}
config.json
scmid
scmid specifies the scm configuration key associated to the current resource
{"type": "string"}
config.json
version
Version specifies the minimum updatecli version compatible with the manifest
{"type": "string"}
ci.json
^[.]
Hidden keys.
{"anyOf": [{}, {}]}
ci.json
^[.]
Arbitrary YAML anchor.
{}
ci.json
junit
Path for file(s) that should be parsed as JUnit XML result
{"oneOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}, "minItems": 1}]}
ci.json
junit
Path to a single XML file
{"type": "string"}
ci.json
junit
A list of paths to XML files that will automatically be concatenated into a single file
{"type": "array", "items": {"type": "string"}, "minItems": 1}
ci.json
browser_performance
Path to a single file with browser performance metric report(s).
{"type": "string"}
ci.json
coverage_report
Used to collect coverage reports from the job.
{"type": ["object", "null"], "properties": {"coverage_format": {"enum": ["cobertura"]}, "path": {"type": "string", "minLength": 1}}}
ci.json
coverage_format
Code coverage format used by the test framework.
{"enum": ["cobertura"]}
ci.json
path
Path to the coverage report file that should be parsed.
{"type": "string", "minLength": 1}
ci.json
codequality
Path to file or list of files with code quality report(s) (such as Code Climate).
{}
ci.json
dotenv
Path to file or list of files containing runtime-created variables for this job.
{}
ci.json
lsif
Path to file or list of files containing code intelligence (Language Server Index Format).
{}
ci.json
sast
Path to file or list of files with SAST vulnerabilities report(s).
{}
ci.json
dependency_scanning
Path to file or list of files with Dependency scanning vulnerabilities report(s).
{}
ci.json
container_scanning
Path to file or list of files with Container scanning vulnerabilities report(s).
{}
ci.json
dast
Path to file or list of files with DAST vulnerabilities report(s).
{}
ci.json
license_management
Deprecated in 12.8: Path to file or list of files with license report(s).
{}
ci.json
license_scanning
Path to file or list of files with license report(s).
{}
ci.json
requirements
Path to file or list of files with requirements report(s).
{}
ci.json
secret_detection
Path to file or list of files with secret detection report(s).
{}
ci.json
metrics
Path to file or list of files with custom metrics report(s).
{}
ci.json
terraform
Path to file or list of files with terraform plan(s).
{}
ci.json
include_item
Will infer the method based on the value. E.g. `https://...` strings will be of type `include:remote`, and `/templates/...` or `templates/...` will be of type `include:local`.
{"type": "string", "format": "uri-reference", "pattern": "^(https?://|/?.?-?(?!\\w+://)\\w).+\\.ya?ml$"}
ci.json
local
Relative path from local repository root (`/`) to the `yaml`/`yml` file template. The file must be on the same branch, and does not work across git submodules.
{"type": "string", "format": "uri-reference", "pattern": "\\.ya?ml$"}
ci.json
project
Path to the project, e.g. `group/project`, or `group/sub-group/project` [Learn more](https://docs.gitlab.com/ee/ci/yaml/index.html#includefile).
{"type": "string", "pattern": "(?:\\S/\\S|\\$\\S+)"}
ci.json
ref
Branch/Tag/Commit-hash for the target project.
{"type": "string"}
ci.json
file
Relative path from project root (`/`) to the `yaml`/`yml` file template.
{"type": "string", "pattern": "\\.ya?ml$"}
ci.json
file
List of files by relative path from project root (`/`) to the `yaml`/`yml` file template.
{"type": "array", "items": {"type": "string", "pattern": "\\.ya?ml$"}}
ci.json
template
Use a `.gitlab-ci.yml` template as a base, e.g. `Nodejs.gitlab-ci.yml`.
{"type": "string", "format": "uri-reference", "pattern": "\\.ya?ml$"}
ci.json
component
Local path to component directory or full path to external component directory.
{"type": "string", "format": "uri-reference"}
ci.json
remote
URL to a `yaml`/`yml` template file using HTTP/HTTPS.
{"type": "string", "format": "uri-reference", "pattern": "^https?://.+\\.ya?ml$"}
ci.json
image
Full name of the image that should be used. It should contain the Registry part if needed.
{"type": "string", "minLength": 1}
ci.json
image
Specifies the docker image to use for the job or globally for all jobs. Job configuration takes precedence over global setting. Requires a certain kind of Gitlab runner executor.
{"type": "object", "additionalProperties": false, "properties": {"name": {"type": "string", "minLength": 1}, "entrypoint": {"type": "array", "minItems": 1}, "pull_policy": {"default": "always", "oneOf": [{"type": "string", "enum": ["always", "never", "if-not-present"]}, {"type": "array", "items": {"type": "string", "enum": ["always", "never", "if-not-present"]}, "minItems": 1, "uniqueItems": true}]}}, "required": ["name"]}
ci.json
name
Full name of the image that should be used. It should contain the Registry part if needed.
{"type": "string", "minLength": 1}
ci.json
entrypoint
Command or script that should be executed as the container's entrypoint. It will be translated to Docker's --entrypoint option while creating the container. The syntax is similar to Dockerfile's ENTRYPOINT directive, where each shell token is a separate string in the array.
{"type": "array", "minItems": 1}
ci.json
items
Full name of the image that should be used. It should contain the Registry part if needed.
{"type": "string", "minLength": 1}
ci.json
items
{"type": "object", "additionalProperties": false, "properties": {"name": {"type": "string", "minLength": 1}, "entrypoint": {"type": "array", "minItems": 1, "items": {"type": "string"}}, "pull_policy": {"default": "always", "oneOf": [{"type": "string", "enum": ["always", "never", "if-not-present"]}, {"type": "array", "items": {"type": "string", "enum": ["always", "never", "if-not-present"]}, "minItems": 1, "uniqueItems": true}]}, "command": {"type": "array", "minItems": 1, "items": {"type": "string"}}, "alias": {"type": "string", "minLength": 1}, "variables": {}}, "required": ["name"]}
ci.json
name
Full name of the image that should be used. It should contain the Registry part if needed.
{"type": "string", "minLength": 1}
ci.json
token
Specifies the JWT variable that should be used to authenticate with Hashicorp Vault.
{"type": "string"}
ci.json
paths
List of file paths.
{"type": "array", "items": {"type": "string"}}
ci.json
compare_to
Ref for comparing changes.
{"type": "string"}
ci.json
job
Name of a job that is defined in the pipeline.
{"type": "string", "minLength": 1}
ci.json
artifacts
Download artifacts of the job in needs.
{"type": "boolean"}
ci.json
optional
Whether the job needs to be present in the pipeline to run ahead of the current job.
{"type": "boolean"}
ci.json
allow_failure
Setting this option to true will allow the job to fail while still letting the pipeline pass.
{"type": "boolean", "default": false}
ci.json
allow_failure
Exit code that are not considered failure. The job fails for any other exit code.
{"type": "object", "additionalProperties": false, "required": ["exit_codes"], "properties": {"exit_codes": {"type": "integer"}}}
ci.json
allow_failure
You can list which exit codes are not considered failures. The job fails for any other exit code.
{"type": "object", "additionalProperties": false, "required": ["exit_codes"], "properties": {"exit_codes": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {"type": "integer"}}}}