key: replacer

description: Replacer specifies what value needs to be changed and how


key: from

description: From defines the source value which need to be replaced

type: string


key: to

description: To defines the "to what" a "from" value needs to be replaced


key: find

description: Find searches for a specific value if it exists and return false if it doesn't


key: findsubmatch

description: Find searches for a specific value if it exists then return the value using regular expression

type: integer

type: object


key: pattern

description: Pattern defines regular expression to use for retrieving a submatch


key: captureindex

description: 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`.


key: semverinc

description: SemvVerInc specifies a  comma separated list semantic versioning component that needs to be upgraded.


key: spec

description: Spec contains the updatecli configuration provided by users.

type: array

type: boolean


key: accesskey

description: accesskey specifies the aws access key which combined with `secretkey`, is one of the way to authenticate


key: secretkey

description: secretkey specifies the aws secret key which combined with `accesskey`, is one of the way to authenticate


key: filters

description: Filters specifies a list of AMI filters


key: items

description: Filter represents the updatecli configuration describing AMI filters.


key: name

description: Name specifies a filter name.


key: values

description: Values specifies a filter value for a specific filter name.


key: region

description: Region specifies the AWS region to use when looking for AMI


key: endpoint

description: Endpoint specifies the AWS endpoint to use when looking for AMI


key: dryrun

description: Dryrun allows to Check whether you have the required permissions for the action.


key: sortby

description: Sortby specifies the order of AMI-ID that will be used to retrieve the last element such as `creationdateasc`


key: scmid

description: scmid specifies the scm configuration key associated to the current resource


key: dependson

description: dependson specifies which resources must be executed before the current one


description: name specifies the resource name


key: transformers

description: transformers defines how the default input value need to be transformed

required: from to


description: Transformer holds a transformer rule


key: addprefix

description: AddPrefix adds a prefix to the transformer input value


key: addsuffix

description: AddSuffix adds a suffix to the transformer input value


key: trimprefix

description: TrimPrefix removes a prefix to the transformer input value


key: trimsuffix

description: TrimSuffix removes the suffix from the transformer input value


key: replacers

description: Replacers specifies a list of replacer instruction


description: Replacer is struct used to feed strings.Replacer


key: from

description: From defines the source value which need to be replaced


key: to

description: To defines the "to what" a "from" value needs to be replaced


key: replacer

description: Replacer specifies what value needs to be changed and how


key: find

description: Find searches for a specific value if it exists and return false if it doesn't


key: findsubmatch

description: Find searches for a specific value if it exists then return the value using regular expression


key: pattern

description: Pattern defines regular expression to use for retrieving a submatch


key: captureindex

description: 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`.


key: semverinc

description: SemvVerInc specifies a  comma separated list semantic versioning component that needs to be upgraded.


key: spec

description: Spec defines a specification for a "dockerimage" resource parsed from an updatecli manifest file


key: architectures

description: [C] architectures specifies a list of architectures to check container images for (conditions only)


key: architecture

description: [S][C] architecture specifies the container image architecture such as `amd64`


key: image

description: [S][C] image specifies the container image such as `updatecli/updatecli`


key: tag

description: [C] tag specifies the container image tag such as `latest`


key: username

description:
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


key: password

description:
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


key: token

description:
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


key: versionfilter

description: [S] versionfilter provides parameters to specify version pattern and its type like regex, semver, or just latest.


key: kind

description: specifies the version kind such as semver, regex, or latest


description: specifies the version pattern according the version kind


key: strict

description: strict enforce strict versioning rule. Only used for semantic versioning at this time


key: tagfilter

description: [S] tagfilter allows to restrict tags retrieved from a remote registry by using a regular expression.


key: scmid

description: scmid specifies the scm configuration key associated to the current resource


key: dependson

description: dependson specifies which resources must be executed before the current one


key: name

description: name specifies the resource name


key: transformers

description: transformers defines how the default input value need to be transformed


key: items

description: Transformer holds a transformer rule


key: addprefix

description: AddPrefix adds a prefix to the transformer input value


key: addsuffix

description: AddSuffix adds a suffix to the transformer input value


key: trimprefix

description: TrimPrefix removes a prefix to the transformer input value


key: trimsuffix

description: TrimSuffix removes the suffix from the transformer input value


key: replacers

description: Replacers specifies a list of replacer instruction


description: Replacer is struct used to feed strings.Replacer


key: from

description: From defines the source value which need to be replaced


key: to

description: To defines the "to what" a "from" value needs to be replaced


key: replacer

description: Replacer specifies what value needs to be changed and how


key: find

description: Find searches for a specific value if it exists and return false if it doesn't


key: findsubmatch

description: Find searches for a specific value if it exists then return the value using regular expression


key: pattern

description: Pattern defines regular expression to use for retrieving a submatch


key: captureindex

description: 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`.


key: semverinc

description: SemvVerInc specifies a  comma separated list semantic versioning component that needs to be upgraded.


key: spec

description: Spec defines a specification for a "maven" resource parsed from an updatecli manifest file


key: url

description: Deprecated, please specify the Maven url in the repository


key: repository

description: Specifies the maven repository url + name


key: repositories

description: Repositories specifies a list of Maven repository where to look for version. Order matter, version is retrieve from the first repository with the last one being Maven Central.


key: groupid

description: Specifies the maven artifact groupID


key: artifactid

description: Specifies the maven artifact artifactID


key: version

description: Specifies the maven artifact version


key: versionfilter

description: [S] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest.


key: kind

description: specifies the version kind such as semver, regex, or latest


description: specifies the version pattern according the version kind


key: strict

description: strict enforce strict versioning rule. Only used for semantic versioning at this time


key: scmid

description: scmid specifies the scm configuration key associated to the current resource


key: dependson

description: dependson specifies which resources must be executed before the current one


key: name

description: name specifies the resource name


key: transformers

description: transformers defines how the default input value need to be transformed


key: items

description: Transformer holds a transformer rule


key: addprefix

description: AddPrefix adds a prefix to the transformer input value


key: addsuffix

description: AddSuffix adds a suffix to the transformer input value


key: trimprefix

description: TrimPrefix removes a prefix to the transformer input value


key: trimsuffix

description: TrimSuffix removes the suffix from the transformer input value


key: replacers

description: Replacers specifies a list of replacer instruction


description: Replacer is struct used to feed strings.Replacer


key: from

description: From defines the source value which need to be replaced


key: to

description: To defines the "to what" a "from" value needs to be replaced


key: replacer

description: Replacer specifies what value needs to be changed and how


key: find

description: Find searches for a specific value if it exists and return false if it doesn't


key: findsubmatch

description: Find searches for a specific value if it exists then return the value using regular expression


key: pattern

description: Pattern defines regular expression to use for retrieving a submatch


key: captureindex

description: 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`.


key: semverinc

description: SemvVerInc specifies a  comma separated list semantic versioning component that needs to be upgraded.


key: spec

description: Spec defines a specification for a "shell" resource parsed from an updatecli manifest file

required: warning success failure


key: command

description: command specifies the shell command to execute by Updatecli


key: environments

description: environments allows to pass environment variable(s) to the shell script. By default no environment variable are shared.


key: items

description: Environment is a struct containing information for an environment variable such as its name and its value


key: name

description: Name defines the environment variable name


key: value

description: Value defines the environment variable value


key: changedif

description: ChangedIf defines how to interpreted shell command success criteria. What a success means, what an error means, and what a warning would mean


key: warning

description: Warning defines the command exit code used by Updatecli to identify a change need. Default to 2 if no exitcode have been specified


key: success

description: Success defines the command exit code used by Updatecli to identify no changes are needed. Default to 0 if no exitcode have been specified


key: failure

description: Failure defines the command exit code used by Updatecli to identify that something went wrong. Default to 1 if no exitcode have been specified


key: files

description: Files specifies the list of file that Updatecli monitors to identify state change


key: shell

description: Shell specifies which shell interpreter to use. Default to powershell(Windows) and "/bin/sh" (Darwin/Linux)


key: workdir

description: 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.


key: scmid

description: scmid specifies the scm configuration key associated to the current resource


key: dependson

description: dependson specifies which resources must be executed before the current one


description: name specifies the resource name


key: transformers

description: transformers defines how the default input value need to be transformed


description: Transformer holds a transformer rule


key: addprefix

description: AddPrefix adds a prefix to the transformer input value


key: addsuffix

description: AddSuffix adds a suffix to the transformer input value


key: trimprefix

description: TrimPrefix removes a prefix to the transformer input value


key: trimsuffix

description: TrimSuffix removes the suffix from the transformer input value


key: replacers

description: Replacers specifies a list of replacer instruction


key: items

description: Replacer is struct used to feed strings.Replacer


key: from

description: From defines the source value which need to be replaced


key: to

description: To defines the "to what" a "from" value needs to be replaced


key: replacer

description: Replacer specifies what value needs to be changed and how


key: find

description: Find searches for a specific value if it exists and return false if it doesn't


key: findsubmatch

description: Find searches for a specific value if it exists then return the value using regular expression


key: pattern

description: Pattern defines regular expression to use for retrieving a submatch


key: captureindex

description: 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`.


key: semverinc

description: SemvVerInc specifies a  comma separated list semantic versioning component that needs to be upgraded.


key: spec

description: "yaml" defines the specification for manipulating "yaml" files.


key: file

description:
"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


key: files

description:
"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


key: key

description:
"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


key: value

description:
"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.


key: keyonly

description:
"keyonly" allows to only check if a key exist and do not return an error otherwise

		compatible:
			* condition

		default:
			false


key: scmid

description: scmid specifies the scm configuration key associated to the current resource


key: dependson

description: dependson specifies which resources must be executed before the current one


key: name

description: name specifies the resource name


key: transformers

description: transformers defines how the default input value need to be transformed


key: items

description: Transformer holds a transformer rule


key: addprefix

description: AddPrefix adds a prefix to the transformer input value


key: addsuffix

description: AddSuffix adds a suffix to the transformer input value


key: trimprefix

description: TrimPrefix removes a prefix to the transformer input value


key: trimsuffix

description: TrimSuffix removes the suffix from the transformer input value


key: replacers

description: Replacers specifies a list of replacer instruction


description: Replacer is struct used to feed strings.Replacer


key: from

description: From defines the source value which need to be replaced


key: to

description: To defines the "to what" a "from" value needs to be replaced


key: replacer

description: Replacer specifies what value needs to be changed and how


key: find

description: Find searches for a specific value if it exists and return false if it doesn't


key: findsubmatch

description: Find searches for a specific value if it exists then return the value using regular expression


key: pattern

description: Pattern defines regular expression to use for retrieving a submatch


key: captureindex

description: 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`.


key: semverinc

description: SemvVerInc specifies a  comma separated list semantic versioning component that needs to be upgraded.


key: spec

description: Spec defines a specification for a "dockerdigest" resource parsed from an updatecli manifest file


key: architecture

description:
architecture specifies the container image architecture such as `amd64`

		compatible:
			* source
			* condition

		default:
			amd64


key: image

description:
image specifies the container image such as `updatecli/updatecli`

		compatible:
			* source
			* condition


key: tag

description:
tag specifies the container image tag such as `latest`

		compatible:
			* source
			* condition


key: digest

description:
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.


key: username

description:
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


key: password

description:
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


key: token

description:
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


key: hidetag

description:
hideTag specifies if the tag should be hidden from the digest

		compatible:
			* source

		default:
			false


key: scmid

description: scmid specifies the scm configuration key associated to the current resource


key: dependson

description: dependson specifies which resources must be executed before the current one


key: name

description: name specifies the resource name


key: transformers

description: transformers defines how the default input value need to be transformed


key: items

description: Transformer holds a transformer rule


key: addprefix

description: AddPrefix adds a prefix to the transformer input value


key: addsuffix

description: AddSuffix adds a suffix to the transformer input value


key: trimprefix

description: TrimPrefix removes a prefix to the transformer input value


key: trimsuffix

description: TrimSuffix removes the suffix from the transformer input value


key: replacers

description: Replacers specifies a list of replacer instruction


description: Replacer is struct used to feed strings.Replacer


key: from

description: From defines the source value which need to be replaced


key: to

description: To defines the "to what" a "from" value needs to be replaced


key: replacer

description: Replacer specifies what value needs to be changed and how


key: find

description: Find searches for a specific value if it exists and return false if it doesn't


key: findsubmatch

description: Find searches for a specific value if it exists then return the value using regular expression


key: pattern

description: Pattern defines regular expression to use for retrieving a submatch


key: captureindex

description: 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`.


key: semverinc

description: SemvVerInc specifies a  comma separated list semantic versioning component that needs to be upgraded.


key: spec

description: Spec defines settings used to interact with GitLab release

required: url owner repository


key: url

description:
"url" defines the GitLab url to interact with

		default:
			url defaults to "gitlab.com"


key: username

description: "username" defines the username used to authenticate with GitLab


key: token

description: "token" defines the credential used to authenticate with GitLab


key: owner

description: [S][C] Owner specifies repository owner


key: repository

description: [S][C] Repository specifies the name of a repository for a specific owner


key: versionfilter

description: [S][C] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest.


key: kind

description: specifies the version kind such as semver, regex, or latest


description: specifies the version pattern according the version kind


key: strict

description: strict enforce strict versioning rule. Only used for semantic versioning at this time


key: tag

description: [S] Tag defines the GitLab tag .


key: scmid

description: scmid specifies the scm configuration key associated to the current resource


key: dependson

description: dependson specifies which resources must be executed before the current one


key: name

description: name specifies the resource name


key: transformers

description: transformers defines how the default input value need to be transformed


key: items

description: Transformer holds a transformer rule


key: addprefix

description: AddPrefix adds a prefix to the transformer input value


key: addsuffix

description: AddSuffix adds a suffix to the transformer input value


key: trimprefix

description: TrimPrefix removes a prefix to the transformer input value


key: trimsuffix

description: TrimSuffix removes the suffix from the transformer input value


key: replacers

description: Replacers specifies a list of replacer instruction


description: Replacer is struct used to feed strings.Replacer


key: from

description: From defines the source value which need to be replaced


key: to

description: To defines the "to what" a "from" value needs to be replaced


key: replacer

description: Replacer specifies what value needs to be changed and how


key: find

description: Find searches for a specific value if it exists and return false if it doesn't


key: findsubmatch

description: Find searches for a specific value if it exists then return the value using regular expression


key: pattern

description: Pattern defines regular expression to use for retrieving a submatch


key: captureindex

description: 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`.


key: semverinc

description: SemvVerInc specifies a  comma separated list semantic versioning component that needs to be upgraded.


key: spec

description: Spec defines settings used to interact with Bitbucket release


key: url

description: [S][C][T] URL specifies the default github url in case of Bitbucket enterprise


key: username

description: [S][C][T] Username specifies the username used to authenticate with Bitbucket API


key: token

description: [S][C][T] Token specifies the credential used to authenticate with


key: password


key: owner

description: [S][C] Owner specifies repository owner


key: repository

description: [S][C] Repository specifies the name of a repository for a specific owner


key: versionfilter

description: [S][C] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest.


key: kind

description: specifies the version kind such as semver, regex, or latest


description: specifies the version pattern according the version kind


key: strict

description: strict enforce strict versioning rule. Only used for semantic versioning at this time


key: tag

description: [S] Tag defines the Bitbucket tag .


key: scmid

description: scmid specifies the scm configuration key associated to the current resource


key: dependson

description: dependson specifies which resources must be executed before the current one


key: name

description: name specifies the resource name


key: transformers

description: transformers defines how the default input value need to be transformed


key: items

description: Transformer holds a transformer rule


key: addprefix

description: AddPrefix adds a prefix to the transformer input value


key: addsuffix

description: AddSuffix adds a suffix to the transformer input value


key: trimprefix

description: TrimPrefix removes a prefix to the transformer input value


key: trimsuffix

description: TrimSuffix removes the suffix from the transformer input value


key: replacers

description: Replacers specifies a list of replacer instruction


description: Replacer is struct used to feed strings.Replacer


key: from

description: From defines the source value which need to be replaced


key: to

description: To defines the "to what" a "from" value needs to be replaced


key: replacer

description: Replacer specifies what value needs to be changed and how


key: find

description: Find searches for a specific value if it exists and return false if it doesn't


key: findsubmatch

description: Find searches for a specific value if it exists then return the value using regular expression


key: pattern

description: Pattern defines regular expression to use for retrieving a submatch


key: captureindex

description: 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`.


key: semverinc

description: SemvVerInc specifies a  comma separated list semantic versioning component that needs to be upgraded.


key: spec

description: Spec defines a specification for a "dockerimage" resource parsed from an updatecli manifest file


key: registry

description: [S][C] Registry specifies the registry to use


key: auth

description: [A][S][C] Auth specifies the cargo registry auth to use for authentication.


key: token

description: [A][S][C] Token specifies the cargo registry token to use for authentication.


key: headerformat

description: [A][S][C] HeaderFormat specifies the cargo registry header format to use for authentication (defaults to `Bearer`).


key: url

description: [A][S][C] URL specifies the cargo registry URL to use for authentication.


key: rootdir

description: [A][S][C] RootDir specifies the cargo registry root directory to use as FS index.


key: scmid

description: [A] SCMID specifies the cargo registry scmId to use as FS index.


key: package

description: [S][C] Package specifies the name of the package


key: version

description: [C] Defines a specific package version


key: versionfilter

description: [S] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest.


key: kind

description: specifies the version kind such as semver, regex, or latest


description: specifies the version pattern according the version kind


key: strict

description: strict enforce strict versioning rule. Only used for semantic versioning at this time


description: scmid specifies the scm configuration key associated to the current resource


key: conditions

description: Conditions defines the list of condition configuration


key: dependson

description: dependson specifies which resources must be executed before the current one


key: name

description: name specifies the resource name


key: transformers

description: transformers defines how the default input value need to be transformed


key: items

description: Transformer holds a transformer rule


key: addprefix

description: AddPrefix adds a prefix to the transformer input value


key: addsuffix

description: AddSuffix adds a suffix to the transformer input value


key: trimprefix

description: TrimPrefix removes a prefix to the transformer input value


key: trimsuffix

description: TrimSuffix removes the suffix from the transformer input value


key: replacers

description: Replacers specifies a list of replacer instruction


description: Replacer is struct used to feed strings.Replacer


key: from

description: From defines the source value which need to be replaced


key: to

description: To defines the "to what" a "from" value needs to be replaced


key: replacer

description: Replacer specifies what value needs to be changed and how


key: find

description: Find searches for a specific value if it exists and return false if it doesn't


key: findsubmatch

description: Find searches for a specific value if it exists then return the value using regular expression


key: pattern

description: Pattern defines regular expression to use for retrieving a submatch


key: captureindex

description: 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`.


key: semverinc

description: SemvVerInc specifies a  comma separated list semantic versioning component that needs to be upgraded.


key: spec

description: Spec defines a specification for a "dockerfile" resource parsed from an updatecli manifest file


key: file

description: File specifies the dockerimage file such as Dockerfile


key: instruction

description: Instruction specifies a DockerImage instruction such as ENV


key: value

description: Value specifies the value for a specified Dockerfile instruction.


key: scmid

description: scmid specifies the scm configuration key associated to the current resource


key: dependson

description: dependson specifies which resources must be executed before the current one


key: name

description: name specifies the resource name


key: transformers

description: transformers defines how the default input value need to be transformed


key: items

description: Transformer holds a transformer rule


key: addprefix

description: AddPrefix adds a prefix to the transformer input value


key: addsuffix

description: AddSuffix adds a suffix to the transformer input value


key: trimprefix

description: TrimPrefix removes a prefix to the transformer input value


key: trimsuffix

description: TrimSuffix removes the suffix from the transformer input value


key: replacers

description: Replacers specifies a list of replacer instruction


description: Replacer is struct used to feed strings.Replacer


key: from

description: From defines the source value which need to be replaced


key: to

description: To defines the "to what" a "from" value needs to be replaced


key: replacer

description: Replacer specifies what value needs to be changed and how


key: find

description: Find searches for a specific value if it exists and return false if it doesn't


key: findsubmatch

description: Find searches for a specific value if it exists then return the value using regular expression


key: pattern

description: Pattern defines regular expression to use for retrieving a submatch


key: captureindex

description: 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`.


key: semverinc

description: SemvVerInc specifies a  comma separated list semantic versioning component that needs to be upgraded.


key: spec

description: Spec defines a specification for a "maven" resource parsed from an updatecli manifest file


key: url

description: Deprecated, please specify the Maven url in the repository


key: repository

description: Specifies the maven repository url + name


key: repositories

description: Repositories specifies a list of Maven repository where to look for version. Order matter, version is retrieve from the first repository with the last one being Maven Central.


key: groupid

description: Specifies the maven artifact groupID


key: artifactid

description: Specifies the maven artifact artifactID


key: version

description: Specifies the maven artifact version


key: versionfilter

description: [S] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest.


key: kind

description: specifies the version kind such as semver, regex, or latest


description: specifies the version pattern according the version kind


key: strict

description: strict enforce strict versioning rule. Only used for semantic versioning at this time


key: scmid

description: scmid specifies the scm configuration key associated to the current resource


key: dependson

description: dependson specifies which resources must be executed before the current one


key: name

description: name specifies the resource name


key: transformers

description: transformers defines how the default input value need to be transformed


key: items

description: Transformer holds a transformer rule


key: addprefix

description: AddPrefix adds a prefix to the transformer input value


key: addsuffix

description: AddSuffix adds a suffix to the transformer input value


key: trimprefix

description: TrimPrefix removes a prefix to the transformer input value


key: trimsuffix

description: TrimSuffix removes the suffix from the transformer input value


key: replacers

description: Replacers specifies a list of replacer instruction


description: Replacer is struct used to feed strings.Replacer


key: from

description: From defines the source value which need to be replaced


key: to

description: To defines the "to what" a "from" value needs to be replaced


key: replacer

description: Replacer specifies what value needs to be changed and how


key: find

description: Find searches for a specific value if it exists and return false if it doesn't


key: findsubmatch

description: Find searches for a specific value if it exists then return the value using regular expression


key: pattern

description: Pattern defines regular expression to use for retrieving a submatch


key: captureindex

description: 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`.


key: semverinc

description: SemvVerInc specifies a  comma separated list semantic versioning component that needs to be upgraded.


key: spec

description: Spec defines a specification for a "shell" resource parsed from an updatecli manifest file


key: command

description: command specifies the shell command to execute by Updatecli


key: environments

description: environments allows to pass environment variable(s) to the shell script. By default no environment variable are shared.


key: items

description: Environment is a struct containing information for an environment variable such as its name and its value


key: name

description: Name defines the environment variable name


key: value

description: Value defines the environment variable value


key: changedif

description: ChangedIf defines how to interpreted shell command success criteria. What a success means, what an error means, and what a warning would mean


key: warning

description: Warning defines the command exit code used by Updatecli to identify a change need. Default to 2 if no exitcode have been specified


key: success

description: Success defines the command exit code used by Updatecli to identify no changes are needed. Default to 0 if no exitcode have been specified


key: failure

description: Failure defines the command exit code used by Updatecli to identify that something went wrong. Default to 1 if no exitcode have been specified


key: files

description: Files specifies the list of file that Updatecli monitors to identify state change


key: shell

description: Shell specifies which shell interpreter to use. Default to powershell(Windows) and "/bin/sh" (Darwin/Linux)


key: workdir

description: 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.


key: scmid

description: scmid specifies the scm configuration key associated to the current resource


key: dependson

description: dependson specifies which resources must be executed before the current one


description: name specifies the resource name


key: transformers

description: transformers defines how the default input value need to be transformed


description: Transformer holds a transformer rule


key: addprefix

description: AddPrefix adds a prefix to the transformer input value


key: addsuffix

description: AddSuffix adds a suffix to the transformer input value


key: trimprefix

description: TrimPrefix removes a prefix to the transformer input value


key: trimsuffix

description: TrimSuffix removes the suffix from the transformer input value


key: replacers

description: Replacers specifies a list of replacer instruction


key: items

description: Replacer is struct used to feed strings.Replacer


key: from

description: From defines the source value which need to be replaced


key: to

description: To defines the "to what" a "from" value needs to be replaced


key: replacer

description: Replacer specifies what value needs to be changed and how


key: find

description: Find searches for a specific value if it exists and return false if it doesn't


key: findsubmatch

description: Find searches for a specific value if it exists then return the value using regular expression


key: pattern

description: Pattern defines regular expression to use for retrieving a submatch


key: captureindex

description: 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`.


key: semverinc

description: SemvVerInc specifies a  comma separated list semantic versioning component that needs to be upgraded.


key: spec

description: Spec defines a specification for a "Golang" resource parsed from an updatecli manifest file


key: version

description: [C] Version defines a specific golang version


key: versionfilter

description: [S] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest.


key: kind

description: specifies the version kind such as semver, regex, or latest


description: specifies the version pattern according the version kind


key: strict

description: strict enforce strict versioning rule. Only used for semantic versioning at this time


key: scmid

description: scmid specifies the scm configuration key associated to the current resource


key: dependson

description: dependson specifies which resources must be executed before the current one


key: name

description: name specifies the resource name


key: transformers

description: transformers defines how the default input value need to be transformed


key: items

description: Transformer holds a transformer rule


key: addprefix

description: AddPrefix adds a prefix to the transformer input value


key: addsuffix

description: AddSuffix adds a suffix to the transformer input value


key: trimprefix

description: TrimPrefix removes a prefix to the transformer input value


key: trimsuffix

description: TrimSuffix removes the suffix from the transformer input value


key: replacers

description: Replacers specifies a list of replacer instruction


description: Replacer is struct used to feed strings.Replacer


key: from

description: From defines the source value which need to be replaced


key: to

description: To defines the "to what" a "from" value needs to be replaced


key: replacer

description: Replacer specifies what value needs to be changed and how


key: find

description: Find searches for a specific value if it exists and return false if it doesn't


key: findsubmatch

description: Find searches for a specific value if it exists then return the value using regular expression


key: pattern

description: Pattern defines regular expression to use for retrieving a submatch


key: captureindex

description: 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`.


key: semverinc

description: SemvVerInc specifies a  comma separated list semantic versioning component that needs to be upgraded.


key: spec

description: "yaml" defines the specification for manipulating "yaml" files.


key: file

description:
"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


key: files

description:
"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


key: key

description:
"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


key: value

description:
"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.


key: keyonly

description:
"keyonly" allows to only check if a key exist and do not return an error otherwise

		compatible:
			* condition

		default:
			false


key: scmid

description: scmid specifies the scm configuration key associated to the current resource


key: dependson

description: dependson specifies which resources must be executed before the current one


key: name

description: name specifies the resource name


key: transformers

description: transformers defines how the default input value need to be transformed


key: items

description: Transformer holds a transformer rule


key: addprefix

description: AddPrefix adds a prefix to the transformer input value


key: addsuffix

description: AddSuffix adds a suffix to the transformer input value


key: trimprefix

description: TrimPrefix removes a prefix to the transformer input value


key: trimsuffix

description: TrimSuffix removes the suffix from the transformer input value


key: replacers

description: Replacers specifies a list of replacer instruction


description: Replacer is struct used to feed strings.Replacer


key: from

description: From defines the source value which need to be replaced


key: to

description: To defines the "to what" a "from" value needs to be replaced


key: replacer

description: Replacer specifies what value needs to be changed and how


key: find

description: Find searches for a specific value if it exists and return false if it doesn't


key: findsubmatch

description: Find searches for a specific value if it exists then return the value using regular expression


key: pattern

description: Pattern defines regular expression to use for retrieving a submatch


key: captureindex

description: 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`.


key: semverinc

description: SemvVerInc specifies a  comma separated list semantic versioning component that needs to be upgraded.


key: spec

description: Spec defines a specification for a "gomodule" resource parsed from an updatecli manifest file


key: proxy

description:
Proxy may have the schemes https, http. file is not supported at this time. If a URL has no scheme, https is assumed
[S][C] Proxy allows to override GO proxy similarly to GOPROXY environment variable.


key: module

description: [S][C] Module specifies the name of the module


key: version

description: [C] Defines a specific package version


key: versionfilter

description: [S] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest.


key: kind

description: specifies the version kind such as semver, regex, or latest


description: specifies the version pattern according the version kind


key: strict

description: strict enforce strict versioning rule. Only used for semantic versioning at this time


key: scmid

description: scmid specifies the scm configuration key associated to the current resource


key: dependson

description: dependson specifies which resources must be executed before the current one


key: name

description: name specifies the resource name


key: transformers

description: transformers defines how the default input value need to be transformed


key: items

description: Transformer holds a transformer rule


key: addprefix

description: AddPrefix adds a prefix to the transformer input value


key: addsuffix

description: AddSuffix adds a suffix to the transformer input value


key: trimprefix

description: TrimPrefix removes a prefix to the transformer input value


key: trimsuffix

description: TrimSuffix removes the suffix from the transformer input value


key: replacers

description: Replacers specifies a list of replacer instruction


description: Replacer is struct used to feed strings.Replacer


key: from

description: From defines the source value which need to be replaced


key: to

description: To defines the "to what" a "from" value needs to be replaced


key: replacer

description: Replacer specifies what value needs to be changed and how


key: find

description: Find searches for a specific value if it exists and return false if it doesn't


key: findsubmatch

description: Find searches for a specific value if it exists then return the value using regular expression


key: pattern

description: Pattern defines regular expression to use for retrieving a submatch


key: captureindex

description: 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`.


key: semverinc

description: SemvVerInc specifies a  comma separated list semantic versioning component that needs to be upgraded.


key: spec

description: Spec defines settings used to interact with Bitbucket release


key: url

description: [S][C][T] URL specifies the default github url in case of Bitbucket enterprise


key: username

description: [S][C][T] Username specifies the username used to authenticate with Bitbucket API


key: token

description: [S][C][T] Token specifies the credential used to authenticate with


key: password


key: owner

description: [S][C] Owner specifies repository owner


key: repository

description: [S][C] Repository specifies the name of a repository for a specific owner


key: versionfilter

description: [S][C] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest.


key: kind

description: specifies the version kind such as semver, regex, or latest


description: specifies the version pattern according the version kind


key: strict

description: strict enforce strict versioning rule. Only used for semantic versioning at this time


key: tag

description: [S] Tag defines the Bitbucket tag .


key: scmid

description: scmid specifies the scm configuration key associated to the current resource


key: dependson

description: dependson specifies which resources must be executed before the current one


key: name

description: name specifies the resource name


key: transformers

description: transformers defines how the default input value need to be transformed


key: items

description: Transformer holds a transformer rule


key: addprefix

description: AddPrefix adds a prefix to the transformer input value


key: addsuffix

description: AddSuffix adds a suffix to the transformer input value


key: trimprefix

description: TrimPrefix removes a prefix to the transformer input value


key: trimsuffix

description: TrimSuffix removes the suffix from the transformer input value


key: replacers

description: Replacers specifies a list of replacer instruction


description: Replacer is struct used to feed strings.Replacer


key: from

description: From defines the source value which need to be replaced


key: to

description: To defines the "to what" a "from" value needs to be replaced


key: replacer

description: Replacer specifies what value needs to be changed and how


key: find

description: Find searches for a specific value if it exists and return false if it doesn't


key: findsubmatch

description: Find searches for a specific value if it exists then return the value using regular expression


key: pattern

description: Pattern defines regular expression to use for retrieving a submatch


key: captureindex

description: 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`.


key: semverinc

description: SemvVerInc specifies a  comma separated list semantic versioning component that needs to be upgraded.


key: spec

description: Spec defines a specification for a "dockerdigest" resource parsed from an updatecli manifest file


key: architecture

description:
architecture specifies the container image architecture such as `amd64`

		compatible:
			* source
			* condition

		default:
			amd64


key: image

description:
image specifies the container image such as `updatecli/updatecli`

		compatible:
			* source
			* condition


key: tag

description:
tag specifies the container image tag such as `latest`

		compatible:
			* source
			* condition


key: digest

description:
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.


key: username

description:
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


key: password

description:
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


key: token

description:
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


key: hidetag

description:
hideTag specifies if the tag should be hidden from the digest

		compatible:
			* source

		default:
			false


key: scmid

description: scmid specifies the scm configuration key associated to the current resource


key: dependson

description: dependson specifies which resources must be executed before the current one


key: name

description: name specifies the resource name


key: transformers

description: transformers defines how the default input value need to be transformed


key: items

description: Transformer holds a transformer rule


key: addprefix

description: AddPrefix adds a prefix to the transformer input value


key: addsuffix

description: AddSuffix adds a suffix to the transformer input value


key: trimprefix

description: TrimPrefix removes a prefix to the transformer input value


key: trimsuffix

description: TrimSuffix removes the suffix from the transformer input value


key: replacers

description: Replacers specifies a list of replacer instruction


description: Replacer is struct used to feed strings.Replacer


key: from

description: From defines the source value which need to be replaced


key: to

description: To defines the "to what" a "from" value needs to be replaced


key: replacer

description: Replacer specifies what value needs to be changed and how


key: find

description: Find searches for a specific value if it exists and return false if it doesn't


key: findsubmatch

description: Find searches for a specific value if it exists then return the value using regular expression


key: pattern

description: Pattern defines regular expression to use for retrieving a submatch


key: captureindex

description: 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`.


key: semverinc

description: SemvVerInc specifies a  comma separated list semantic versioning component that needs to be upgraded.


key: spec

description: Spec defines a specification for a "dockerimage" resource parsed from an updatecli manifest file


key: architectures

description: [C] architectures specifies a list of architectures to check container images for (conditions only)


key: architecture

description: [S][C] architecture specifies the container image architecture such as `amd64`


key: image

description: [S][C] image specifies the container image such as `updatecli/updatecli`


key: tag

description: [C] tag specifies the container image tag such as `latest`


key: username

description:
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


key: password

description:
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


key: token

description:
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


key: versionfilter

description: [S] versionfilter provides parameters to specify version pattern and its type like regex, semver, or just latest.


key: kind

description: specifies the version kind such as semver, regex, or latest


description: specifies the version pattern according the version kind


key: strict

description: strict enforce strict versioning rule. Only used for semantic versioning at this time


key: tagfilter

description: [S] tagfilter allows to restrict tags retrieved from a remote registry by using a regular expression.


key: scmid

description: scmid specifies the scm configuration key associated to the current resource


key: dependson

description: dependson specifies which resources must be executed before the current one


key: name

description: name specifies the resource name


key: transformers

description: transformers defines how the default input value need to be transformed


key: items

description: Transformer holds a transformer rule


key: addprefix

description: AddPrefix adds a prefix to the transformer input value


key: addsuffix

description: AddSuffix adds a suffix to the transformer input value


key: trimprefix

description: TrimPrefix removes a prefix to the transformer input value


key: trimsuffix

description: TrimSuffix removes the suffix from the transformer input value


key: replacers

description: Replacers specifies a list of replacer instruction


description: Replacer is struct used to feed strings.Replacer


key: from

description: From defines the source value which need to be replaced


key: to

description: To defines the "to what" a "from" value needs to be replaced


key: replacer

description: Replacer specifies what value needs to be changed and how


key: find

description: Find searches for a specific value if it exists and return false if it doesn't


key: findsubmatch

description: Find searches for a specific value if it exists then return the value using regular expression


key: pattern

description: Pattern defines regular expression to use for retrieving a submatch


key: captureindex

description: 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`.


key: semverinc

description: SemvVerInc specifies a  comma separated list semantic versioning component that needs to be upgraded.


key: spec

description: Spec defines a specification for a "file" resource parsed from an updatecli manifest file


key: file

description: File contains the file path(s) to take in account and is incompatible with Files


key: files

description: Files contains the file path(s) to take in account and is incompatible with File


key: line

description: Line contains the line of the file(s) to take in account


key: content

description: Content specifies the content to take in account instead of the file content


key: forcecreate

description: ForceCreate specifies if nonexistent file(s) should be created if they are targets


key: matchpattern

description: MatchPattern specifies the regexp pattern to match on the file(s)


key: replacepattern

description: ReplacePattern specifies the regexp replace pattern to apply on the file(s) content


key: scmid

description: scmid specifies the scm configuration key associated to the current resource


key: dependson

description: dependson specifies which resources must be executed before the current one


key: name

description: name specifies the resource name


key: transformers

description: transformers defines how the default input value need to be transformed


key: items

description: Transformer holds a transformer rule


key: addprefix

description: AddPrefix adds a prefix to the transformer input value


key: addsuffix

description: AddSuffix adds a suffix to the transformer input value


key: trimprefix

description: TrimPrefix removes a prefix to the transformer input value


key: trimsuffix

description: TrimSuffix removes the suffix from the transformer input value


key: replacers

description: Replacers specifies a list of replacer instruction


description: Replacer is struct used to feed strings.Replacer


key: from

description: From defines the source value which need to be replaced


key: to

description: To defines the "to what" a "from" value needs to be replaced


key: replacer

description: Replacer specifies what value needs to be changed and how


key: find

description: Find searches for a specific value if it exists and return false if it doesn't


key: findsubmatch

description: Find searches for a specific value if it exists then return the value using regular expression


key: pattern

description: Pattern defines regular expression to use for retrieving a submatch


key: captureindex

description: 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`.


key: semverinc

description: SemvVerInc specifies a  comma separated list semantic versioning component that needs to be upgraded.


key: spec

description: Spec defines a specification for a "gittag" resource parsed from an updatecli manifest file


key: path

description: Path contains the git repository path


key: versionfilter

description: VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest.


key: kind

description: specifies the version kind such as semver, regex, or latest


description: specifies the version pattern according the version kind


key: strict

description: strict enforce strict versioning rule. Only used for semantic versioning at this time


key: message

description: Message associated to the git tag


key: key

description: Key of the tag object to retrieve, default is tag "name" filters are always against tag name, this only controls the output; Current options are 'name' and 'hash'.


key: scmid

description: scmid specifies the scm configuration key associated to the current resource


key: dependson

description: dependson specifies which resources must be executed before the current one


key: name

description: name specifies the resource name


key: transformers

description: transformers defines how the default input value need to be transformed


key: items

description: Transformer holds a transformer rule


key: addprefix

description: AddPrefix adds a prefix to the transformer input value


key: addsuffix

description: AddSuffix adds a suffix to the transformer input value


key: trimprefix

description: TrimPrefix removes a prefix to the transformer input value


key: trimsuffix

description: TrimSuffix removes the suffix from the transformer input value


key: replacers

description: Replacers specifies a list of replacer instruction


description: Replacer is struct used to feed strings.Replacer


key: from

description: From defines the source value which need to be replaced


key: to

description: To defines the "to what" a "from" value needs to be replaced


key: replacer

description: Replacer specifies what value needs to be changed and how


key: find

description: Find searches for a specific value if it exists and return false if it doesn't


key: findsubmatch

description: Find searches for a specific value if it exists then return the value using regular expression


key: pattern

description: Pattern defines regular expression to use for retrieving a submatch


key: captureindex

description: 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`.


key: semverinc

description: SemvVerInc specifies a  comma separated list semantic versioning component that needs to be upgraded.


key: spec

description: Spec defines settings used to interact with Gitea release


key: url

description: "url" defines the Gitea url to interact with


key: username

description: "username" defines the username used to authenticate with Gitea API


key: token

description: "token" specifies the credential used to authenticate with Gitea API


key: owner

description: [S][C][T] owner specifies the repository owner


key: repository

description: [S][C][T] repository specifies the name of a repository for a specific owner


key: versionfilter

description: [S] versionfilter provides parameters to specify version pattern and its type like regex, semver, or just latest.


key: kind

description: specifies the version kind such as semver, regex, or latest


description: specifies the version pattern according the version kind


key: strict

description: strict enforce strict versioning rule. Only used for semantic versioning at this time


key: title

description: [T] title defines the Gitea release title.


key: tag

description: [C][T] tag defines the Gitea release tag.


key: commitish

description: [T] commitish defines the commit-ish such as `main`


key: description

description: [T] description defines if the new release description


key: draft

description: [T] draft defines if the release is a draft release


key: prerelease

description: [T] prerelease defines if the release is a pre-release release


key: scmid

description: scmid specifies the scm configuration key associated to the current resource


key: dependson

description: dependson specifies which resources must be executed before the current one


key: name

description: name specifies the resource name


key: transformers

description: transformers defines how the default input value need to be transformed


key: items

description: Transformer holds a transformer rule


key: addprefix

description: AddPrefix adds a prefix to the transformer input value


key: addsuffix

description: AddSuffix adds a suffix to the transformer input value


key: trimprefix

description: TrimPrefix removes a prefix to the transformer input value


key: trimsuffix

description: TrimSuffix removes the suffix from the transformer input value


key: replacers

description: Replacers specifies a list of replacer instruction


description: Replacer is struct used to feed strings.Replacer


key: from

description: From defines the source value which need to be replaced


key: to

description: To defines the "to what" a "from" value needs to be replaced


key: replacer

description: Replacer specifies what value needs to be changed and how


key: find

description: Find searches for a specific value if it exists and return false if it doesn't


key: findsubmatch

description: Find searches for a specific value if it exists then return the value using regular expression


key: pattern

description: Pattern defines regular expression to use for retrieving a submatch


key: captureindex

description: 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`.


key: semverinc

description: SemvVerInc specifies a  comma separated list semantic versioning component that needs to be upgraded.


key: file

description: [s][c][t] File specifies the toml file to manipulate


key: files

description: [c][t] Files specifies a list of Json file to manipulate


key: query

description: [s][c][t] Query allows to used advanced query. Override the parameter key


key: key

description: [s][c][t] Key specifies the query to retrieve an information from a toml file


key: value

description: [s][c][t] Value specifies the value for a specific key. Default to source output


key: versionfilter

description: [s] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest.


key: kind

description: specifies the version kind such as semver, regex, or latest


description: specifies the version pattern according the version kind


key: strict

description: strict enforce strict versioning rule. Only used for semantic versioning at this time


key: createmissingkey

description:
[t] CreateMissingKey allows non-existing keys. If the key does not exist, the key is created if AllowsMissingKey
	  is true, otherwise an error is raised (the default).
	  Only supported if Key is used


key: scmid

description: scmid specifies the scm configuration key associated to the current resource


key: dependson

description: dependson specifies which resources must be executed before the current one


key: name

description: name specifies the resource name


key: transformers

description: transformers defines how the default input value need to be transformed


key: items

description: Transformer holds a transformer rule


key: addprefix

description: AddPrefix adds a prefix to the transformer input value


key: addsuffix

description: AddSuffix adds a suffix to the transformer input value


key: trimprefix

description: TrimPrefix removes a prefix to the transformer input value


key: trimsuffix

description: TrimSuffix removes the suffix from the transformer input value


key: replacers

description: Replacers specifies a list of replacer instruction


description: Replacer is struct used to feed strings.Replacer


key: from

description: From defines the source value which need to be replaced


key: to

description: To defines the "to what" a "from" value needs to be replaced


key: replacer

description: Replacer specifies what value needs to be changed and how


key: find

description: Find searches for a specific value if it exists and return false if it doesn't


key: findsubmatch

description: Find searches for a specific value if it exists then return the value using regular expression


key: pattern

description: Pattern defines regular expression to use for retrieving a submatch


key: captureindex

description: 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`.


key: semverinc

description: SemvVerInc specifies a  comma separated list semantic versioning component that needs to be upgraded.


key: file

description: [s][c][t] File specifies the Json file to manipulate


key: files

description: [c][t] Files specifies a list of Json file to manipulate


key: key

description: [s][c][t] Key specifies the Jsonpath key to manipulate


key: value

description: [s][c][t] Value specifies the Jsonpath key to manipulate. Default to source output


key: query

description: [s][c][t] Query allows to used advanced query. Override the parameter key


key: versionfilter

description: [s]VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest.


key: kind

description: specifies the version kind such as semver, regex, or latest


description: specifies the version pattern according the version kind


key: strict

description: strict enforce strict versioning rule. Only used for semantic versioning at this time


key: scmid

description: scmid specifies the scm configuration key associated to the current resource


key: dependson

description: dependson specifies which resources must be executed before the current one


key: name

description: name specifies the resource name


key: transformers

description: transformers defines how the default input value need to be transformed


key: items

description: Transformer holds a transformer rule


key: addprefix

description: AddPrefix adds a prefix to the transformer input value


key: addsuffix

description: AddSuffix adds a suffix to the transformer input value


key: trimprefix

description: TrimPrefix removes a prefix to the transformer input value


key: trimsuffix

description: TrimSuffix removes the suffix from the transformer input value


key: replacers

description: Replacers specifies a list of replacer instruction


description: Replacer is struct used to feed strings.Replacer


key: from

description: From defines the source value which need to be replaced


key: to

description: To defines the "to what" a "from" value needs to be replaced


key: replacer

description: Replacer specifies what value needs to be changed and how


key: find

description: Find searches for a specific value if it exists and return false if it doesn't


key: findsubmatch

description: Find searches for a specific value if it exists then return the value using regular expression


key: pattern

description: Pattern defines regular expression to use for retrieving a submatch


key: captureindex

description: 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`.


key: semverinc

description: SemvVerInc specifies a  comma separated list semantic versioning component that needs to be upgraded.


key: spec

description: Spec defines a specification for a "gitbranch" resource parsed from an updatecli manifest file


key: path

description: [s][c][t] Path contains the git repository path


key: versionfilter

description: [s] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest.


key: kind

description: specifies the version kind such as semver, regex, or latest


description: specifies the version pattern according the version kind


key: strict

description: strict enforce strict versioning rule. Only used for semantic versioning at this time


key: branch

description: [c][t] Specify branch name


key: scmid

description: scmid specifies the scm configuration key associated to the current resource


key: dependson

description: dependson specifies which resources must be executed before the current one


key: name

description: name specifies the resource name


key: transformers

description: transformers defines how the default input value need to be transformed


key: items

description: Transformer holds a transformer rule


key: addprefix

description: AddPrefix adds a prefix to the transformer input value


key: addsuffix

description: AddSuffix adds a suffix to the transformer input value


key: trimprefix

description: TrimPrefix removes a prefix to the transformer input value


key: trimsuffix

description: TrimSuffix removes the suffix from the transformer input value


key: replacers

description: Replacers specifies a list of replacer instruction


description: Replacer is struct used to feed strings.Replacer


key: from

description: From defines the source value which need to be replaced


key: to

description: To defines the "to what" a "from" value needs to be replaced


key: replacer

description: Replacer specifies what value needs to be changed and how


key: find

description: Find searches for a specific value if it exists and return false if it doesn't


key: findsubmatch

description: Find searches for a specific value if it exists then return the value using regular expression


key: pattern

description: Pattern defines regular expression to use for retrieving a submatch


key: captureindex

description: 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`.


key: semverinc

description: SemvVerInc specifies a  comma separated list semantic versioning component that needs to be upgraded.


key: spec

description: Spec defines a specification for a "gittag" resource parsed from an updatecli manifest file

required: owner repository token


key: owner

description: [s][c] Owner specifies repository owner


key: repository

description: [s][c] Repository specifies the name of a repository for a specific owner


key: token

description: [s][c] Token specifies the credential used to authenticate with


key: url

description: [s][c] URL specifies the default github url in case of GitHub enterprise


key: username

description: [s][c] Username specifies the username used to authenticate with GitHub API


key: versionfilter

description: [s] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest.


key: kind

description: specifies the version kind such as semver, regex, or latest


description: specifies the version pattern according the version kind


key: strict

description: strict enforce strict versioning rule. Only used for semantic versioning at this time


key: typefilter

description: [s][c] TypeFilter specifies the GitHub Release type to retrieve before applying the versionfilter rule


key: draft

description: "Draft" enable/disable GitHub draft release


key: prerelease

description: "PreRelease" enable/disable GitHub PreRelease


key: release

description: "Release" enable/disable GitHub release


key: latest

description: "Latest" if set to true will only filter the release flag as latest.


key: tag

description: [c] Tag allows to check for a specific release tag, default to source output


key: scmid

description: scmid specifies the scm configuration key associated to the current resource


key: dependson

description: dependson specifies which resources must be executed before the current one


key: name

description: name specifies the resource name


key: transformers

description: transformers defines how the default input value need to be transformed


key: items

description: Transformer holds a transformer rule


key: addprefix

description: AddPrefix adds a prefix to the transformer input value


key: addsuffix

description: AddSuffix adds a suffix to the transformer input value


key: trimprefix

description: TrimPrefix removes a prefix to the transformer input value


key: trimsuffix

description: TrimSuffix removes the suffix from the transformer input value


key: replacers

description: Replacers specifies a list of replacer instruction


description: Replacer is struct used to feed strings.Replacer


key: from

description: From defines the source value which need to be replaced


key: to

description: To defines the "to what" a "from" value needs to be replaced


key: replacer

description: Replacer specifies what value needs to be changed and how


key: find

description: Find searches for a specific value if it exists and return false if it doesn't


key: findsubmatch

description: Find searches for a specific value if it exists then return the value using regular expression


key: pattern

description: Pattern defines regular expression to use for retrieving a submatch


key: captureindex

description: 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`.


key: semverinc

description: SemvVerInc specifies a  comma separated list semantic versioning component that needs to be upgraded.


key: spec

description: Spec defines a specification for an "helmchart" resource parsed from an updatecli manifest file


key: file

description:
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"


key: key

description:
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.


key: name

description:
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"


key: url

description:
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/


key: value

description:
value is the value associated with a yamlpath query.

		compatible:
			* condition
			* target


key: version

description:
version defines the Chart version. It is used by condition to check if a version exists on the registry.

		compatible:
			* condition


key: versionincrement

description:
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


key: appversion

description:
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


key: versionfilter

description:
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.


key: kind

description: specifies the version kind such as semver, regex, or latest


description: specifies the version pattern according the version kind


key: strict

description: strict enforce strict versioning rule. Only used for semantic versioning at this time


key: username

description:
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


key: password

description:
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


key: token

description:
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


key: scmid

description: scmid specifies the scm configuration key associated to the current resource


key: dependson

description: dependson specifies which resources must be executed before the current one


description: name specifies the resource name


key: transformers

description: transformers defines how the default input value need to be transformed


key: items

description: Transformer holds a transformer rule


key: addprefix

description: AddPrefix adds a prefix to the transformer input value


key: addsuffix

description: AddSuffix adds a suffix to the transformer input value


key: trimprefix

description: TrimPrefix removes a prefix to the transformer input value


key: trimsuffix

description: TrimSuffix removes the suffix from the transformer input value


key: replacers

description: Replacers specifies a list of replacer instruction


description: Replacer is struct used to feed strings.Replacer


key: from

description: From defines the source value which need to be replaced


key: to

description: To defines the "to what" a "from" value needs to be replaced


key: replacer

description: Replacer specifies what value needs to be changed and how


key: find

description: Find searches for a specific value if it exists and return false if it doesn't


key: findsubmatch

description: Find searches for a specific value if it exists then return the value using regular expression


key: pattern

description: Pattern defines regular expression to use for retrieving a submatch


key: captureindex

description: 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`.


key: semverinc

description: SemvVerInc specifies a  comma separated list semantic versioning component that needs to be upgraded.


key: spec

description: Spec defines settings used to interact with Gitea release


key: url

description: "url" defines the Gitea url to interact with


key: username

description: "username" defines the username used to authenticate with Gitea API


key: token

description: "token" specifies the credential used to authenticate with Gitea API


key: owner

description: [S][C] Owner specifies repository owner


key: repository

description: [S][C] Repository specifies the name of a repository for a specific owner


key: versionfilter

description: [S][C] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest.


key: kind

description: specifies the version kind such as semver, regex, or latest


description: specifies the version pattern according the version kind


key: strict

description: strict enforce strict versioning rule. Only used for semantic versioning at this time


key: tag

description: [S] Tag defines the Gitea tag .


key: scmid

description: scmid specifies the scm configuration key associated to the current resource


key: dependson

description: dependson specifies which resources must be executed before the current one


key: name

description: name specifies the resource name


key: transformers

description: transformers defines how the default input value need to be transformed


key: items

description: Transformer holds a transformer rule


key: addprefix

description: AddPrefix adds a prefix to the transformer input value


key: addsuffix

description: AddSuffix adds a suffix to the transformer input value


key: trimprefix

description: TrimPrefix removes a prefix to the transformer input value


key: trimsuffix

description: TrimSuffix removes the suffix from the transformer input value


key: replacers

description: Replacers specifies a list of replacer instruction


description: Replacer is struct used to feed strings.Replacer


key: from

description: From defines the source value which need to be replaced


key: to

description: To defines the "to what" a "from" value needs to be replaced


key: replacer

description: Replacer specifies what value needs to be changed and how


key: find

description: Find searches for a specific value if it exists and return false if it doesn't


key: findsubmatch

description: Find searches for a specific value if it exists then return the value using regular expression


key: pattern

description: Pattern defines regular expression to use for retrieving a submatch


key: captureindex

description: 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`.


key: semverinc

description: SemvVerInc specifies a  comma separated list semantic versioning component that needs to be upgraded.


key: spec

description: Spec defines settings used to interact with GitLab release


key: url

description:
"url" defines the GitLab url to interact with

		default:
			url defaults to "gitlab.com"


key: username

description: "username" defines the username used to authenticate with GitLab


key: token

description: "token" defines the credential used to authenticate with GitLab


key: owner

description: [S][C][T] Owner specifies repository owner


key: repository

description: [S][C][T]Repository specifies the name of a repository for a specific owner


key: versionfilter

description: [S] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest.


key: kind

description: specifies the version kind such as semver, regex, or latest


description: specifies the version pattern according the version kind


key: strict

description: strict enforce strict versioning rule. Only used for semantic versioning at this time


key: title

description: [T] Title defines the GitLab release title.


key: tag

description: [C][T] Tag defines the GitLab release tag.


key: commitish

description: [T] Commitish defines the commit-ish such as `main`


key: description

description: [T] Description defines if the new release description


key: draft

description: [T] Draft defines if the release is a draft release


key: prerelease

description: [T] Prerelease defines if the release is a pre-release release


key: scmid

description: scmid specifies the scm configuration key associated to the current resource


key: dependson

description: dependson specifies which resources must be executed before the current one


key: name

description: name specifies the resource name


key: transformers

description: transformers defines how the default input value need to be transformed


key: items

description: Transformer holds a transformer rule


key: addprefix

description: AddPrefix adds a prefix to the transformer input value


key: addsuffix

description: AddSuffix adds a suffix to the transformer input value


key: trimprefix

description: TrimPrefix removes a prefix to the transformer input value


key: trimsuffix

description: TrimSuffix removes the suffix from the transformer input value


key: replacers

description: Replacers specifies a list of replacer instruction


description: Replacer is struct used to feed strings.Replacer


key: from

description: From defines the source value which need to be replaced


key: to

description: To defines the "to what" a "from" value needs to be replaced


key: replacer

description: Replacer specifies what value needs to be changed and how


key: find

description: Find searches for a specific value if it exists and return false if it doesn't


key: findsubmatch

description: Find searches for a specific value if it exists then return the value using regular expression


key: pattern

description: Pattern defines regular expression to use for retrieving a submatch


key: captureindex

description: 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`.


key: semverinc

description: SemvVerInc specifies a  comma separated list semantic versioning component that needs to be upgraded.


key: spec

description: Spec defines a specification for a "Golang" resource parsed from an updatecli manifest file


key: file

description: File defines the go.mod file, default to "go.mod"


key: module

description: Module defines the module path


key: indirect

description: Indirect specifies if we manipulate an indirect dependency


key: version

description: Version Defines a specific golang version


key: scmid

description: scmid specifies the scm configuration key associated to the current resource


key: dependson

description: dependson specifies which resources must be executed before the current one


key: name

description: name specifies the resource name


key: transformers

description: transformers defines how the default input value need to be transformed


key: items

description: Transformer holds a transformer rule


key: addprefix

description: AddPrefix adds a prefix to the transformer input value


key: addsuffix

description: AddSuffix adds a suffix to the transformer input value


key: trimprefix

description: TrimPrefix removes a prefix to the transformer input value


key: trimsuffix

description: TrimSuffix removes the suffix from the transformer input value


key: replacers

description: Replacers specifies a list of replacer instruction


description: Replacer is struct used to feed strings.Replacer


key: from

description: From defines the source value which need to be replaced


key: to

description: To defines the "to what" a "from" value needs to be replaced


key: replacer

description: Replacer specifies what value needs to be changed and how


key: find

description: Find searches for a specific value if it exists and return false if it doesn't


key: findsubmatch

description: Find searches for a specific value if it exists then return the value using regular expression


key: pattern

description: Pattern defines regular expression to use for retrieving a submatch


key: captureindex

description: 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`.


key: semverinc

description: SemvVerInc specifies a  comma separated list semantic versioning component that needs to be upgraded.


key: spec

description: Spec defines a specification for a "jenkins" resource parsed from an updatecli manifest file


key: release

description: [s][c] Defines the release name. It accepts "stable" or "weekly"


key: version

description: [s][c] Defines a specific release version (condition only)


key: scmid

description: scmid specifies the scm configuration key associated to the current resource


key: dependson

description: dependson specifies which resources must be executed before the current one


key: name

description: name specifies the resource name


key: transformers

description: transformers defines how the default input value need to be transformed


key: items

description: Transformer holds a transformer rule


key: addprefix

description: AddPrefix adds a prefix to the transformer input value


key: addsuffix

description: AddSuffix adds a suffix to the transformer input value


key: trimprefix

description: TrimPrefix removes a prefix to the transformer input value


key: trimsuffix

description: TrimSuffix removes the suffix from the transformer input value


key: replacers

description: Replacers specifies a list of replacer instruction


description: Replacer is struct used to feed strings.Replacer


key: from

description: From defines the source value which need to be replaced


key: to

description: To defines the "to what" a "from" value needs to be replaced


key: replacer

description: Replacer specifies what value needs to be changed and how


key: find

description: Find searches for a specific value if it exists and return false if it doesn't


key: findsubmatch

description: Find searches for a specific value if it exists then return the value using regular expression


key: pattern

description: Pattern defines regular expression to use for retrieving a submatch


key: captureindex

description: 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`.


key: semverinc

description: SemvVerInc specifies a  comma separated list semantic versioning component that needs to be upgraded.


key: spec

description: Spec contains the updatecli configuration provided by users.


key: accesskey

description: accesskey specifies the aws access key which combined with `secretkey`, is one of the way to authenticate


key: secretkey

description: secretkey specifies the aws secret key which combined with `accesskey`, is one of the way to authenticate


key: filters

description: Filters specifies a list of AMI filters


key: items

description: Filter represents the updatecli configuration describing AMI filters.


key: name

description: Name specifies a filter name.


key: values

description: Values specifies a filter value for a specific filter name.


key: region

description: Region specifies the AWS region to use when looking for AMI


key: endpoint

description: Endpoint specifies the AWS endpoint to use when looking for AMI


key: dryrun

description: Dryrun allows to Check whether you have the required permissions for the action.


key: sortby

description: Sortby specifies the order of AMI-ID that will be used to retrieve the last element such as `creationdateasc`


key: scmid

description: scmid specifies the scm configuration key associated to the current resource


key: dependson

description: dependson specifies which resources must be executed before the current one


description: name specifies the resource name


key: transformers

description: transformers defines how the default input value need to be transformed


description: Transformer holds a transformer rule


key: addprefix

description: AddPrefix adds a prefix to the transformer input value


key: addsuffix

description: AddSuffix adds a suffix to the transformer input value


key: trimprefix

description: TrimPrefix removes a prefix to the transformer input value


key: trimsuffix

description: TrimSuffix removes the suffix from the transformer input value


key: replacers

description: Replacers specifies a list of replacer instruction


description: Replacer is struct used to feed strings.Replacer


key: from

description: From defines the source value which need to be replaced


key: to

description: To defines the "to what" a "from" value needs to be replaced


key: replacer

description: Replacer specifies what value needs to be changed and how


key: find

description: Find searches for a specific value if it exists and return false if it doesn't


key: findsubmatch

description: Find searches for a specific value if it exists then return the value using regular expression


key: pattern

description: Pattern defines regular expression to use for retrieving a submatch


key: captureindex

description: 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`.


key: semverinc

description: SemvVerInc specifies a  comma separated list semantic versioning component that needs to be upgraded.


key: file

description: [s][c][t] File specifies the csv file


key: files

description: [c][t] Files specifies a list of Json file to manipulate


key: key

description: [s][c][t] Key specifies the csv query


key: query

description: [s][c][t] Query allows to used advanced query. Override the parameter key


key: value

description: [s][c][t] Key specifies the csv value, default to source output


key: comma

description: [s][c][t] Comma specifies the csv separator character, default ","


key: comment

description: [s][c][t] Comma specifies the csv comment character, default "#"


key: versionfilter

description: [s]VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest.