Commit Cargo.lock by default #54
Open
Conversation
This file contains 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
We audit crates for vulnerabilities on CI already. Lacking a lockfile means the audit is meaningless if the dependency versions can change between subsequent runs because of a e.g. minor or patch semver fix of a security vulnerability. There are advantages and disadvantages to having deterministic dependencies: Advantages: - Aforementioned auditing - Bisectability - More predictable behavior when binaries are installed with `cargo install --locked ...`. Disadvantages: - Cargo's dependency resolution can end up duplicating transitive dependencies in downstream crates which use a `rust-vmm` dependency that shares dependencies with more than one of the others. This can be inspected with `cargo-tree`. - Requires extra maintainer attention and effort to keep the lockfile up-to-date. The Rust Cargo team currently recommends against committing the lockfile for library crates in version control, but plans to reverse this recommendation in the future. You can read the new Cargo recommendations in the Nightly version docs: * https://doc.rust-lang.org/nightly/cargo/faq.html#why-have-cargolock-in-version-control * Web snapshot in Internet Archive: http://web.archive.org/web/20230921033901/https://doc.rust-lang.org/nightly/cargo/faq.html#why-have-cargolock-in-version-control Signed-off-by: Manos Pitsidianakis <[email protected]>
|
I was thinking that with a committed lock file we will also get more dependabot PRs because then updates to patch/minor release will also need to be specifically done, they'll no longer be picked up by default. I guess since we're also doing batch dependabot updates that's not such a big concern. WDYT? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary of the PR
We audit crates for vulnerabilities on CI already. Lacking a lockfile means the audit is meaningless if the dependency versions can change between subsequent runs because of a e.g. minor or patch semver fix of a security vulnerability.
There are advantages and disadvantages to having deterministic dependencies:
Advantages:
cargo install --locked ....Disadvantages:
rust-vmmdependency that shares dependencies with more than one of the others. This can be inspected withcargo-tree.The Rust Cargo team currently recommends against committing the lockfile for library crates in version control, but plans to reverse this
recommendation in the future. You can read the new Cargo
recommendations in the Nightly version docs:
Requirements
Before submitting your PR, please make sure you addressed the following
requirements:
git commit -s), and the commitmessage has max 60 characters for the summary and max 75 characters for each
description line.
test.
Release" section of CHANGELOG.md (if no such section exists, please create one).
unsafecode is properly documented.