schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
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
spec
Spec defines a specification for a "dockerdigest" resource parsed from an updatecli manifest file
{"$schema": "http://json-schema.org/draft-04/schema", "properties": {"architecture": {"type": "string"}, "image": {"type": "string"}, "tag": {"type": "string"}, "digest": {"type": "string"}, "username": {"type": "string"}, "password": {"type": "string"}, "token": {"type": "string"}, "hidetag": {"type": "boolean"}}, "additionalProperties": false, "type": "object"}
config.json
architecture
architecture specifies the container image architecture such as `amd64` compatible: * source * condition default: amd64
{"type": "string"}
config.json
image
image specifies the container image such as `updatecli/updatecli` compatible: * source * condition
{"type": "string"}
config.json
tag
tag specifies the container image tag such as `latest` compatible: * source * condition
{"type": "string"}
config.json
digest
digest specifies the container image digest such as `sha256:ce782db15ab5491c6c6178da8431b3db66988ccd11512034946a9667846952a6` compatible: * condition default: When used from a condition, the default value is set to the linked source output.
{"type": "string"}
config.json
username
username specifies the container registry username to use for authentication. compatible: * source * condition * target default: by default credentials are fetch from the local environment such as `~/.docker/config.json`. remark: Not compatible with token
{"type": "string"}
config.json
password
password specifies the container registry password to use for authentication. Not compatible with token compatible: * source * condition * target default: by default credentials are fetch from the local environment such as `~/.docker/config.json`. remark: Not compatible with token
{"type": "string"}
config.json
token
token specifies the container registry token to use for authentication. compatible: * source * condition * target default: by default credentials are fetch from the local environment such as `~/.docker/config.json`. remark: Not compatible with username/password
{"type": "string"}
config.json
hidetag
hideTag specifies if the tag should be hidden from the digest compatible: * source 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
spec
Spec defines settings used to interact with GitLab release
{"$schema": "http://json-schema.org/draft-04/schema", "properties": {"url": {"type": "string"}, "username": {"type": "string"}, "token": {"type": "string"}, "owner": {"type": "string"}, "repository": {"type": "string"}, "versionfilter": {"properties": {"kind": {"type": "string"}, "pattern": {"type": "string"}, "strict": {"type": "boolean"}}, "additionalProperties": false, "type": "object"}, "tag": {"type": "string"}}, "additionalProperties": false, "type": "object", "required": ["url", "owner", "repository"]}
config.json
url
"url" defines the GitLab url to interact with default: url defaults to "gitlab.com"
{"type": "string"}
config.json
username
"username" defines the username used to authenticate with GitLab
{"type": "string"}
config.json
token
"token" defines the credential used to authenticate with GitLab
{"type": "string"}
config.json
owner
[S][C] Owner specifies repository owner
{"type": "string"}
config.json
repository
[S][C] Repository specifies the name of a repository for a specific owner
{"type": "string"}
config.json
versionfilter
[S][C] 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
tag
[S] Tag defines the GitLab tag .
{"type": "string"}
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
spec
Spec defines settings used to interact with Bitbucket release
{"$schema": "http://json-schema.org/draft-04/schema", "properties": {"url": {"type": "string"}, "username": {"type": "string"}, "token": {"type": "string"}, "password": {"type": "string"}, "owner": {"type": "string"}, "repository": {"type": "string"}, "versionfilter": {"properties": {"kind": {"type": "string"}, "pattern": {"type": "string"}, "strict": {"type": "boolean"}}, "additionalProperties": false, "type": "object"}, "tag": {"type": "string"}}, "additionalProperties": false, "type": "object", "required": ["url", "owner", "repository"]}
config.json
url
[S][C][T] URL specifies the default github url in case of Bitbucket enterprise
{"type": "string"}
config.json
username
[S][C][T] Username specifies the username used to authenticate with Bitbucket API
{"type": "string"}
config.json
token
[S][C][T] Token specifies the credential used to authenticate with
{"type": "string"}
config.json
password
[S][C][T] Token specifies the credential used to authenticate with
{"type": "string"}
config.json
owner
[S][C] Owner specifies repository owner
{"type": "string"}
config.json
repository
[S][C] Repository specifies the name of a repository for a specific owner
{"type": "string"}
config.json
versionfilter
[S][C] 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
tag
[S] Tag defines the Bitbucket tag .
{"type": "string"}
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"}