docs: Add recommendations for lockfile #3467
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
Synss
pushed a commit
to Synss/rules_rust
that referenced
this pull request
Jun 13, 2025
I did some experiments on [this example](https://github.com/bazelbuild/rules_rust/blob/e38fa8c2bc0990debceaf28daa4fcb2c57dcdc1c/examples/hello_world/MODULE.bazel#L25-L30) to evaluate the `lockfile` attribute vs. using `MODULE.bazel.lock`: I ran `bazel test //... --profile=...`. After every run, I did a `bazel clean && bazel shutdown` to start clean. 1. Run (`MODULE.bazel.lock` file only): No `cargo-bazel` call found in the profile generated 1. Run (add the `lockfile`, run `CARGO_BAZEL_REPIN=true bazel mod tidy`, then `bazel test`): No `cargo-bazel` call found in the profile generated 1. Run (delete `MODULE.bazel.lock`): `cargo-bazel` was called, but cargo splicing was very fast. The `MODULE.bazel.lock` was recreated 1. Run (delete`MODULE.bazel.lock` and run with `--lockfile_mode=off`): `cargo-bazel` was called, similar to above This suggests: * If you have the `MODULE.bazel.lock` file up to date, no `cargo-bazel` is called regardless of using the `lockfile` or not * If the `MODULE.bazel.lock` is not tracked in VCS the `lockfile` seems to be helpful and should be used * Comparing the `MODULE.bazel.lock` file and the `lockfile` a bit more in detail, shows they store similar information. The `lockfile` is a bit more well structured json (for the rust specific content) while the `MODULE.bazel.lock` file seems to store the entire content generated for every crate in a single string.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I did some experiments on this example to evaluate the
lockfileattribute vs. usingMODULE.bazel.lock:I ran
bazel test //... --profile=.... After every run, I did abazel clean && bazel shutdownto start clean.MODULE.bazel.lockfile only): Nocargo-bazelcall found in the profile generatedlockfile, runCARGO_BAZEL_REPIN=true bazel mod tidy, thenbazel test): Nocargo-bazelcall found in the profile generatedMODULE.bazel.lock):cargo-bazelwas called, but cargo splicing was very fast. TheMODULE.bazel.lockwas recreatedMODULE.bazel.lockand run with--lockfile_mode=off):cargo-bazelwas called, similar to aboveThis suggests:
MODULE.bazel.lockfile up to date, nocargo-bazelis called regardless of using thelockfileor notMODULE.bazel.lockis not tracked in VCS thelockfileseems to be helpful and should be usedMODULE.bazel.lockfile and thelockfilea bit more in detail, shows they store similar information. Thelockfileis a bit more well structured json (for the rust specific content) while theMODULE.bazel.lockfile seems to store the entire content generated for every crate in a single string.