Core on

Configuration

Tue, 13 Oct 2020 15:21:01 +0200

Updatecli requires a configuration file, or "manifest", which describes the update pipeline. A manifest describes the "what", the "when", and the "where" of the update pipeline.

Source

Sat, 09 Jan 2021 15:21:01 +0200

Description

The "source" stage retrieves information from a third "resource" like a file, or an API and then uses that information in later stages.

Condition

Sat, 09 Jan 2021 15:21:01 +0200

Description

A "condition" stage defines whether to run the "Target" stage stage of a pipeline. It runs a check (depending on the resource kind) that returns a boolean indicating its success (true) or failure (false).

Target

Sat, 09 Jan 2021 15:21:01 +0200

Description

The "target" stage applies the value retrieved by a source to a "resource", such as a file in a Git repository. It is the only stage allowed to modify something, and it runs only once every condition succeeded.

Action

Fri, 11 Apr 2025 15:21:01 +0200

Description

An Updatecli action defines what happens after a change is detected and validated. While Updatecli’s sources find changes (like a new version), and targets define where to apply them (like a file), actions describe what to do next, such as creating a pull request.

Scm

Sat, 09 Jan 2021 15:21:01 +0200

Description

An scm configuration provides the git repository information used by a source, a condition, a target, an action, or autodiscovery.

When an updatecli pipeline is triggered, the first thing updatecli does, is clone all referenced git repositories into a temporary directory. Resources referencing that scm through their scmid key then operate on the clone rather than on the current working directory, and a target that changes a file there gets its change committed and pushed to a branch named after the pipeline pipelineid.

Transformer

Sat, 09 Jan 2021 15:21:01 +0200

Description

The "transformers" parameter can be used by any stage definition as a "source", "condition", or "target". A "transformers" object contains a list of transformers. Each kind of transformer rules applies a string manipulation like adding or removing characters.

Version Filter

Mon, 01 Jan 0001 00:00:00 +0000

Description

Most sources do not return a single value: a Docker registry returns every tag of an image, a GitHub repository every release, a package registry every published version. The versionfilter key decides which one of them the source actually returns.

Manifest Order

Wed, 15 Apr 2026 07:21:01 +0200

Description

Updatecli orders execution at two different levels:

between manifests, with the root keys id and dependson, described on this page
between the resources of one manifest, with the resource key dependson, described in Resource ordering

Labels

Mon, 01 Jan 0001 00:00:00 +0000

Overview

Pipeline labels are arbitrary key/value pairs attached to a pipeline manifest that allow you to categorize, organize, and filter pipelines during execution and reporting.