-
Notifications
You must be signed in to change notification settings - Fork 77
Cargo.lock handling to be same across examples #486
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
finalyards
wants to merge
1
commit into
embassy-rs:main
Choose a base branch
from
finalyards:pr-Cargo-lock
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,16 @@ | ||
**/target | ||
**/target_ci | ||
**/target/ | ||
/target_ci/ | ||
|
||
# Ignore lock files, except where we don't. | ||
# - examples: ignore, they are just samples | ||
# - tests: keep. This provides a common ground of dependencies for CI, for example, without providing too much hassle | ||
# for co-developers. | ||
# | ||
# Note: 'host/' carries both a library and tests. We have the Cargo.lock and expect it *not to be used* by dependencies | ||
# (this should be confirmed). | ||
Cargo.lock | ||
!/examples/tests/Cargo.lock | ||
!/host/Cargo.lock | ||
|
||
/tests/ | ||
.idea |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
## 📦 Cargo.lock Policy | ||
|
||
This repository contains a mix of libraries, examples, and test binaries. To ensure clarity and reproducibility, we follow a nuanced approach to `Cargo.lock` inclusion: | ||
|
||
### ✅ What we commit | ||
We include `Cargo.lock` files **only** for test binaries that are executed in CI: | ||
|
||
- [`examples/tests/Cargo.lock`](examples/tests/Cargo.lock) | ||
- [`host/Cargo.lock`](host/Cargo.lock) — used by `host/tests` | ||
|
||
These lockfiles ensure reproducible CI runs and provide a stable dependency baseline for contributors running tests locally. | ||
|
||
### ❌ What we ignore | ||
We do **not** commit `Cargo.lock` for: | ||
|
||
- The root crate (which is a library) | ||
- Example applications (which are not CI-tested and often target MCU hardware) | ||
|
||
This aligns with [Cargo's official guidance](https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html), which recommends: | ||
|
||
> *“Cargo.lock is not used for libraries to avoid locking dependencies for downstream users.”* | ||
### 🧠 Why this matters | ||
- **Libraries** should remain flexible for downstream consumers. | ||
- **Examples** are illustrative and not CI-tested; locking them would add unnecessary maintenance burden. | ||
- **Test binaries** benefit from locked dependencies to ensure consistent CI behavior and easier debugging. | ||
|
||
### 🛠 `.gitignore` setup | ||
Our root `.gitignore` reflects this policy: | ||
|
||
```gitignore | ||
# Ignore lock files, except where we don't. | ||
Cargo.lock | ||
!/examples/tests/Cargo.lock | ||
!/host/Cargo.lock | ||
``` | ||
|
||
<!-- | ||
Text from Copilot discussion, 16-Oct-25 | ||
--> |
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should still be **/target_ci I think?