Add "--workspace" to update command #8725

chaaz · 2020-09-22T22:42:38Z

My --bin project has CI which updates the version number in Cargo.toml, which it then commits. However, this means that any further cargo command (build, test, etc) will update the existing Cargo.lock file (updating the root version), causing some frustration for users. Furthermore, it breaks the publish command, which requires the repo to be current.

I've added a sync-lockfile command to simply update the root version in the Cargo.lock file to match the Cargo.toml in the same way that simple commands like fetch do. If no Cargo.lock file is present, and new one is generated based on the index.

This is a demo PR for Pre-RFC conversation at https://internals.rust-lang.org/t/pre-rfc-cargo-command-to-just-sync-lockfile/13119, but may become a real PR if it gets approval.

rust-highfive · 2020-09-22T22:42:41Z

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @ehuss (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see the contribution instructions for more information.

ehuss · 2020-09-28T15:31:26Z

Thanks for the PR! The Cargo team talked about this, and we feel that this would probably be better to be part of cargo update. There is a pretty high bar to add a new top-level command, and this doesn't feel like it really needs a new command. Perhaps a --workspace flag to mirror other commands? I'm not certain that it is 100% equivalent to pass workspace members to the avoid list, but I believe it should be roughly the same.

chaaz · 2020-09-28T17:01:27Z

Thanks for the PR! The Cargo team talked about this, and we feel that this would probably be better to be part of cargo update. There is a pretty high bar to add a new top-level command, and this doesn't feel like it really needs a new command. Perhaps a --workspace flag to mirror other commands? I'm not certain that it is 100% equivalent to pass workspace members to the avoid list, but I believe it should be roughly the same.

Thanks, @ehuss. Discussion on the forums came to roughly the same conclusion. I'll change the PR so that update --workspace does what I want, instead of an entirely new command.

Are the Cargo Book descriptions auto-pulled from the source, or should I be updating that separately?

ehuss · 2020-09-29T00:01:50Z

Are the Cargo Book descriptions auto-pulled from the source, or should I be updating that separately?

The documentation is written in markdown. The cargo-update documentation is here: https://github.com/rust-lang/cargo/blob/master/src/doc/man/cargo-update.md. After updating the docs, you need to run build-man.sh to rebuild the man pages. There's more documentation on how this works at https://github.com/rust-lang/cargo/tree/master/src/doc.

chaaz · 2020-11-06T21:52:36Z

@ehuss Sorry for the slow response: real life intervened. Anywho, I have moved the functionality to update --workspace as discussed, and have added the flag to the docs as well. Please let me know how that looks.

ehuss

Thanks!

From an implementation standpoint, I was thinking that the --workspace flag would just add the set of member PackageIds to the to_avoid list. That would avoid needing a special code path. This current implementation seems to ignore additional -p flags, and doesn't report what was updated. Do you think there would be any particular problems with that approach, or were there other reasons to go with the current design?

ehuss · 2020-11-07T22:01:29Z

src/bin/cargo/commands/update.rs

@@ -7,6 +7,7 @@ pub fn cli() -> App {
    subcommand("update")
        .about("Update dependencies as recorded in the local lock file")
        .arg(opt("quiet", "No output printed to stdout").short("q"))
+        .arg(opt("workspace", "Only update the workspace pakcages").short("w"))


Suggested change

.arg(opt("workspace", "Only update the workspace pakcages").short("w"))

.arg(opt("workspace", "Only update the workspace packages").short("w"))

chaaz · 2020-11-11T16:08:49Z

Thanks!

From an implementation standpoint, I was thinking that the --workspace flag would just add the set of member PackageIds to the to_avoid list. That would avoid needing a special code path. This current implementation seems to ignore additional -p flags, and doesn't report what was updated. Do you think there would be any particular problems with that approach, or were there other reasons to go with the current design?

Thanks, that does seem like a better approach. Will put that in.

chaaz · 2020-11-12T00:26:33Z

@ehuss Just checked in the suggested changes: looks like the best way is just to keep the to_avoid array empty (-ish) if there's a --workspaces flag. That is much easier approach, and integrates better with existing behavior. Let me know what you think.

ehuss · 2020-11-12T21:29:42Z

@rfcbot fcp merge

This adds a new stable flag --workspace (or -w) to cargo update which will cause it to update only the workspace members (or more specifically, it does an update equivalent to cargo build which updates any out-of-date path sources). This can be useful when bumping the version in Cargo.toml, and you want to update Cargo.lock, but don't want to run some other command (like build or metadata), or don't want to explicitly list each workspace member like cargo update -p foo.

ehuss · 2020-11-12T21:30:06Z

@rfcbot fcp merge

rfcbot · 2020-11-12T21:30:07Z

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

No concerns currently listed.

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.

rfcbot · 2020-12-01T20:26:51Z

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

ehuss · 2020-12-02T01:44:25Z

Thanks again @chaaz!

@bors r+

bors · 2020-12-02T01:44:27Z

📌 Commit 42f3469 has been approved by ehuss

bors · 2020-12-02T01:44:35Z

⌛ Testing commit 42f3469 with merge 63d0fe4...

bors · 2020-12-02T02:12:20Z

☀️ Test successful - checks-actions
Approved by: ehuss
Pushing 63d0fe4 to master...

Update cargo 12 commits in bfca1cd22bf514d5f2b6c1089b0ded0ba7dfaa6e..63d0fe43449adcb316d34d98a982b597faca4178 2020-11-24 16:33:21 +0000 to 2020-12-02 01:44:30 +0000 - Add "--workspace" to update command (rust-lang/cargo#8725) - Add an FAQ for "Why is my crate rebuilt?" (rust-lang/cargo#8927) - Set docs.rs as the default extern-map for crates.io (rust-lang/cargo#8877) - remove extra whitespace when running cargo -Z help (rust-lang/cargo#8924) - Remove version from dev-dependencies to make it easier to publish. (rust-lang/cargo#8920) - update dependency queue to consider cost for each node (rust-lang/cargo#8908) - Fix some rustdoc warnings. (rust-lang/cargo#8911) - Bump miow dependency to not invalidly assume memory layout (rust-lang/cargo#8909) - Remove unnecessary trailing semicolons (rust-lang/cargo#8906) - Fix custom_target_dependency test. (rust-lang/cargo#8907) - fix: we don't ignore `version` for `git`/`path` deps now (rust-lang/cargo#8900) - doc (book): add "Getting Started" subsection: "Essential Terminology" (rust-lang/cargo#8855)

Pkgsrc changes: * Adjust patches, re-compute line offsets, fix capitalization. * Remove i686/FreeBSD support, no longer provided upstream. * Bump bootstraps to 1.49.0. * Change USE_TOOLS from bsdtar to gtar. * Reduce diffs to pkgsrc-wip package patches. * Allow rust.BUILD_TARGET to override automatic choice of target. * Add an i586/NetBSD (pentium) bootstrap variant (needs testing), not yet added as bootstrap since 1.49 doesn't have that variant. Upstream changes: Version 1.50.0 (2021-02-11) ============================ Language ----------------------- - [You can now use `const` values for `x` in `[x; N]` array expressions.][79270] This has been technically possible since 1.38.0, as it was unintentionally stabilized. - [Assignments to `ManuallyDrop<T>` union fields are now considered safe.][78068] Compiler ----------------------- - [Added tier 3\* support for the `armv5te-unknown-linux-uclibceabi` target.][78142] - [Added tier 3 support for the `aarch64-apple-ios-macabi` target.][77484] - [The `x86_64-unknown-freebsd` is now built with the full toolset.][79484] \* Refer to Rust's [platform support page][forge-platform-support] for more information on Rust's tiered platform support. Libraries ----------------------- - [`proc_macro::Punct` now implements `PartialEq<char>`.][78636] - [`ops::{Index, IndexMut}` are now implemented for fixed sized arrays of any length.][74989] - [On Unix platforms, the `std::fs::File` type now has a "niche" of `-1`.][74699] This value cannot be a valid file descriptor, and now means `Option<File>` takes up the same amount of space as `File`. Stabilized APIs --------------- - [`bool::then`] - [`btree_map::Entry::or_insert_with_key`] - [`f32::clamp`] - [`f64::clamp`] - [`hash_map::Entry::or_insert_with_key`] - [`Ord::clamp`] - [`RefCell::take`] - [`slice::fill`] - [`UnsafeCell::get_mut`] The following previously stable methods are now `const`. - [`IpAddr::is_ipv4`] - [`IpAddr::is_ipv6`] - [`Layout::size`] - [`Layout::align`] - [`Layout::from_size_align`] - `pow` for all integer types. - `checked_pow` for all integer types. - `saturating_pow` for all integer types. - `wrapping_pow` for all integer types. - `next_power_of_two` for all unsigned integer types. - `checked_power_of_two` for all unsigned integer types. Cargo ----------------------- - [Added the `[build.rustc-workspace-wrapper]` option.][cargo/8976] This option sets a wrapper to execute instead of `rustc`, for workspace members only. - [`cargo:rerun-if-changed` will now, if provided a directory, scan the entire contents of that directory for changes.][cargo/8973] - [Added the `--workspace` flag to the `cargo update` command.][cargo/8725] Misc ---- - [The search results tab and the help button are focusable with keyboard in rustdoc.][79896] - [Running tests will now print the total time taken to execute.][75752] Compatibility Notes ------------------- - [The `compare_and_swap` method on atomics has been deprecated.][79261] It's recommended to use the `compare_exchange` and `compare_exchange_weak` methods instead. - [Changes in how `TokenStream`s are checked have fixed some cases where you could write unhygenic `macro_rules!` macros.][79472] - [`#![test]` as an inner attribute is now considered unstable like other inner macro attributes, and reports an error by default through the `soft_unstable` lint.][79003] - [Overriding a `forbid` lint at the same level that it was set is now a hard error.][78864] - [Dropped support for all cloudabi targets.][78439] - [You can no longer intercept `panic!` calls by supplying your own macro.][78343] It's recommended to use the `#[panic_handler]` attribute to provide your own implementation. - [Semi-colons after item statements (e.g. `struct Foo {};`) now produce a warning.][78296] [74989]: rust-lang/rust#74989 [79261]: rust-lang/rust#79261 [79896]: rust-lang/rust#79896 [79484]: rust-lang/rust#79484 [79472]: rust-lang/rust#79472 [79270]: rust-lang/rust#79270 [79003]: rust-lang/rust#79003 [78864]: rust-lang/rust#78864 [78636]: rust-lang/rust#78636 [78439]: rust-lang/rust#78439 [78343]: rust-lang/rust#78343 [78296]: rust-lang/rust#78296 [78068]: rust-lang/rust#78068 [75752]: rust-lang/rust#75752 [74699]: rust-lang/rust#74699 [78142]: rust-lang/rust#78142 [77484]: rust-lang/rust#77484 [cargo/8976]: rust-lang/cargo#8976 [cargo/8973]: rust-lang/cargo#8973 [cargo/8725]: rust-lang/cargo#8725 [`IpAddr::is_ipv4`]: https://doc.rust-lang.org/stable/std/net/enum.IpAddr.html#method.is_ipv4 [`IpAddr::is_ipv6`]: https://doc.rust-lang.org/stable/std/net/enum.IpAddr.html#method.is_ipv6 [`Layout::align`]: https://doc.rust-lang.org/stable/std/alloc/struct.Layout.html#method.align [`Layout::from_size_align`]: https://doc.rust-lang.org/stable/std/alloc/struct.Layout.html#method.from_size_align [`Layout::size`]: https://doc.rust-lang.org/stable/std/alloc/struct.Layout.html#method.size [`Ord::clamp`]: https://doc.rust-lang.org/stable/std/cmp/trait.Ord.html#method.clamp [`RefCell::take`]: https://doc.rust-lang.org/stable/std/cell/struct.RefCell.html#method.take [`UnsafeCell::get_mut`]: https://doc.rust-lang.org/stable/std/cell/struct.UnsafeCell.html#method.get_mut [`bool::then`]: https://doc.rust-lang.org/stable/std/primitive.bool.html#method.then [`btree_map::Entry::or_insert_with_key`]: https://doc.rust-lang.org/stable/std/collections/btree_map/enum.Entry.html#method.or_insert_with_key [`f32::clamp`]: https://doc.rust-lang.org/stable/std/primitive.f32.html#method.clamp [`f64::clamp`]: https://doc.rust-lang.org/stable/std/primitive.f64.html#method.clamp [`hash_map::Entry::or_insert_with_key`]: https://doc.rust-lang.org/stable/std/collections/hash_map/enum.Entry.html#method.or_insert_with_key [`slice::fill`]: https://doc.rust-lang.org/stable/std/primitive.slice.html#method.fill

rust-highfive assigned ehuss Sep 22, 2020

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Sep 22, 2020

ehuss added S-waiting-on-author Status: The marked PR is awaiting some action (such as code changes) from the PR author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Oct 7, 2020

chaaz added 4 commits November 6, 2020 13:40

Add sync-lockfile command

4ed0537

Fix for rustfmt

ad44f0e

Fix for testsuite

5b92843

fix: change to update -w per feedback

9589d2c

chaaz force-pushed the master branch from 17b97f8 to 9589d2c Compare November 6, 2020 21:48

fix: remove unused

c413d81

fix: fmt for the fmt gods

40d71fb

chaaz changed the title ~~Add "sync-lockfile" command~~ Add "--workspace" to update command Nov 7, 2020

ehuss reviewed Nov 7, 2020

View reviewed changes

fix: change --workspace based on feedback

42f3469

ehuss added T-cargo Team: Cargo and removed S-waiting-on-author Status: The marked PR is awaiting some action (such as code changes) from the PR author. labels Nov 12, 2020

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

rfcbot added the final-comment-period FCP — a period for last comments before action is taken label Dec 1, 2020

rfcbot removed the proposed-final-comment-period An FCP proposal has started, but not yet signed off. label Dec 1, 2020

bors added the S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. label Dec 2, 2020

bors merged commit 63d0fe4 into rust-lang:master Dec 2, 2020

ehuss mentioned this pull request Dec 2, 2020

Update cargo rust-lang/rust#79627

Merged

rfcbot added finished-final-comment-period FCP complete to-announce and removed final-comment-period FCP — a period for last comments before action is taken labels Dec 11, 2020

ehuss added this to the 1.50.0 milestone Feb 6, 2022

epage mentioned this pull request Jan 8, 2023

Add short flag for workspace #11549

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add "--workspace" to update command #8725

Add "--workspace" to update command #8725

chaaz commented Sep 22, 2020

rust-highfive commented Sep 22, 2020

ehuss commented Sep 28, 2020

chaaz commented Sep 28, 2020

ehuss commented Sep 29, 2020

chaaz commented Nov 6, 2020

ehuss left a comment

ehuss Nov 7, 2020

chaaz commented Nov 11, 2020

chaaz commented Nov 12, 2020

ehuss commented Nov 12, 2020

ehuss commented Nov 12, 2020

rfcbot commented Nov 12, 2020 •

edited by Eh2406

rfcbot commented Dec 1, 2020

ehuss commented Dec 2, 2020

bors commented Dec 2, 2020

bors commented Dec 2, 2020

bors commented Dec 2, 2020

	.arg(opt("workspace", "Only update the workspace pakcages").short("w"))
	.arg(opt("workspace", "Only update the workspace packages").short("w"))

Add "--workspace" to update command #8725

Add "--workspace" to update command #8725

Conversation

chaaz commented Sep 22, 2020

rust-highfive commented Sep 22, 2020

ehuss commented Sep 28, 2020

chaaz commented Sep 28, 2020

ehuss commented Sep 29, 2020

chaaz commented Nov 6, 2020

ehuss left a comment

Choose a reason for hiding this comment

ehuss Nov 7, 2020

Choose a reason for hiding this comment

chaaz commented Nov 11, 2020

chaaz commented Nov 12, 2020

ehuss commented Nov 12, 2020

ehuss commented Nov 12, 2020

rfcbot commented Nov 12, 2020 • edited by Eh2406

rfcbot commented Dec 1, 2020

ehuss commented Dec 2, 2020

bors commented Dec 2, 2020

bors commented Dec 2, 2020

bors commented Dec 2, 2020

rfcbot commented Nov 12, 2020 •

edited by Eh2406