schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
config.json
strict
strict enforce strict versioning rule. Only used for semantic versioning at this time
{"type": "boolean"}
config.json
typefilter
[s][c] TypeFilter specifies the GitHub Release type to retrieve before applying the versionfilter rule
{"properties": {"draft": {"type": "boolean"}, "prerelease": {"type": "boolean"}, "release": {"type": "boolean"}, "latest": {"type": "boolean"}}, "additionalProperties": false, "type": "object"}
config.json
draft
"Draft" enable/disable GitHub draft release
{"type": "boolean"}
config.json
prerelease
"PreRelease" enable/disable GitHub PreRelease
{"type": "boolean"}
config.json
release
"Release" enable/disable GitHub release
{"type": "boolean"}
config.json
latest
"Latest" if set to true will only filter the release flag as latest.
{"type": "boolean"}
config.json
tag
[c] Tag allows to check for a specific release tag, default to 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
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
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 an "helmchart" resource parsed from an updatecli manifest file
{"$schema": "http://json-schema.org/draft-04/schema", "properties": {"file": {"type": "string"}, "key": {"type": "string"}, "name": {"type": "string"}, "url": {"type": "string"}, "value": {"type": "string"}, "version": {"type": "string"}, "versionincrement": {"type": "string"}, "appversion": {"type": "boolean"}, "versionfilter": {"properties": {"kind": {"type": "string"}, "pattern": {"type": "string"}, "strict": {"type": "boolean"}}, "additionalProperties": false, "type": "object"}, "username": {"type": "string"}, "password": {"type": "string"}, "token": {"type": "string"}}, "additionalProperties": false, "type": "object"}
config.json
file
file defines the Helm Chart file to update. the path must be relative to chart root directory the chart name is defined by the parameter "name" compatible: * source * condition * target default: default set to "values.yaml"
{"type": "string"}
config.json
key
key defines the yamlpath query used for retrieving value from a YAML document compatible: * source * condition * target example: * key: $.image.tag * key: $.images[0].tag remark: * key is a simpler version of yamlpath accepts keys.
{"type": "string"}
config.json
name
name defines the Chart name path like 'stable/chart'. compatible: * source * condition * target example: * name: stable/chart remark: * when used with a scm, the name must be the relative path from the scm repository root directory with such as "stable/chart"
{"type": "string"}
config.json
url
url defines the Chart location URL. compatible: * source * condition example: * index.yaml * file://./index.yaml * https://github.com/updatecli/charts.git * oci://ghcr.io/olblak/charts/
{"type": "string"}
config.json
value
value is the value associated with a yamlpath query. compatible: * condition * target
{"type": "string"}
config.json
version
version defines the Chart version. It is used by condition to check if a version exists on the registry. compatible: * condition
{"type": "string"}
config.json
versionincrement
versionIncrement defines if a Chart changes, triggers, or not, a Chart version update, accepted values is a comma separated list of "none,major,minor,patch". compatible: * target default: default set to "minor" remark: when multiple pipelines update the same chart, the versionIncrement will be applied multiple times. more information on https://github.com/updatecli/updatecli/issues/693
{"type": "string"}
config.json
appversion
AppVersion defines if a Chart changes, triggers, or not, a Chart AppVersion update. The value is retrieved from the source input. compatible: * target default false
{"type": "boolean"}
config.json
versionfilter
versionfilter provides parameters to specify version pattern and its type like 'regex', 'semver', or just 'latest'. compatible: * source default: semver remark: * Helm chart uses semver by default.
{"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
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
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 toml file to manipulate
{"type": "string"}
config.json
files
[c][t] Files specifies a list of Json file to manipulate
{"items": {"type": "string"}, "type": "array"}
config.json
query
[s][c][t] Query allows to used advanced query. Override the parameter key
{"type": "string"}