schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
---|---|---|---|
config.json | success | Success defines the command exit code used by Updatecli to identify no changes are needed. Default to 0 if no exitcode have been specified | {"type": "integer"} |
config.json | failure | Failure defines the command exit code used by Updatecli to identify that something went wrong. Default to 1 if no exitcode have been specified | {"type": "integer"} |
config.json | files | Files specifies the list of file that Updatecli monitors to identify state change | {"items": {"type": "string"}, "type": "array"} |
config.json | shell | Shell specifies which shell interpreter to use. Default to powershell(Windows) and "/bin/sh" (Darwin/Linux) | {"type": "string"} |
config.json | workdir | workdir specifies the working directory path from where to execute the command. It defaults to the current context path (scm or current shell). Updatecli join the current path and the one specified in parameter if the parameter one contains a relative path. | {"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 | "xml" defines the specification for manipulating "xml" files. | {"$schema": "http://json-schema.org/draft-04/schema", "properties": {"file": {"type": "string"}, "path": {"type": "string"}, "value": {"type": "string"}}, "additionalProperties": false, "type": "object"} |
config.json | file | "file" define the xml file path to interact with.
compatible:
* source
* condition
* target
remark:
* scheme "https://", "http://", and "file://" are supported in path for source and condition | {"type": "string"} |
config.json | path | "path" defines the xpath query used for retrieving value from a XML document
compatible:
* source
* condition
* target
example:
* path: "/project/parent/version"
* path: "//breakfast_menu/food[0]/name"
* path: "//book[@category='WEB']/title" | {"type": "string"} |
config.json | value | "value" is the value associated with a xpath query.
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 | 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 a specification for a "dockerimage" resource parsed from an updatecli manifest file | {"$schema": "http://json-schema.org/draft-04/schema", "properties": {"architectures": {"items": {"type": "string"}, "type": "array"}, "architecture": {"type": "string"}, "image": {"type": "string"}, "tag": {"type": "string"}, "username": {"type": "string"}, "password": {"type": "string"}, "token": {"type": "string"}, "versionfilter": {"properties": {"kind": {"type": "string"}, "pattern": {"type": "string"}, "strict": {"type": "boolean"}}, "additionalProperties": false, "type": "object"}, "tagfilter": {"type": "string"}}, "additionalProperties": false, "type": "object"} |
config.json | architectures | [C] architectures specifies a list of architectures to check container images for (conditions only) | {"items": {"type": "string"}, "type": "array"} |
config.json | architecture | [S][C] architecture specifies the container image architecture such as `amd64` | {"type": "string"} |
config.json | image | [S][C] image specifies the container image such as `updatecli/updatecli` | {"type": "string"} |
config.json | tag | [C] tag specifies the container image tag such as `latest` | {"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 | 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 | tagfilter | [S] tagfilter allows to restrict tags retrieved from a remote registry by using a regular expression. | {"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"} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.