move-language / move

Apache License 2.0
2.24k stars 676 forks source link

[tutorial] Advise using `--locked` in `cargo install` #1100

Open wiktor-k opened 4 months ago

wiktor-k commented 4 months ago

Hi :wave:

Motivation

This patch makes cargo use the lockfile for dependencies. Without that, at the time of writing this patch, the install fails with the following error:

error: failed to compile `move-cli v0.1.0 (/home/wiktor/src/open-source/move/language/tools/move-cli)`, intermediate artifacts can be found at `/home/wiktor/tmp/cargo`

Caused by:
  package `toml_datetime v0.6.5` cannot be built because it requires rustc 1.67 or newer, while the currently active rustc version is 1.65.0

See: https://github.com/rust-lang/cargo/issues/7169#issuecomment-514361495

Alternative solution would be upgrading Rust version but adding --locked to the tutorial is far less invasive.

Have you read the Contributing Guidelines on pull requests?

Yes :+1:

Test Plan

Try cargo install --path language/tools/move-cli and see it fail, now try cargo install --locked --path language/tools/move-cli. It should succeed.

wiktor-k commented 4 months ago

Hmm... funny thing, one of the CI jobs failed with the same exact reason ( --locked flag missing on cargo install). I could fix it in this PR if you don't mind.