Include vcs_info even if workspace is dirty #13960

torhovland · 2024-05-24T10:48:01Z

What does this PR try to resolve?

Related to #13695.

Generates and packages the .cargo_vcs_info.json file even if the worktree is dirty, as long as --allow-dirty is passed.

Also added a dirty field to the file to record if the Git repository status is dirty.

Tests are included.

rustbot · 2024-05-24T10:48:06Z

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

weihanglo

Thanks for the contribution. Could you adjust the commit order a bit?

The first commit adding a new test (issue_13695_dirty_vcs_info) to show the old behavior, and should pass the CI pipeline. The next commits fix both the behavior and test assertions.

src/cargo/ops/cargo_package.rs

weihanglo · 2024-05-24T21:17:01Z

r? weihanglo

weihanglo · 2024-05-29T17:00:28Z

@rfcbot fcp merge

With this change, the .cargo_vcs_info.json will always be generated regardless the dirty status of the VCS.

One risk is that people may already rely on the existence of vcs info file to determine if the repository is dirty. That's actually documented in the cargo-package manpage. However, a package without .cargo_vcs_info.json only implies that it was packaged with --allow-dirty passed, but not the repository was actually dirty at that time. Hence I think the risk should be low, and this patch makes it more accurate.

@rfcbot concern doc-update

Since we are going to include VCS info file unconditionally if in a Git repository, this might give people a false impression that Cargo handles package publish provenance against the linked repository. We may want to explicitly call out that Cargo hasn't yet provided the feature in the manpage, as people can fake the file. We should update the doc of the JSON format as well, and add a line saying that new fields may be added in the future and not considered as breaking changes.

rfcbot · 2024-05-29T17:00:29Z

Team member @weihanglo has proposed to merge this. The next step is review by the rest of the tagged team members:

Concerns:

~~doc-update~~ resolved by Include vcs_info even if workspace is dirty #13960 (comment)

Once a majority of reviewers approve (and at most 2 approvals are outstanding), this will enter its final comment period. If you spot a major issue that hasn't been raised at any point in this process, please speak up!

See this document for info about what commands tagged team members can give me.

src/cargo/ops/cargo_package.rs

weihanglo · 2024-05-30T13:57:32Z

@torhovland I've posted #13984 to address the concern. If that is merged, would you mind adjusting the doc here and adding a line about the new dirty field below this line?

weihanglo · 2024-05-30T15:48:38Z

@rfcbot resolve doc-update

torhovland · 2024-05-31T06:56:19Z

@weihanglo I've adjusted the docs.

src/cargo/ops/cargo_package.rs

Turbo87 · 2024-06-11T09:37:36Z

One risk is that people may already rely on the existence of vcs info file to determine if the repository is dirty.

FYI crates.io is parsing this file these days. might be good to at least ping the crates.io team on semantic changes like this 😉

weihanglo · 2024-06-11T11:08:53Z

Thanks for letting us know, @Turbo87!

Does this change make sense to crates.io?

Turbo87 · 2024-06-11T11:12:13Z

Does this change make sense to crates.io?

yeah, should be fine now that we know about it and can treat the new field correctly :)

epage · 2024-06-11T13:33:57Z

FYI crates.io is parsing this file these days. might be good to at least ping the crates.io team on semantic changes like this 😉

When I saw Adam's blogpost, I informed him of this. That wasn't yet "crates.io is parsing" though. Was the use of this previously communicated in some other way so we would know to tell crates.io?

rfcbot · 2024-06-11T13:56:18Z

🔔 This is now entering its final comment period, as per the review above. 🔔

torhovland · 2024-06-24T07:59:17Z

Rebased on master, which interestingly succeeded without any conflicts.

@bors r+

bors · 2024-06-24T07:59:19Z

@torhovland: 🔑 Insufficient privileges: Not in reviewers

torhovland · 2024-06-24T07:59:54Z

@weihanglo Please try again.

…llowing dirty.

weihanglo · 2024-06-24T13:40:55Z

Thank you!

@bors r+

bors · 2024-06-24T13:40:57Z

📌 Commit e7bfed1 has been approved by weihanglo

It is now in the queue for this repository.

bors · 2024-06-24T13:43:18Z

⌛ Testing commit e7bfed1 with merge 95d16be...

bors · 2024-06-24T14:13:50Z

☀️ Test successful - checks-actions
Approved by: weihanglo
Pushing 95d16be to master...

Update cargo 10 commits in bc89bffa5987d4af8f71011c7557119b39e44a65..4ed7bee47f7dd4416b36fada1909e9a62c546246 2024-06-22 00:36:36 +0000 to 2024-06-25 16:28:22 +0000 - test: omit target-dir name (rust-lang/cargo#14142) - test: migrate offline, open_namespaces and owner to snapbox (rust-lang/cargo#14138) - docs: remove stray comment (rust-lang/cargo#14133) - Change tests to support `rustc` wording changes (rust-lang/cargo#14135) - deps: dont use tracing-attributes for workspace, use for cargo only (rust-lang/cargo#14122) - Include vcs_info even if workspace is dirty (rust-lang/cargo#13960) - test: migrate profile* to snapbox (rust-lang/cargo#14128) - test: migrate path and paths to snapbox (rust-lang/cargo#14109) - test: migrate rustflags, rustup and script to snapbox (rust-lang/cargo#14126) - test: migrate rename_deps, replace, required_features and run to snapbox (rust-lang/cargo#14127)

This MR contains the following updates: | Package | Update | Change | |---|---|---| | [rust](https://github.com/rust-lang/rust) | minor | `1.80.1` -> `1.81.0` | MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot). **Proposed changes to behavior should be submitted there as MRs.** --- ### Release Notes <details> <summary>rust-lang/rust (rust)</summary> ### [`v1.81.0`](https://github.com/rust-lang/rust/blob/HEAD/RELEASES.md#Version-1810-2024-09-05) [Compare Source](rust-lang/rust@1.80.1...1.81.0) \========================== <a id="1.81.0-Language"></a> ## Language - [Abort on uncaught panics in `extern "C"` functions.](rust-lang/rust#116088) - [Fix ambiguous cases of multiple `&` in elided self lifetimes.](rust-lang/rust#117967) - [Stabilize `#[expect]` for lints (RFC 2383),](rust-lang/rust#120924) like `#[allow]` with a warning if the lint is *not* fulfilled. - [Change method resolution to constrain hidden types instead of rejecting method candidates.](rust-lang/rust#123962) - [Bump `elided_lifetimes_in_associated_constant` to deny.](rust-lang/rust#124211) - [`offset_from`: always allow pointers to point to the same address.](rust-lang/rust#124921) - [Allow constraining opaque types during subtyping in the trait system.](rust-lang/rust#125447) - [Allow constraining opaque types during various unsizing casts.](rust-lang/rust#125610) - [Deny keyword lifetimes pre-expansion.](rust-lang/rust#126762) <a id="1.81.0-Compiler"></a> ## Compiler - [Make casts of pointers to trait objects stricter.](rust-lang/rust#120248) - [Check alias args for well-formedness even if they have escaping bound vars.](rust-lang/rust#123737) - [Deprecate no-op codegen option `-Cinline-threshold=...`.](rust-lang/rust#124712) - [Re-implement a type-size based limit.](rust-lang/rust#125507) - [Properly account for alignment in `transmute` size checks.](rust-lang/rust#125740) - [Remove the `box_pointers` lint.](rust-lang/rust#126018) - [Ensure the interpreter checks bool/char for validity when they are used in a cast.](rust-lang/rust#126265) - [Improve coverage instrumentation for functions containing nested items.](rust-lang/rust#127199) - Target changes: - [Add Tier 3 `no_std` Xtensa targets:](rust-lang/rust#125141) `xtensa-esp32-none-elf`, `xtensa-esp32s2-none-elf`, `xtensa-esp32s3-none-elf` - [Add Tier 3 `std` Xtensa targets:](rust-lang/rust#126380) `xtensa-esp32-espidf`, `xtensa-esp32s2-espidf`, `xtensa-esp32s3-espidf` - [Add Tier 3 i686 Redox OS target:](rust-lang/rust#126192) `i686-unknown-redox` - [Promote `arm64ec-pc-windows-msvc` to Tier 2.](rust-lang/rust#126039) - [Promote `loongarch64-unknown-linux-musl` to Tier 2 with host tools.](rust-lang/rust#126298) - [Enable full tools and profiler for LoongArch Linux targets.](rust-lang/rust#127078) - [Unconditionally warn on usage of `wasm32-wasi`.](rust-lang/rust#126662) (see compatibility note below) - Refer to Rust's \[platform support page]\[platform-support-doc] for more information on Rust's tiered platform support. <a id="1.81.0-Libraries"></a> ## Libraries - [Split core's `PanicInfo` and std's `PanicInfo`.](rust-lang/rust#115974) (see compatibility note below) - [Generalize `{Rc,Arc}::make_mut()` to unsized types.](rust-lang/rust#116113) - [Replace sort implementations with stable `driftsort` and unstable `ipnsort`.](rust-lang/rust#124032) All `slice::sort*` and `slice::select_nth*` methods are expected to see significant performance improvements. See the [research project](https://github.com/Voultapher/sort-research-rs) for more details. - [Document behavior of `create_dir_all` with respect to empty paths.](rust-lang/rust#125112) - [Fix interleaved output in the default panic hook when multiple threads panic simultaneously.](rust-lang/rust#127397) <a id="1.81.0-Stabilized-APIs"></a> ## Stabilized APIs - [`core::error`](https://doc.rust-lang.org/stable/core/error/index.html) - [`hint::assert_unchecked`](https://doc.rust-lang.org/stable/core/hint/fn.assert_unchecked.html) - [`fs::exists`](https://doc.rust-lang.org/stable/std/fs/fn.exists.html) - [`AtomicBool::fetch_not`](https://doc.rust-lang.org/stable/core/sync/atomic/struct.AtomicBool.html#method.fetch_not) - [`Duration::abs_diff`](https://doc.rust-lang.org/stable/core/time/struct.Duration.html#method.abs_diff) - [`IoSlice::advance`](https://doc.rust-lang.org/stable/std/io/struct.IoSlice.html#method.advance) - [`IoSlice::advance_slices`](https://doc.rust-lang.org/stable/std/io/struct.IoSlice.html#method.advance_slices) - [`IoSliceMut::advance`](https://doc.rust-lang.org/stable/std/io/struct.IoSliceMut.html#method.advance) - [`IoSliceMut::advance_slices`](https://doc.rust-lang.org/stable/std/io/struct.IoSliceMut.html#method.advance_slices) - [`PanicHookInfo`](https://doc.rust-lang.org/stable/std/panic/struct.PanicHookInfo.html) - [`PanicInfo::message`](https://doc.rust-lang.org/stable/core/panic/struct.PanicInfo.html#method.message) - [`PanicMessage`](https://doc.rust-lang.org/stable/core/panic/struct.PanicMessage.html) These APIs are now stable in const contexts: - [`char::from_u32_unchecked`](https://doc.rust-lang.org/stable/core/char/fn.from_u32\_unchecked.html) (function) - [`char::from_u32_unchecked`](https://doc.rust-lang.org/stable/core/primitive.char.html#method.from_u32\_unchecked) (method) - [`CStr::count_bytes`](https://doc.rust-lang.org/stable/core/ffi/c_str/struct.CStr.html#method.count_bytes) - [`CStr::from_ptr`](https://doc.rust-lang.org/stable/core/ffi/c_str/struct.CStr.html#method.from_ptr) <a id="1.81.0-Cargo"></a> ## Cargo - [Generated `.cargo_vcs_info.json` is always included, even when `--allow-dirty` is passed.](rust-lang/cargo#13960) - [Disallow `package.license-file` and `package.readme` pointing to non-existent files during packaging.](rust-lang/cargo#13921) - [Disallow passing `--release`/`--debug` flag along with the `--profile` flag.](rust-lang/cargo#13971) - [Remove `lib.plugin` key support in `Cargo.toml`. Rust plugin support has been deprecated for four years and was removed in 1.75.0.](rust-lang/cargo#13902) <a id="1.81.0-Compatibility-Notes"></a> ## Compatibility Notes - Usage of the `wasm32-wasi` target will now issue a compiler warning and request users switch to the `wasm32-wasip1` target instead. Both targets are the same, `wasm32-wasi` is only being renamed, and this [change to the WASI target](https://blog.rust-lang.org/2024/04/09/updates-to-rusts-wasi-targets.html) is being done to enable removing `wasm32-wasi` in January 2025. - We have renamed `std::panic::PanicInfo` to `std::panic::PanicHookInfo`. The old name will continue to work as an alias, but will result in a deprecation warning starting in Rust 1.82.0. `core::panic::PanicInfo` will remain unchanged, however, as this is now a *different type*. The reason is that these types have different roles: `std::panic::PanicHookInfo` is the argument to the [panic hook](https://doc.rust-lang.org/stable/std/panic/fn.set_hook.html) in std context (where panics can have an arbitrary payload), while `core::panic::PanicInfo` is the argument to the [`#[panic_handler]`](https://doc.rust-lang.org/nomicon/panic-handler.html) in no_std context (where panics always carry a formatted *message*). Separating these types allows us to add more useful methods to these types, such as `std::panic::PanicHookInfo::payload_as_str()` and `core::panic::PanicInfo::message()`. - The new sort implementations may panic if a type's implementation of [`Ord`](https://doc.rust-lang.org/std/cmp/trait.Ord.html) (or the given comparison function) does not implement a [total order](https://en.wikipedia.org/wiki/Total_order) as the trait requires. `Ord`'s supertraits (`PartialOrd`, `Eq`, and `PartialEq`) must also be consistent. The previous implementations would not "notice" any problem, but the new implementations have a good chance of detecting inconsistencies, throwing a panic rather than returning knowingly unsorted data. - [In very rare cases, a change in the internal evaluation order of the trait solver may result in new fatal overflow errors.](rust-lang/rust#126128) <a id="1.81.0-Internal-Changes"></a> ## Internal Changes These changes do not affect any public interfaces of Rust, but they represent significant improvements to the performance or internals of rustc and related tools. - [Add a Rust-for Linux `auto` CI job to check kernel builds.](rust-lang/rust#125209) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this MR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

rustbot assigned ehuss May 24, 2024

rustbot added Command-package S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels May 24, 2024

weihanglo reviewed May 24, 2024

View reviewed changes

src/cargo/ops/cargo_package.rs Show resolved Hide resolved

rustbot assigned weihanglo and unassigned ehuss May 24, 2024

torhovland force-pushed the issue-13695 branch from f7a0473 to c9ce257 Compare May 27, 2024 08:21

weihanglo added the T-cargo Team: Cargo label May 27, 2024

rfcbot added proposed-final-comment-period An FCP proposal has started, but not yet signed off. disposition-merge FCP with intent to merge labels May 29, 2024

epage reviewed May 29, 2024

View reviewed changes

src/cargo/ops/cargo_package.rs Outdated Show resolved Hide resolved

weihanglo mentioned this pull request May 30, 2024

doc(cargo-package): explain no guarantee of vcs provenance #13984

Merged

rustbot added the A-documenting-cargo-itself Area: Cargo's documentation label May 31, 2024

torhovland force-pushed the issue-13695 branch from 53e368d to 2c928e9 Compare May 31, 2024 10:45

rustbot added the A-cli-help Area: built-in command-line help label May 31, 2024

weihanglo approved these changes May 31, 2024

View reviewed changes

src/cargo/ops/cargo_package.rs Outdated Show resolved Hide resolved

rfcbot added the final-comment-period FCP — a period for last comments before action is taken label Jun 11, 2024

rfcbot removed the proposed-final-comment-period An FCP proposal has started, but not yet signed off. label Jun 11, 2024

weihanglo linked an issue Jun 22, 2024 that may be closed by this pull request

Include cargo_vcs_info.json even for dirty working directories #13695

Closed

briansmith mentioned this pull request Jun 23, 2024

Could tags be added to corespond with all releases on crates.io? briansmith/ring#1460

Open

torhovland force-pushed the issue-13695 branch from fb1d795 to 8255ded Compare June 24, 2024 07:55

torhovland added 5 commits June 24, 2024 13:02

test: Verify that the vcs_info file is not included in package when a…

a6ad3a3

…llowing dirty.

fix: Include vcs_info even if workspace is dirty.

2a1299a

Add a dirty flag to the vcs_info file.

1b63685

Adjusted documentation about the dirty flag.

a00232d

Skip serializing the dirty flag if false.

e7bfed1

torhovland force-pushed the issue-13695 branch from 8255ded to e7bfed1 Compare June 24, 2024 11:03

weihanglo approved these changes Jun 24, 2024

View reviewed changes

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-author Status: The marked PR is awaiting some action (such as code changes) from the PR author. labels Jun 24, 2024

bors merged commit 95d16be into rust-lang:master Jun 24, 2024
22 checks passed

bors mentioned this pull request Jun 24, 2024

test: migrate package* and publish* to snapbox #14130

Merged

weihanglo mentioned this pull request Jun 25, 2024

Update cargo rust-lang/rust#126955

Merged

rustbot added this to the 1.81.0 milestone Jun 26, 2024

weihanglo mentioned this pull request Aug 5, 2024

Failed to cargo package --allow-dirty for repo with no commit #14354

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Include vcs_info even if workspace is dirty #13960

Include vcs_info even if workspace is dirty #13960

torhovland commented May 24, 2024 •

edited by weihanglo

Loading

rustbot commented May 24, 2024

weihanglo left a comment

weihanglo commented May 24, 2024

weihanglo commented May 29, 2024 •

edited

Loading

rfcbot commented May 29, 2024 •

edited by arlosi

Loading

weihanglo commented May 30, 2024

weihanglo commented May 30, 2024

torhovland commented May 31, 2024

Turbo87 commented Jun 11, 2024

weihanglo commented Jun 11, 2024

Turbo87 commented Jun 11, 2024

epage commented Jun 11, 2024 •

edited

Loading

rfcbot commented Jun 11, 2024

torhovland commented Jun 24, 2024

bors commented Jun 24, 2024

torhovland commented Jun 24, 2024

weihanglo commented Jun 24, 2024

bors commented Jun 24, 2024

bors commented Jun 24, 2024

bors commented Jun 24, 2024

Include vcs_info even if workspace is dirty #13960

Include vcs_info even if workspace is dirty #13960

Conversation

torhovland commented May 24, 2024 • edited by weihanglo Loading

What does this PR try to resolve?

rustbot commented May 24, 2024

weihanglo left a comment

Choose a reason for hiding this comment

weihanglo commented May 24, 2024

weihanglo commented May 29, 2024 • edited Loading

rfcbot commented May 29, 2024 • edited by arlosi Loading

weihanglo commented May 30, 2024

weihanglo commented May 30, 2024

torhovland commented May 31, 2024

Turbo87 commented Jun 11, 2024

weihanglo commented Jun 11, 2024

Turbo87 commented Jun 11, 2024

epage commented Jun 11, 2024 • edited Loading

rfcbot commented Jun 11, 2024

torhovland commented Jun 24, 2024

bors commented Jun 24, 2024

torhovland commented Jun 24, 2024

weihanglo commented Jun 24, 2024

bors commented Jun 24, 2024

bors commented Jun 24, 2024

bors commented Jun 24, 2024

torhovland commented May 24, 2024 •

edited by weihanglo

Loading

weihanglo commented May 29, 2024 •

edited

Loading

rfcbot commented May 29, 2024 •

edited by arlosi

Loading

epage commented Jun 11, 2024 •

edited

Loading