renovate/renovate
1
0
Fork 0
mirror of https://github.com/renovatebot/renovate.git synced 2025-01-12 06:56:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 7
renovate/docs/usage/rust.md
Tom Fay 2a72f85cc2
feat(manager/cargo): support private registry index env var (#20379) 
Co-authored-by: Rhys Arkins <rhys@arkins.net>
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Co-authored-by: Sebastian Poxhofer <secustor@users.noreply.github.com>
2023-04-18 08:49:24 +00:00

1.8 KiB
Raw Blame History

title description
Rust crates Rust crates support in Renovate

Automated Dependency Updates for Rust crates

Renovate supports upgrading dependencies in Cargo.toml files and their accompanying Cargo.lock checksums.

How it works

  1. Renovate searches in each repository for any Cargo.toml files
  2. Renovate extracts existing dependencies from [dependencies], [dev-dependencies], [build-dependencies] and [workspace.dependencies]
  3. Renovate looks up Cargo configuration to find index URLs for private registries
  4. Renovate resolves the dependency's version using the crates.io API or by cloning the index URL
  5. If Renovate finds an update, Renovate will use cargo update to update both Cargo.toml and Cargo.lock

Enabling Rust Modules Updating

Renovate updates Rust crates by default.

Cargo configuration and private registry discovery

Renovate can find private registry URLs in these Cargo configuration files:

  • .cargo/config.toml
  • .cargo/config (legacy)

Renovate can also find private registry URLs via a CARGO_REGISTRIES_<name>_INDEX environment variable. Read the Rust environment variables docs to learn more.

Private crate registries and private Git dependencies

If any dependencies are hosted in private Git repositories, Git Authentication for cargo must be set up.

If any dependencies are hosted on private crate registries (i.e., not on crates.io), then credentials should be set up in such a way that the Git command-line is able to clone the registry index. Third-party crate registries usually provide instructions to achieve this.

Both of these are currently only possible when running Renovate self-hosted.