Updatecli on

Introduction

Fri, 07 Aug 2026 10:00:00 +0200

Description

An Updatecli run prints its result to the console, and the result is lost unless the CI logs are kept. Udash stores it. At the end of a run, Updatecli publishes each pipeline’s report to Udash, and the interface lets you look at every repository at once, filter by label or by result, and follow how a dependency moved over the past weeks.

Warning

Udash is experimental, on both sides. Publishing reports from Updatecli requires the --experimental flag, and the API and the interface can change without going through the deprecation cycle described on the "Deprecations" page.

Github Search

Thu, 23 Oct 2025 20:21:01 +0200

Description

githubsearch is not an scm you clone from - it is a generator. Before anything else runs, Updatecli sends your query to the GitHub repository search API, lists the branches of every repository it finds, keeps the branches matching branch, and turns each surviving repository/branch pair into a regular github scm.

Your manifest is then duplicated once per pair, each copy pinned to one repository and one branch. Ten matches mean ten pipelines, ten working branches, and (if the manifest declares a github/pullrequest action) ten pull requests. Everything the github scm documentation says about cloning, working branches, commits, and signing applies unchanged to each copy.

This makes githubsearch the way to roll one change across an organisation without listing its repositories by hand.

Its behavior depends on the stage referencing it:

source and condition: Each discovered repository is cloned and the resource works on the files from the matched branch. Nothing is pushed.
target: Updatecli creates a working branch in each discovered repository, commits the changes there, and pushes it.

Important

Like the github scm, this plugin does not open pull requests. That is the job of an actions block of kind github/pullrequest, documented on the "GitHub Pull Request" page.

Amazon AMI

Fri, 01 Oct 2021 10:39:00 +0200

source	condition	target
✔	✔	✗

source

condition

target

✔

✗

Description

The aws/ami resource queries the EC2 API for Amazon Machine Images matching a set of filters.

source: Returns the AMI ID of the first image in the sorted result set.
condition: Tests that at least one AMI matches the filters.
target: Not supported - an AMI is not something Updatecli publishes. A target fails with Target not supported for the plugin AWS/AMI.

Important

Unlike most resources, which merely ignore an scm, this one aborts a condition that has one attached:

condition with SCM is not supported

Drop the scmid from the condition; the lookup is always against the EC2 API.

Github

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

Description

The github scm plugin clones a GitHub repository locally so that other resources can read from it, and pushes changes back to it. It is referenced by a resource through its scmid, as described on the "SCM" page.

Its behavior depends on the stage referencing it:

source and condition: The repository is cloned and the resource works on the files from the branch defined by branch. Nothing is pushed.
target: Updatecli creates a working branch based on branch, commits the changes to it, and pushes that branch to the remote. The branch value itself is never modified.

Important

This plugin does not open pull requests. Pushing a working branch and opening a pull request are two distinct steps: the pull request is created by an actions block of kind github/pullrequest, documented on the "GitHub Pull Request" page. Without such an action, the working branch is pushed and nothing else happens.

If you only need to read from GitHub without cloning a repository (for instance the latest release of a project), use a resource such as githubrelease instead of an scm.

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.

Quick start

Fri, 07 Aug 2026 10:00:00 +0200

Description

This page runs Udash locally, then publishes a report to it from your own Updatecli runs. Nothing is authenticated, so do not expose this setup to anyone else.

Requirement

Docker and Docker Compose
Updatecli, see Installation

Bazelmod

Mon, 02 Feb 2026 12:00:00 +0200

source	condition	target
✔	✔	✔

source

condition

target

✔

Description

The bazelmod resource reads and writes the version of one dependency in a MODULE.bazel file, the bazel_dep entries of Bzlmod:

bazel_dep(name = "rules_python", version = "0.27.0")
bazel_dep(name = "gazelle", version = "0.35.0")

source: Returns the version currently pinned for module.
condition: Checks that the file pins the expected version.
target: Updates that version. A file already holding it is left untouched.

It is the local half of the pair: bazelregistry finds the version available upstream, bazelmod writes it into your repository.

GitLab Search

Thu, 23 Oct 2025 20:21:01 +0200

Description

gitlabsearch is not an scm you clone from - it is a generator. Before anything else runs, Updatecli lists the projects of the configured GitLab group, lists the branches of each of them, keeps the branches matching branch, and turns each surviving project/branch pair into a regular gitlab scm.

Your manifest is then duplicated once per pair, each copy pinned to one project and one branch. Ten matches mean ten pipelines, ten working branches, and (if the manifest declares a gitlab/mergerequest action) ten merge requests. Everything the gitlab documentation says about cloning, working branches, commits, and signing applies unchanged to each copy.

Its behavior depends on the stage referencing it:

source and condition: Each discovered project is cloned and the resource works on the files from the matched branch. Nothing is pushed.
target: Updatecli creates a working branch in each discovered project, commits the changes there, and pushes it.

Important

Like the gitlab scm, this plugin does not open merge requests (that is the job of an actions block of kind gitlab/mergerequest, documented on the "GitLab Merge Request" page).

Gitea

Mon, 25 Jul 2022 18:31:01 +0200

Description

The gitea scm plugin clones a repository hosted on a Gitea instance and pushes changes back to it. It is referenced by a resource through its scmid, as described on the "SCM" page.

Its behavior depends on the stage referencing it:

source and condition: The repository is cloned and the resource works on the files from the branch defined by branch. Nothing is pushed.
target: Updatecli creates a working branch based on branch, commits the changes to it, and pushes that branch. The branch value itself is left untouched.

Important

This plugin does not open pull requests. Pushing a working branch and opening a pull request are two distinct steps: the pull request comes from an actions block of kind gitea/pullrequest, documented on the "Gitea Pull Request" page. Without such an action, the branch is pushed and nothing else happens.

GitLab

Mon, 25 Jul 2022 18:31:01 +0200

Description

The gitlab scm plugin clones a repository hosted on GitLab (gitlab.com or a self-managed instance) and pushes changes back to it. It is referenced by a resource through its scmid, as described on the "SCM" page.

Its behavior depends on the stage referencing it:

source and condition: The repository is cloned and the resource works on the files from the branch defined by branch. Nothing is pushed.
target: Updatecli creates a working branch based on branch, commits the changes to it, and pushes that branch. The branch value itself is left untouched.

Important

This plugin does not open merge requests. Pushing a working branch and opening a merge request are two distinct steps: the merge request comes from an actions block of kind gitlab/mergerequest, documented on the "GitLab Merge Request" page. Without such an action, the branch is pushed and nothing else happens.