tree 20309b1a5cf30c4f12bec28c4f54bc13201f7c46
parent d5ee3a2cb8d254870ce1f49d350d772c71003bca
author Markus Hofbauer <markus.hofbauer@flyzipline.com> 1749771495 +0200
committer GitHub <noreply@github.com> 1749771495 +0000
gpgsig -----BEGIN PGP SIGNATURE-----
 
 wsFcBAABCAAQBQJoS2T4CRC1aQ7uu5UhlAAAxDoQABQCQ6LWVKmIAJY42Z2Qjuhl
 OohEynjsYktp1FsA/frVlyCAJlKQ9txHUKIhEixaOx85zse2g8Qb7D8UJNdgVVyl
 UjuXTSPZl0GzTZIXKHzPHzOg+K/XRaFqekclbkEIEUsVeV2Nx5DScCFeOLgELzFU
 OdOf19C2ehoCypy8mUMA5xnFF+PNvaf+RVdEPclQ/blO3oYiqyC2KCEg6Z+/iXYa
 S22QyxlBG10yodXKcr6YXR5ege+IEic2stQOw865+toiFCVFQWFvBC7c/KV1+Xkp
 BhJ2uJDayVhK3xBuS/2qL78yxgu6c09ObaBg0aoHzCMRae19pUyI6Xqfe7Yym9RQ
 vgeiSwIGgbizC46aIHMIw5/h7Yb2AuRN/Yvp5YnHaRx5tc1Wl64iLgT2UZVacSwb
 uMw8ipz3/vt9qWY3h/oIyqtR5ZMxid0YPUV/MkOPO6x3CigIfwZLFUw3Jby0ZL8P
 VIe+gun+VjcVGp115iCGIOQmRWD0MM+MnI3dPaQTyVqiv+rOzckImT/BMyA5aFRY
 F07WAMSeoB4bNQMSWVH7m/frfReee4nNLdZLteJG5KfyggflNctJqHZGaJthUGW7
 XOr1QjcH5RutPl4x9A6xfs3YOM+Bs2iM8ZP6h5lpP814A8usKLbJWwDnsnV0LkLV
 mPMUGJyhLrukR7BXiOyr
 =qTb0
 -----END PGP SIGNATURE-----
 

docs: Add recommendations for lockfile (#3467)

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.