Description

The updatecli Autodiscovery plugin allows to automatically search and update container tags defined in Updatecli.yaml files.

Manifests

Parameters

NameTypeDescriptionRequired
authsobjectAuths provides a map of registry credentials where the key is the registry URL without scheme
    passwordstring

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
    tokenstring

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
    usernamestring

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
filesarray

Files allows to specify a list of Files to analyze.

The pattern syntax is:

    pattern:
      { term }
    term:
      '*'         matches any sequence of non-Separator characters
      '?'         matches any single non-Separator character
      '[' [ '^' ] { character-range } ']' character class (must be non-empty)
      c           matches character c (c != '*', '?', '\\', '[')
      '\\' c      matches character c

  character-range:
  	c           matches character c (c != '\\', '-', ']')
      '\\' c      matches character c
      lo '-' hi   matches character c for lo <= c <= hi
 Match requires pattern to match all of name, not just a substring.
 The only possible returned error is ErrBadPattern, when pattern
 is malformed.

 On Windows, escaping is disabled. Instead, `\\` is treated as
 path separator.
ignorearrayIgnore allows to specify rule to ignore autodiscovery a specific Updatecli based on a rule
    pathstringPath specifies a Updatecli compose filepath pattern, the pattern requires to match all of name, not just a subpart of the path.
    policiesobjectPolicies specifies a Updatecli policy
onlyarrayOnly allows to specify rule to only autodiscovery manifest for a specific Updatecli based on a rule
    pathstringPath specifies a Updatecli compose filepath pattern, the pattern requires to match all of name, not just a subpart of the path.
    policiesobjectPolicies specifies a Updatecli policy
rootdirstringrootdir defines the root directory used to recursively search for Updatecli manifest
versionfilterobject

versionfilter provides parameters to specify the version pattern used when generating manifest.

kind - semver versionfilter of kind semver uses semantic versioning as version filtering pattern accepts one of: prerelease - Updatecli tries to identify the latest prerelease whatever it means patch - Updatecli only handles patch version update minor - Updatecli handles patch AND minor version update minoronly - Updatecli handles minor version only major - Updatecli handles patch, minor, AND major version update majoronly - Updatecli only handles major version update a version constraint such as >= 1.0.0

kind - regex versionfilter of kind regex uses regular expression as version filtering pattern accepts a valid regular expression

example:

  versionfilter:
    kind: semver
    pattern: minor

and its type like regex, semver, or just latest.

More examples can be found at https://www.updatecli.io/docs/core/versionfilter/

    kindstringspecifies the version kind such as semver, regex, or latest
    patternstringspecifies the version pattern according the version kind for semver, it is a semver constraint for regex, it is a regex pattern for time, it is a date format
    regexstringspecifies the regex pattern, used for regex/semver and regex/time. Output of the first capture group will be used.
    replaceallobjectreplaceAll applies a regex replacement to version strings before filtering. This is useful for transforming versions (e.g., curl-8_15_0 to curl-8.15.0) before regex extraction.
        patternstringPattern specifies the regex pattern to match for replacement
        replacementstringReplacement specifies the replacement string (supports $1, $2, etc. for captured groups)
    strictbooleanstrict enforce strict versioning rule. Only used for semantic versioning at this time
⚠ This table is generated from the Updatecli codebase and may contain inaccurate data. Feel free to report them on github.com/updatecli/updatecli

Example

# updatecli.d/default.yaml
name: "Updatecli Autodiscovery"
scms:
  default:
    kind: git 
    spec:
      url: https://github.com/updatecli/website.git
      branch: master
       
autodiscovery:
  scmid: default
  crawlers:
    updatecli:
      versionfilter:
        kind: semver
        pattern: majoronly