cargopackage

kind: cargopackage

source	condition	target
✔	✔	✗

source

condition

target

✔

✗

source

The cargopackage "source" retrieves the latest version of a cargo package matching a specific version filter.

condition

The cargopackage "condition" test that a specific version is published on a cargo registry.

target

The cargopackage "target" is not supported as we couldn’t think about a useful usecase. Feel free to open an issue suggesting one.

Parameter

Name	Type	Description
package	string	[S][C] Package specifies the name of the package
registry	object	[S][C] Registry specifies the registry to use
auth	object	[A][S][C] Auth specifies the cargo registry auth to use for authentication.
rootdir	string	[A][S][C] RootDir specifies the cargo registry root directory to use as FS index.
scmid	string	[A] SCMID specifies the cargo registry scmId to use as FS index.
url	string	[A][S][C] URL specifies the cargo registry URL to use for authentication.
version	string	[C] Defines a specific package version
versionfilter	object	[S] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest.
kind	string	specifies the version kind such as semver, regex, or latest
pattern	string	specifies the version pattern according the version kind
strict	boolean	strict enforce strict versioning rule. Only used for semantic versioning at this time

Example

# updatecli.yaml
name: Retrieve the latest Cargo Package Version

scms:
  private-registry:
    kind: git
    spec:
      url: "https://github.com/updatecli-test/fake-cargo-registry.git"
      branch: "main"

sources:
  rand:
    name: Get latest rand version from public cargo registry
    kind: cargopackage
    spec:
      package: rand
  test-crate-2:
    name: Get latest test-crate-2 version from private cargo registry
    kind: cargopackage
    scmid: private-registry
    spec:
      package: test-crate-2
      versionfilter:
        kind: semver
        pattern: ~0

conditions:
  existing-package-private-reg:
    name: Test if test-crate-2 0.1.0 exists on private registry
    kind: cargopackage
    disablesourceinput: true
    scmid: private-registry
    spec:
      package: test-crate-2
      version: 0.1.0
  existing-package-not-existing-version-private-reg:
    name: Test if test-crate-2 0.6.0 does not exists on private registry
    kind: cargopackage
    disablesourceinput: true
    scmid: private-registry
    failwhen: true
    spec:
      package: test-crate-2
      version: 0.6.0
  non-existing-package-private-reg:
    name: Test if non-existing-test-crate 0.1.0 does not exists on private registry
    kind: cargopackage
    disablesourceinput: true
    scmid: private-registry
    failwhen: true
    spec:
      package: non-existing-test-crate
      version: 0.1.0
  existing-package-public-reg:
    name: Test if rand version exists on public reg
    kind: cargopackage
    disablesourceinput: true
    spec:
      package: rand
      version: 0.7.2
  existing-package-p-not-existing-version-public-reg:
    name: Test if rand version 99.99.99 does not exists on public reg
    kind: cargopackage
    disablesourceinput: true
    failwhen: true
    spec:
      package: rand
      version: 99.99.99
  non-existing-package-public-reg:
    name: Test if non-existing-package-to-be-sure-123456 does exists on public reg
    kind: cargopackage
    disablesourceinput: true
    failwhen: true
    spec:
      package: non-existing-package-to-be-sure-123456
      version: 0.7.2

targets:
  # Targets are not supported

Last modified on August 11, 2023

Edit this page on GitHub