Updatecli

https://www.updatecli.io/docs/
Admin
Updatecli is a declarative update automation tool that helps manage and update dependencies,...
Tokens:289,188
Snippets:2,595
Trust Score:7.6
Update:3 days ago
Show doc for...
Tokens:
Raw
### Kind configuration example

Source: https://www.updatecli.io/docs/plugins/autodiscovery/cargo

Example of setting the versioning scheme to semver.

```yaml
  * kind: semver
```

--------------------------------

### Install on openSUSE

Source: https://www.updatecli.io/docs/prologue/installation

Install the .rpm package using zypper.

```bash
# amd64
sudo zypper install https://github.com/updatecli/updatecli/releases/download/v0.122.1/updatecli_amd64.rpm

# arm64
sudo zypper install https://github.com/updatecli/updatecli/releases/download/v0.122.1/updatecli_arm64.rpm

# armv6
sudo zypper install https://github.com/updatecli/updatecli/releases/download/v0.122.1/updatecli_armv6.rpm
```

--------------------------------

### Install on Debian and Ubuntu

Source: https://www.updatecli.io/docs/prologue/installation

Download and install the .deb package for your architecture. Note that apt install requires a file path.

```bash
# amd64
curl -sSL -o /tmp/updatecli_amd64.deb https://github.com/updatecli/updatecli/releases/download/v0.122.1/updatecli_amd64.deb
sudo apt install /tmp/updatecli_amd64.deb

# arm64
curl -sSL -o /tmp/updatecli_arm64.deb https://github.com/updatecli/updatecli/releases/download/v0.122.1/updatecli_arm64.deb
sudo apt install /tmp/updatecli_arm64.deb

# armv6
curl -sSL -o /tmp/updatecli_armv6.deb https://github.com/updatecli/updatecli/releases/download/v0.122.1/updatecli_armv6.deb
sudo apt install /tmp/updatecli_armv6.deb
```

--------------------------------

### Example of updatecli udash config

Source: https://www.updatecli.io/docs/commands/updatecli_udash_config

A simple example showing how to run the command.

```bash
updatecli udash config
```

--------------------------------

### Pattern configuration examples

Source: https://www.updatecli.io/docs/plugins/autodiscovery/cargo

Examples of various pattern configurations for version matching.

```yaml
  * pattern: ~1.2
  * pattern: “>=1.0.0 <2.0.0”
  * pattern: ^v\d+.\d+.\d+$
```

--------------------------------

### Gitea URL Parameter Examples

Source: https://www.updatecli.io/docs/plugins/resource/giteatag

Examples for configuring the Gitea instance URL.

```yaml
url: gitea.com
url: https://gitea.example.com
```

--------------------------------

### Gitea Repository Parameter Example

Source: https://www.updatecli.io/docs/plugins/resource/giteatag

Example configuration for the repository parameter.

```yaml
repository: updatecli
```

--------------------------------

### Install on Arch Linux

Source: https://www.updatecli.io/docs/prologue/installation

Install the binary package from the AUR using yay.

```bash
yay -S updatecli-bin
```

--------------------------------

### Example bazelregistry source configuration

Source: https://www.updatecli.io/docs/plugins/resource/bazelregistry

Example configuration for a source that gets the latest version of the rules_python Bazel module using a semver filter with pattern '>=0.25.0'.

```yaml
sources:
  rules_python:
    name: Get latest version of Bazel module rules_python
    kind: bazelregistry
    spec:
      module: rules_python
      versionfilter:
        kind: semver
        pattern: '>=0.25.0'
```

--------------------------------

### Jaeger Local Setup and Execution

Source: https://www.updatecli.io/docs/core/telemetry

Start a local Jaeger instance and run Updatecli with the gRPC endpoint to automatically infer OTLP tracing.

```bash
docker run --rm -p 4317:4317 -p 16686:16686 \
  jaegertracing/all-in-one:latest
```

```bash
OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4317 updatecli pipeline apply --config manifest.yaml
```

--------------------------------

### Example .ko.yaml configuration

Source: https://www.updatecli.io/docs/plugins/autodiscovery/ko

This file defines the default base image and specific overrides for application paths.

```yaml
# .ko.yaml
defaultBaseImage: gcr.io/distroless/static:nonroot
baseImageOverrides:
  github.com/example/cmd/app: gcr.io/distroless/base:debug
```

--------------------------------

### Updatecli manifest using bazelmod target

Source: https://www.updatecli.io/docs/plugins/resource/bazelmod

Example Updatecli manifest that gets the latest version of rules_python from bazelregistry and updates the MODULE.bazel file using bazelmod.

```yaml
sources:
  latest:
    name: Get the latest version of rules_python
    kind: bazelregistry
    spec:
      module: rules_python
targets:
  rules_python:
    name: Bump Bazel module rules_python
    kind: bazelmod
    sourceid: latest
    spec:
      file: project2/MODULE.bazel
      module: rules_python
```

--------------------------------

### GitHub Actions workflow for Updatecli

Source: https://www.updatecli.io/docs/automate/github_action

A complete workflow example that installs Updatecli, runs a dry-run diff, and applies updates using the specified configuration and values files.

```yaml
name: Updatecli

on:
  # Trigger Updatecli if a new commit land on the main branch
  push:
    branches: [main]
  # Trigger Updatecli if a pullrequest is open targeting the main branch.
  # This is useful to test Updatecli manifest change
  pull_request:
    branches: [main]
  # Manually trigger Updatecli via GitHub UI
  workflow_dispatch:
  # Trigger Updatecli once day by a cronjob
  schedule:
    # * is a special character in YAML so you have to quote this string
    # Run once a day
    - cron: "0 0 * * *"

permissions:
  # Required by Updatecli to create Git Commit(s)
  contents: "write"
  # Required by Updatecli to open GitHub pull request
  pull-requests: "write"
  # Required by Updatecli to update GitHub action workflows
  actions: "write"

jobs:
  updatecli:
    runs-on: "ubuntu-latest"
    steps:
      - name: Checkout
        uses: actions/checkout@v7.0.1

      - name: Install Updatecli in the runner
        uses: updatecli/updatecli-action@v3.9.0

      - name: Run Updatecli in Dry Run mode
        run: "updatecli diff --config ./updatecli/updatecli.d --values updatecli/values.yaml"
        env:
          UPDATECLI_GITHUB_USERNAME: "${{ github.actor }}"
          UPDATECLI_GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"

      - name: Run Updatecli in apply mode
        run: "updatecli apply --config ./updatecli/updatecli.d --values updatecli/values.yaml"
        env:
          UPDATECLI_GITHUB_USERNAME: "${{ github.actor }}"
          UPDATECLI_GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
```

--------------------------------

### Example .tool-versions file content

Source: https://www.updatecli.io/docs/plugins/resource/toolversions

Shows the format of a .tool-versions file with tool names and versions on each line.

```plaintext
nodejs 20.11.0
golang 1.22.0
terraform 1.7.4
```

--------------------------------

### Generic File Resource Configuration Examples

Source: https://www.updatecli.io/docs/plugins/resource/file

A comprehensive set of examples demonstrating various ways to define file sources and conditions, including local files, URLs, line matching, and pattern matching.

```yaml
sources:
  ContentFromLocalFile:
    kind: file
    spec:
      file: LICENSE
  ContentFromURL:
    kind: file
    spec:
      file: https://releases.hashicorp.com/terraform/0.14.5/terraform_0.14.5_SHA256SUMS
  LineFromLocalFile:
    kind: file
    spec:
      file: LICENSE
      line: 3
  LineFromURL:
    kind: file
    spec:
      file: https://releases.hashicorp.com/terraform/0.14.5/terraform_0.14.5_SHA256SUMS
      line: 3
  SingleLineFromFileWithPattern:
    kind: file
    spec:
      file: LICENSE
      matchpattern: 'Copyright.*' # Returns a single line
  MultipleLinesFromURLWithPattern:
    kind: file
    spec:
      file: https://releases.hashicorp.com/terraform/0.14.5/terraform_0.14.5_SHA256SUMS
      matchpattern: '.*terraform_.*_linux.*' # Returns a multi-line content as multiple lines are matched
conditions:
  LocalFileHasSameContentAsSource:
    kind: file
    sourceid: ContentFromLocalFile
    spec:
      file: LICENSE
  URLFileMatchesSpecifiedContent:
    kind: file
    disablesourceinput: true
    spec:
      file: https://get.helm.sh/helm-v3.5.0-darwin-amd64.tar.gz.sha256sum
      content: |
        53378d8de087395ece3876795111a8077f2451f080ec6150d777cc3105214520  helm-v3.5.0-darwin-amd64.tar.gz
  LocalFileHasLine:
    kind: file
    disablesourceinput: true
    spec:
      file: LICENSE
      line: 5 # The file './LICENSE' has a 5th line which is NOT empty
  URLFileHasLineMatchingSource:
    kind: file
    sourceid: LineFromURL
    spec:
      file: https://releases.hashicorp.com/terraform/0.14.5/terraform_0.14.5_SHA256SUMS
      line: 3 # The line 3 of the file matches the source LineFromURL
  LocalFileHasLineMatchingSource:
    kind: file
    sourceid: LineFromLocalFile
    spec:
      file: LICENSE
      line: 3 # The file './LICENSE' has a 3rd line which is NOT empty and matches the source LineFromLocalFile
  LocalFileHasLineMatchingCustomContent:
    kind: file
    disablesourceinput: true
    spec:
      file: LICENSE
      line: 3
      content: '{{ source `LineFromLocalFile` }}'
  LocalFileMatchesPattern:
    kind: file
    disablesourceinput: true
    spec:
      file: "LICENSE"
      matchpattern: 'Copyright \(c\) (\d*) Olblak'
```

--------------------------------

### Helm Chart Resource Configuration in updatecli.yaml

Source: https://www.updatecli.io/docs/plugins/resource/helm_chart

A complete configuration example for managing Helm chart resources, including SCM setup, source retrieval, version condition checking, and target version bumping.

```yaml
name: Example of Helm Chart resources

scms:
  default:
    kind: github
    spec:
      user: "john"
      email: "john@example.com"
      owner: "olblak"
      repository: "charts"
      token: "{{ requiredEnv .github.token }}"
      username: "john"
      branch: "master"

sources:
  lastRelease:
    kind: helmchart
    spec:
      url: https://charts.jenkins.io
      name: jenkins

conditions:
  isPrometheuseHelmChartVersionAvailable:
    name: "Test if the prometheus helm chart is available"
    kind: helmchart
    spec:
      url: https://prometheus-community.github.io/helm-charts
      name: prometheus
      version: "11.16.5"

targets:
  chartjenkins:
    name: Bump Jenkins Upstream Chart Version
    kind: helmchart
    spec:
      name: "charts/jenkins"
      file: "requirements.yaml"
      key: "dependencies[0].version"
      versionincrement: minor
```

--------------------------------

### Nomad autodiscovery configuration in updatecli.d/default.yaml

Source: https://www.updatecli.io/docs/plugins/autodiscovery/nomad

Example configuration for using the Nomad crawler within an Updatecli manifest. This setup includes SCM and action definitions to manage updates via GitHub pull requests.

```yaml
# updatecli.d/default.yaml
name: "Nomad autodiscovery using GitHub"
scms:
  default:
    kind: github
    spec:
      owner: updatecli-test
      repository: nomad-demo
      token: '{{ requiredEnv "GITHUB_TOKEN" }}'
      username: '{{ requiredEnv "GITHUB_ACTOR" }}'
      branch: master
 
actions:
  default:
    scmid: default
    kind: github/pullrequest
    spec:
      labels:
        - "dependencies"

autodiscovery:
  scmid: default
  actionid: default
  crawlers:
    nomad:
      ignore:
        - path: 'services/cache.nomad'
      #   jobs:
      #    -  traefik
      # only:
      #  # - path: <filepath relative from the scm repository>
      #      jobs: <Nomad job name to match>
      #      image: <docker image to match>
```

--------------------------------

### Jenkins Resource Configuration Example

Source: https://www.updatecli.io/docs/plugins/resource/jenkins

A complete configuration example demonstrating how to use the Jenkins resource to track weekly releases and update a Docker image tag in a YAML file.

```yaml
# updatecli.yaml
name: Example with Jenkins resource

scms:
  default:
    kind: git
    spec:
      url: "git@github.com:alice/example.git"
      branch: master
      user: alice
      email: alice@example.com

sources:
  lastWeeklyRelease:
    # Get latest jenkins weekly version with changelog from github
    kind: jenkins
    spec:
      release: weekly

conditions:
  # Test that a specific Jenkins version exists
  jenkinsVersion:
    kind: jenkins
    spec:
      version: "2.275"

  # Test that the version from source is a weekly release
  jenkinsWeekly:
    kind: jenkins
    spec:
      release: weekly

  # Test that our yaml file is correctly set to a jenkins image
  imageTag:
    name: "jenkins/jenkins docker image set"
    kind: yaml
    spec:
      file: "charts/jenkins/values.yaml"
      key: "jenkins.controller.image"
      value: "jenkins/jenkins"
    scmid: default

  # Test that there is a docker image with the correct tag
  # set to "<version>-jdk11"
  dockerimage:
    kind: dockerimage
    spec:
      image: jenkins/jenkins
    transformers:
      - addsuffix: "-jdk11"

targets:
  imageTag:
    name: "jenkins/jenkins docker tag"
    kind: yaml
    spec:
      file: "charts/jenkins/values.yaml"
      key: "jenkins.controller.tag"
    transformers:
      - addsuffix: "-jdk11"
    scmid: default
```

--------------------------------

### Temurin source and condition configuration example

Source: https://www.updatecli.io/docs/plugins/resource/temurin

Complete YAML example for configuring Temurin sources and conditions in updatecli. It demonstrates various spec options like releaseline, releasetype, featureversion, project, operatingsystem, architecture, imagetype, result, version, specificversion, and platforms. The example includes sources for latest LTS, feature release, EA builds, Valhalla project, installer URL, checksum URL, and signature URL, as well as conditions for checking Temurin availability and platform support.

```yaml
# updatecli.yaml
sources:
  ## Returns the latest LTS version
  getLatestLtsVersion:
    kind: temurin

  ## Returns the latest feature release
  getLatestFeatureVersion:
    kind: temurin
    spec:
      releaseline: feature

  ## Returns the latest LTS "nightly build" (Early Availability) version
  getLatestLtsEarlyAvailabilityVersion:
    kind: temurin
    spec:
      releaseline: lts
      releasetype: ea

  ## Returns the latest "Valhalla" Project JDK 17 version available for Windows
  getLatestWindowsValhalla17Version:
    kind: temurin
    spec:
      featureversion: 17
      project: valhalla
      operatingsystem: windows

  # Returns the latest installer URL for Linux x64
  getLatestLTSLinuxAMD64InstallerURL:
    kind: temurin
    spec:
      result: installer_url

  ## Returns the latest LTS Installer's checksum URL for s390x Alpine Linux JRE
  getLatestJRE17LinuxS390xChecksumUrl:
    kind: temurin
    spec:
      operatingsystem: alpine-linux
      architecture: s390x
      imagetype: jre
      result: checksum_url

  ## Returns latest Installer's Signature URL of the Windows JDK version "17.0.2*"
  getLatestCustomVersionWindowsSignatureUrl:
    kind: temurin
    spec:
      version: "17.0.2"
      operatingsystem: windows
      result: signature_url

conditions:
  checkLatestTemurin:
    name: Temurin Check
    kind: temurin
    disablesourceinput: true
  checkLatestTemurinGA17LinuxArm64:
    name: Temurin Check
    kind: temurin
    disablesourceinput: true
    spec:
      releaseline: feature
      releasetype: ga
      featureversion: 17
      architecture: aarch64
      operatingsystem: linux
  checkFromSpecifiedVersion:
    name: Temurin Check
    kind: temurin
    disablesourceinput: true
    spec:
      specificversion: '{{ source "getLastGA17Version" }}'
  checkListOfPlatforms:
    name: Temurin Check
    kind: temurin
    disablesourceinput: true
    spec:
      specificversion: 17.0.13+11 # Known to provide all existing platform specified below
      platforms:
        - linux/x64
        - linux/aarch64
        - linux/s390x
        - alpine-linux/x64
        - windows/x64
  checkPlatformForSourceInput:
    name: Temurin Check
    kind: temurin
    sourceid: getLatestLtsVersion
    spec:
      platforms:
        - linux/x64
        - linux/aarch64
```

--------------------------------

### Install Updatecli via Scoop

Source: https://www.updatecli.io/docs/prologue/installation

Use the Scoop command line installer to install Updatecli from the main bucket.

```bash
scoop install updatecli
```

--------------------------------

### Build the project

Source: https://www.updatecli.io/docs/help/contributing

Use the make build command to compile the project. Requires Go, GNU Make, and goreleaser.

```bash
make build
```

--------------------------------

### Install via Archive

Source: https://www.updatecli.io/docs/prologue/installation

Download the tarball, extract the binary, and move it to /usr/local/bin.

```bash
# amd64
curl -sSL -o /tmp/updatecli.tar.gz https://github.com/updatecli/updatecli/releases/download/v0.122.1/updatecli_Linux_x86_64.tar.gz

# arm64
curl -sSL -o /tmp/updatecli.tar.gz https://github.com/updatecli/updatecli/releases/download/v0.122.1/updatecli_Linux_arm64.tar.gz

# armv6
curl -sSL -o /tmp/updatecli.tar.gz https://github.com/updatecli/updatecli/releases/download/v0.122.1/updatecli_Linux_arm.tar.gz

tar -xzf /tmp/updatecli.tar.gz -C /tmp updatecli
sudo install -m 755 /tmp/updatecli /usr/local/bin/updatecli
```

--------------------------------

### After Parameter Example

Source: https://www.updatecli.io/docs/plugins/actions/github

Example showing the usage of the after parameter.

```yaml
after: 24h
```

--------------------------------

### Version configuration

Source: https://www.updatecli.io/docs/plugins/resource/golang

Example of specifying a Go version to check.

```yaml
  * version: 1.23.0
```

--------------------------------

### Configure environments and policies

Source: https://www.updatecli.io/docs/core/compose

Example of setting environment variables via keys and files, and defining policies in a compose file.

```yaml

environments:
  UPDATECLI_GITHUB_OWNER: updatecli

env_files:
  - .env

policies:
  - name: Local policies
    config:
      - updatecli/updatecli.d/
```

--------------------------------

### Example logout command

Source: https://www.updatecli.io/docs/commands/updatecli_udash_logout

An example of how to log out from the app.updatecli.io service.

```bash
updatecli udash logout app.updatecli.io
```

--------------------------------

### Gitea Tag Parameter Example

Source: https://www.updatecli.io/docs/plugins/resource/giteatag

Example configuration for the tag parameter.

```yaml
tag: v1.0.0
```

--------------------------------

### Shell Plugin Reference Configuration

Source: https://www.updatecli.io/docs/plugins/resource/shell

A comprehensive manifest example demonstrating shell sources, conditions, and targets.

```yaml
sources:
  newVersion:
    kind: shell
    name: Get new version
    spec:
      command: bash ./get-new-version.sh"
  failing:
    kind: shell
    name: Failing command
    spec:
      command: ls /foobar
conditions:
  checkIfVersionEquals123:
    kind: shell
    sourceId: newVersion
    spec:
      command: test 1.2.3 ==
targets:
  default:
    name: setGrepVersion
    sourceID: default
    kind: shell
    spec:
      command: bash apply.sh
```

--------------------------------

### Gitea Owner Parameter Example

Source: https://www.updatecli.io/docs/plugins/resource/giteatag

Example configuration for the owner parameter.

```yaml
owner: updatecli
```

--------------------------------

### Example Dockerfile for coordinate explanation

Source: https://www.updatecli.io/docs/plugins/resource/dockerfile

A sample Dockerfile used to illustrate the two-dimensional array representation. The first dimension lists instruction types (FROM, LABEL, LABEL), and the second dimension lists arguments for each instruction.

```dockerfile
FROM jenkins/jenkins:2.274
LABEL maintainer=olblak
LABEL version=2.274 \
      date = "2021/01/09"
```

--------------------------------

### Example package.json

Source: https://www.updatecli.io/docs/guides/npm

The initial package.json file for the npm project being tracked.

```json
{
  "name": "guide-npm",
  "version": "1.0.0",
  "description": "An Updatecli guide for npm project",
  "author": "Olivier Vernin",
  "dependencies": {
    "axios": "^1.20.0"
  }
}
```
Tokens:
Raw