Cargo

kind: cargo

Description

The cargo crawler looks recursively for all cargo crates from a specific root directory. Then for each of them, it tries to update dependencies specified in Cargo.toml.

This crawler can be enabled either automatically with default behavior by running updatecli diff --experimental from a directory containing the files to update. Or by providing a manifest.

Manifests

Parameters

The crawler cargo supports the following parameters:

Name Type Description Required
ignore array Ignore specifies rule to ignore Cargo.toml update.
    crates object Crates specifies the list of Cargo crates to check
    path string Path specifies a Cargo crate path pattern, the pattern requires to match all of name, not just a subpart of the path.
    registries array Registries specifies the list of Cargo registries to check
only array Only specify required rule to restrict Cargo.toml update.
    crates object Crates specifies the list of Cargo crates to check
    path string Path specifies a Cargo crate path pattern, the pattern requires to match all of name, not just a subpart of the path.
    registries array Registries specifies the list of Cargo registries to check
registries object Auths provides a map of registry credentials where the key is the registry URL without scheme
    auth object [A][S][C] Auth specifies the cargo registry auth to use for authentication.
        headerformat string [A][S][C] HeaderFormat specifies the cargo registry header format to use for authentication (defaults to Bearer).
        token string [A][S][C] Token specifies the cargo registry token 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.
rootdir string RootDir defines the root directory used to recursively search for Cargo.toml
versionfilter object

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/
    kind string specifies the version kind such as semver, regex, or latest
    pattern string specifies 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
    regex string specifies the regex pattern, used for regex/semver and regex/time. Output of the first capture group will be used.
    replaceall object replaceAll 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.
        pattern string Pattern specifies the regex pattern to match for replacement
        replacement string Replacement specifies the replacement string (supports $1, $2, etc. for captured groups)
    strict boolean strict 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: "Cargo compose autodiscovery using git scm"
scms:
  default:
    kind: git
    spec:
      url: https://github.com/updatecli-test/cargo-lab.git
      branch: "main"
  private-registry:
    kind: git
    spec:
      url: "https://github.com/updatecli-test/fake-cargo-registry.git"
      branch: "main"

autodiscovery:
  scmid: default
  crawlers:
    cargo:
      registries:
        fake-private-git:
          scmid: private-registry
        fake-private-http:
          url: "https://updatecli-test.github.io/fake-cargo-registry/api/v1/crates"
Last modified on February 15, 2024
Edit this page on GitHub
← Bazel
Docker Compose →