chore: check-in Cargo.lock #2208
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
This commit checks the `Cargo.lock` file into git. Version controlling `Cargo.lock` makes e.g. our CI builds more reproducible, where two consecutive CI runs on the same commit use the same set of dependencies, even if a compatible update of a dependency was published in between the two runs. This is also helpful when cutting patch releases of old Neqo versions, where dependencies since shipped a breaking change in a patch version, e.g. a MSRV update. See for example pinned dependencies in a recent Neqo patch release to the Neqo v0.6 family. 66e60f3 While previously the recommendation by the cargo team was for libraries to not check in their `Cargo.lock`, this recommendation has since been replaced by "do what is best for the project". https://blog.rust-lang.org/2023/08/29/committing-lockfiles.html
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2208 +/- ##
=======================================
Coverage 95.39% 95.39%
=======================================
Files 112 112
Lines 36447 36447
=======================================
Hits 34768 34768
Misses 1679 1679 ☔ View full report in Codecov by Sentry. |
mxinden
requested review from
KershawChang,
martinthomson and
larseggert
as code owners
Failed Interop TestsQUIC Interop Runner, client vs. server neqo-latest as client
neqo-latest as server
All resultsSucceeded Interop TestsQUIC Interop Runner, client vs. server neqo-latest as client
neqo-latest as server
Unsupported Interop TestsQUIC Interop Runner, client vs. server neqo-latest as client
neqo-latest as server
|
mxinden
added a commit
to mxinden/neqo
that referenced
this pull request
Oct 30, 2024
Currently we use `quinn-udp` `v0.5.4`. `quinn-udp` `v0.5.5` fixes [`recvmmsg` calls on Android x86](quinn-rs/quinn#1966). `quinn-udp` `v0.5.6` adds [experimental multi-message support on Apple platforms](quinn-rs/quinn#1993) and [fixes an unnecessary `windows-sys` version restriction](quinn-rs/quinn#2021). While not strictly necessary, given that our current version specification (i.e. `version = "0.5.4"`) already allows users to use Neqo with `quinn-udp` `v0.5.6`, this commit updates to `quinn-udp` `v0.5.6` anyways, thus making sure CI tests with latest version. In case mozilla#2208 lands, future compatible version updates would touch the `Cargo.lock` file, not `Cargo.toml`.
|
Don't have a strong opinion here due to limited experience maintaining Rust libs. Do we think this is "best for the project"? |
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.
This commit checks the
Cargo.lockfile into git.Version controlling
Cargo.lockmakes e.g. our CI builds more reproducible, where two consecutive CI runs on the same commit use the same set of dependencies, even if a compatible update of a dependency was published in between the two runs.This is also helpful when cutting patch releases of old Neqo versions, where dependencies since shipped a breaking change in a patch version, e.g. a MSRV update. See for example pinned dependencies in a recent Neqo patch release to the Neqo v0.6 family.
mxinden@66e60f3
While previously the recommendation by the cargo team was for libraries to not check in their
Cargo.lock, this recommendation has since been replaced by "do what is best for the project".https://blog.rust-lang.org/2023/08/29/committing-lockfiles.html
I generated a fresh
Cargo.lock, i.e. ranrm Cargo.lock && cargo check && git add Cargo.lock.We could as well base our
Cargo.lockon mozilla-central'sCargo.lock. Though I can not think of a simple way to then keep the two in sync going forward.Dependabot will attempt to keep the
Cargo.lockup-to-date, in other words will open many pull requests updating patch versions. I don't know how to prevent this. Unfortunately, the Dependabotversion-strategyparameter is not supported for the cargo ecosystem.What do folks think?