docs: More information on what is and isn't included by cargo package
What does this PR try to resolve?
Add more detail to cargo package explaining what is and isn't included.
This doesn't add the feature requested by #11203 (shipping symlinks) but it does at least make it more clear that it's not supported.
How should we test and review this PR?
Docs only change.
I wrote this by reading src/cargo/sources/path.rs, in addition to my observations of cargo behavior, so it might be helpful for reviewers to check the new docs against the code.
r? @ehuss
rustbot has assigned @ehuss. They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.
Use r? to explicitly pick a reviewer
r? @weihanglo
The failures seem to be unrelated flakes?
Perhaps we need to purchase some credits from Docker? 😬
ERROR: failed to solve: httpd:2.4-alpine: failed to resolve source metadata for docker.io/library/httpd:2.4-alpine: failed to copy: httpReadSeeker: failed open: unexpected status code https://registry-1.docker.io/v2/library/httpd/manifests/sha256:66c49302c02430619abb84240a438bcfc083015661009fcaaeaac931450f62cd: 429 Too Many Requests - Server message: toomanyrequests: You have reached your pull rate limit. You may increase the limit by authenticating and upgrading: https://www.docker.com/increase-rate-limit
Or we could switch to other image registry services
https://github.com/rust-lang/cargo/actions/runs/11330170805/job/31507413375?pr=14684
Perhaps this is getting rate-limited based on the GitHub workers IP pool, if the cargo build does not currently pass any credentials? If so, just switching to an authenticated pull, even without paying, might help.
It also might be possible to cache the image in GitHub Actions, per https://docs.docker.com/build/ci/github-actions/cache/. That would help stay below the limit of authenticated pulls. Even if we're using just the GitHub IPs it would probably reduce the error rate.
We could split out a separate issue? I can have a look if you like, although as I'm not a project member I might need help with registering an account or uploading secrets.
We could split out a separate issue? I can have a look if you like, although as I'm not a project member I might need help with registering an account or uploading secrets.
Blocked on https://github.com/rust-lang/cargo/pull/14686.
Thank you!
@bors r+
:pushpin: Commit b8125da4e833f45a59447e8b3e18b1b2282cea13 has been approved by weihanglo
It is now in the queue for this repository.
:hourglass: Testing commit b8125da4e833f45a59447e8b3e18b1b2282cea13 with merge 8c30ce53688e25f7e9d860b33cc914fb2957ca9a...
:sunny: Test successful - checks-actions Approved by: weihanglo Pushing 8c30ce53688e25f7e9d860b33cc914fb2957ca9a to master...