-
Notifications
You must be signed in to change notification settings - Fork 440
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Follow-up documentation/fixes to lockfile API (#2637)
- Loading branch information
1 parent
1fc0f8c
commit 0ca65fb
Showing
2 changed files
with
14 additions
and
1 deletion.
There are no files selected for viewing
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 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# Catalog of testdata files | ||
|
||
## `multi_package-cargo-bazel-lock.json` | ||
|
||
This was copied from `examples/crate_universe/multi_package/cargo-bazel-lock.json` at commit 53daac71c0755680c29f4c55ac5238cc063e8b31. | ||
|
||
It's intended to be an example of a realistic and meaningfully complex lockfile. | ||
|
||
If this file needs to change in order to make the tests using it pass, it's likely a breaking change has been made to either the lockfile format or the lockfile parser. | ||
|
||
Ideally we should avoid breaking changes in the lockfile parser, so ideally future tests would _add new_ test lockfiles (and this one will remain static to show our API can still parse historic lockfiles), rather than modify existing lockfiles. | ||
|
||
We don't formally make strong guarantees around API stability here, so it's ok to need to change this file if really needed, but if it's easy to preserve the compatibility we'd prefer to. |