Allow publishing with dev-dependencies without a version. #7333

ehuss · 2019-09-05T22:34:43Z

This change allows dev-dependencies without a version key to be published. If a dev-dependency is missing the version, it will be stripped from the packaged manifest.

rust-highfive · 2019-09-05T22:34:54Z

r? @nrc

(rust_highfive has picked a reviewer for you, use r? to override)

alexcrichton · 2019-09-06T13:57:43Z

@rfcbot fcp merge

I've personally always wanted this! Curious what others think though

rfcbot · 2019-09-06T14:01:37Z

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

Concerns:

~~continue discussion with crates.io~~ resolved by Allow publishing with dev-dependencies without a version. #7333 (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.

Eh2406 · 2019-09-06T14:25:51Z

cc Previous discussion at rust-lang/crates-io-cargo-teams#46 & rust-lang/crates.io#1789.

I thought the consensus was that we wanted the .crate file to still work and have crates.io except the dev-dep?

Mark-Simulacrum · 2019-09-06T14:26:33Z

One potential concern is that this means that downloading a crate file, like e.g. Crater does, and running cargo test is presumably much more likely to not work, which isn't great.

However, maybe we can get around this by requiring that the dev-deps are still present in the .crate file (obviously, this can be bypassed with --no-verify, but that's not particularly interesting).

alexcrichton · 2019-09-06T14:57:40Z

@ehuss can correct me, but while it doesn't look like there's an explicit test the Cargo.toml inside the *.crate file still has [dev-dependencies] so long as they have a version listed. It's just the blob we send to crates.io that has them filtered out. They won't show up in the crates.io UI any more.

Mark-Simulacrum · 2019-09-06T15:37:28Z

Ah, then that seems fine to me. Maybe good to add a test if it's relatively simple though.

Eh2406 · 2019-09-06T15:40:20Z

+1 on a test! Also since we repeatedly took time at the crates.io meetings, should we ask for there checkmarks?

ehuss · 2019-09-06T20:00:00Z

but while it doesn't look like there's an explicit test the Cargo.toml inside the *.crate file still has [dev-dependencies] so long as they have a version listed. It's just the blob we send to crates.io that has them filtered out. They won't show up in the crates.io UI any more.

Sorry for the confusion. If a dev-dependency does not specify version, it is filtered from both crates.io and the generated Cargo.toml file. If it does include version, there is no change in behavior.

I can actually remove the generated Cargo.toml stripping. I was initially thinking it might cause problems if the registry Summary was out of sync with Cargo.toml, but I did some tests and it seems fine. Essentially just remove all the changes to toml/mod.rs in this PR. Do people think it would be a good idea to make that change? The only purpose would be to support these path-only deps for a build-and-test run on crater. I think if we do that, we should also have some checks that the dependency is actually included in the package, and deal with .. (I'm not sure how complex that will be). It seems like a bit of effort for a marginal benefit, though.

I can work on better tests. I'm thinking of writing something that will actually commit the publish to the local registry.

joshtriplett · 2019-09-11T20:07:48Z

I'd like to have some verification that the referenced dev-dependency not only has a path inside the crate, but that the referenced path actually will get included in the crate and contains a Cargo.toml file.

(That was also the consensus from the crates.io team.)

Eh2406 · 2019-09-11T20:20:18Z

@rfcbot concern continue discussion with crates.io

Previous discussion at rust-lang/crates-io-cargo-teams#46 & rust-lang/crates.io#1789 let's continue the discussion in one of those threads.

alexcrichton · 2019-09-27T14:20:28Z

Ok, the crates.io has discussed my rationale and concluded that they're willing to defer to us. @Eh2406 I think that resolves your concern?

At that point I would still like to propose that we merge this PR as-is, which strips dev-dependencies from the manifest when publishing when they don't have a version listed.

Eh2406 · 2019-09-27T14:30:56Z

@rfcbot resolve continue discussion with crates.io

alexcrichton · 2019-10-03T19:20:36Z

r? @alexcrichton

alexcrichton · 2019-10-03T19:20:56Z

Also ping @Eh2406, @joshtriplett, and @withoutboats for checkboxes

rfcbot · 2019-10-03T19:42:10Z

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

Until github.com/rust-lang/cargo/pull/7333 makes it into stable rust, we'll be forced to publish using nightly, due to our unpublished dev dependency on `test-utilities`.

Version 1.40.0 (2019-12-19) =========================== Language -------- - [You can now use tuple `struct`s and tuple `enum` variant's constructors in `const` contexts.][65188] e.g. ```rust pub struct Point(i32, i32); const ORIGIN: Point = { let constructor = Point; constructor(0, 0) }; ``` - [You can now mark `struct`s, `enum`s, and `enum` variants with the `#[non_exhaustive]` attribute to indicate that there may be variants or fields added in the future.][64639] For example this requires adding a wild-card branch (`_ => {}`) to any match statements on a non-exhaustive `enum`. [(RFC 2008)] - [You can now use function-like procedural macros in `extern` blocks and in type positions.][63931] e.g. `type Generated = macro!();` - [Function-like and attribute procedural macros can now emit `macro_rules!` items, so you can now have your macros generate macros.][64035] - [The `meta` pattern matcher in `macro_rules!` now correctly matches the modern attribute syntax.][63674] For example `(#[$m:meta])` now matches `#[attr]`, `#[attr{tokens}]`, `#[attr[tokens]]`, and `#[attr(tokens)]`. Compiler -------- - [Added tier 3 support\* for the `thumbv7neon-unknown-linux-musleabihf` target.][66103] - [Added tier 3 support for the `aarch64-unknown-none-softfloat` target.][64589] - [Added tier 3 support for the `mips64-unknown-linux-muslabi64`, and `mips64el-unknown-linux-muslabi64` targets.][65843] \* Refer to Rust's [platform support page][forge-platform-support] for more information on Rust's tiered platform support. Libraries --------- - [The `is_power_of_two` method on unsigned numeric types is now a `const` function.][65092] Stabilized APIs --------------- - [`BTreeMap::get_key_value`] - [`HashMap::get_key_value`] - [`Option::as_deref_mut`] - [`Option::as_deref`] - [`Option::flatten`] - [`UdpSocket::peer_addr`] - [`f32::to_be_bytes`] - [`f32::to_le_bytes`] - [`f32::to_ne_bytes`] - [`f64::to_be_bytes`] - [`f64::to_le_bytes`] - [`f64::to_ne_bytes`] - [`f32::from_be_bytes`] - [`f32::from_le_bytes`] - [`f32::from_ne_bytes`] - [`f64::from_be_bytes`] - [`f64::from_le_bytes`] - [`f64::from_ne_bytes`] - [`mem::take`] - [`slice::repeat`] - [`todo!`] Cargo ----- - [Cargo will now always display warnings, rather than only on fresh builds.][cargo/7450] - [Feature flags (except `--all-features`) passed to a virtual workspace will now produce an error.][cargo/7507] Previously these flags were ignored. - [You can now publish `dev-dependencies` without including a `version`.][cargo/7333] Misc ---- - [You can now specify the `#[cfg(doctest)]` attribute to include an item only when running documentation tests with `rustdoc`.][63803] Compatibility Notes ------------------- - [As previously announced, any previous NLL warnings in the 2015 edition are now hard errors.][64221] - [The `include!` macro will now warn if it failed to include the entire file.][64284] The `include!` macro unintentionally only includes the first _expression_ in a file, and this can be unintuitive. This will become either a hard error in a future release, or the behavior may be fixed to include all expressions as expected. - [Using `#[inline]` on function prototypes and consts now emits a warning under `unused_attribute` lint.][65294] Using `#[inline]` anywhere else inside traits or `extern` blocks now correctly emits a hard error. [65294]: rust-lang/rust#65294 [66103]: rust-lang/rust#66103 [65843]: rust-lang/rust#65843 [65188]: rust-lang/rust#65188 [65092]: rust-lang/rust#65092 [64589]: rust-lang/rust#64589 [64639]: rust-lang/rust#64639 [64221]: rust-lang/rust#64221 [64284]: rust-lang/rust#64284 [63931]: rust-lang/rust#63931 [64035]: rust-lang/rust#64035 [63674]: rust-lang/rust#63674 [63803]: rust-lang/rust#63803 [cargo/7450]: rust-lang/cargo#7450 [cargo/7507]: rust-lang/cargo#7507 [cargo/7525]: rust-lang/cargo#7525 [cargo/7333]: rust-lang/cargo#7333 [(rfc 2008)]: https://rust-lang.github.io/rfcs/2008-non-exhaustive.html [`f32::to_be_bytes`]: https://doc.rust-lang.org/std/primitive.f32.html#method.to_be_bytes [`f32::to_le_bytes`]: https://doc.rust-lang.org/std/primitive.f32.html#method.to_le_bytes [`f32::to_ne_bytes`]: https://doc.rust-lang.org/std/primitive.f32.html#method.to_ne_bytes [`f64::to_be_bytes`]: https://doc.rust-lang.org/std/primitive.f64.html#method.to_be_bytes [`f64::to_le_bytes`]: https://doc.rust-lang.org/std/primitive.f64.html#method.to_le_bytes [`f64::to_ne_bytes`]: https://doc.rust-lang.org/std/primitive.f64.html#method.to_ne_bytes [`f32::from_be_bytes`]: https://doc.rust-lang.org/std/primitive.f32.html#method.from_be_bytes [`f32::from_le_bytes`]: https://doc.rust-lang.org/std/primitive.f32.html#method.from_le_bytes [`f32::from_ne_bytes`]: https://doc.rust-lang.org/std/primitive.f32.html#method.from_ne_bytes [`f64::from_be_bytes`]: https://doc.rust-lang.org/std/primitive.f64.html#method.from_be_bytes [`f64::from_le_bytes`]: https://doc.rust-lang.org/std/primitive.f64.html#method.from_le_bytes [`f64::from_ne_bytes`]: https://doc.rust-lang.org/std/primitive.f64.html#method.from_ne_bytes [`option::flatten`]: https://doc.rust-lang.org/std/option/enum.Option.html#method.flatten [`option::as_deref`]: https://doc.rust-lang.org/std/option/enum.Option.html#method.as_deref [`option::as_deref_mut`]: https://doc.rust-lang.org/std/option/enum.Option.html#method.as_deref_mut [`hashmap::get_key_value`]: https://doc.rust-lang.org/std/collections/struct.HashMap.html#method.get_key_value [`btreemap::get_key_value`]: https://doc.rust-lang.org/std/collections/struct.BTreeMap.html#method.get_key_value [`slice::repeat`]: https://doc.rust-lang.org/std/primitive.slice.html#method.repeat [`mem::take`]: https://doc.rust-lang.org/std/mem/fn.take.html [`udpsocket::peer_addr`]: https://doc.rust-lang.org/std/net/struct.UdpSocket.html#method.peer_addr [`todo!`]: https://doc.rust-lang.org/std/macro.todo.html

Remove version from dev-dependencies to make it easier to publish. Since #7333, released in 1.40, Cargo will strip dev-dependencies that don't have a version. These two crates aren't published to crates.io, and thus they have to be commented out each time a release is made. This change avoids that step.

Cargo will automatically strip dev-dependency for us, which removes the need for manually doing so before publishing the crates. See rust-lang/cargo#7333

Fix publishing with cargo release 1. Fix version specifications for in-repo packages in workspace Cargo.toml 2. Don't release butane_test_helper 3. Don't specify version for butane_test_helper when referencing it. This allows butane_core to be published despite the circular dev-dependency. See rust-lang/cargo#7333

Using a path avoids having to update the `uefi-macros` dep on `uefi` after releasing a new version of `uefi`, slightly simplifying our release process. Prior to cargo 1.40 there was no choice but to have a version on dev-dependencies. That changed with rust-lang/cargo#7333, and now you can publish a crate with a path-only dev dependency.

Allow publishing with dev-dependencies without a version.

d709c10

rust-highfive assigned nrc Sep 5, 2019

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

alexcrichton added the T-cargo Team: Cargo label Sep 6, 2019

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

Validate uploaded Cargo.toml contents.

e4345b2

alexcrichton mentioned this pull request Sep 12, 2019

Allow path versions for dev-dependencies rust-lang/crates.io#1789

Closed

6 tasks

ehuss mentioned this pull request Sep 17, 2019

Allow git+version dependency to be published. #7237

Merged

rust-highfive assigned alexcrichton and unassigned nrc Oct 3, 2019

rfcbot added final-comment-period FCP — a period for last comments before action is taken and removed proposed-final-comment-period An FCP proposal has started, but not yet signed off. labels Oct 3, 2019

rfcbot added the finished-final-comment-period FCP complete label Oct 13, 2019

ehuss mentioned this pull request Oct 30, 2019

Allow path-specific dependencies in [dev-dependencies] #3745

Closed

casey mentioned this pull request Nov 1, 2019

Note need to publish with nightly cargo casey/just#506

Merged

therealprof mentioned this pull request Nov 12, 2019

Point cargo-project at a fixed version probe-rs/probe-rs#73

Closed

woshilapin mentioned this pull request Dec 20, 2019

Add tests for transit_model_procmacro hove-io/transit_model#412

Merged

ehuss mentioned this pull request May 22, 2020

"path" dev-dependencies withou "version" are silently dropped #8268

Closed

ehuss mentioned this pull request Nov 30, 2020

Remove version from dev-dependencies to make it easier to publish. #8920

Merged

taiki-e mentioned this pull request Jan 6, 2021

Remove version from path dev-dependencies to make it easier to publish rust-lang/futures-rs#2305

Merged

This was referenced Feb 1, 2021

Add Wycheproof test vectors ycrypto/salty#5

Open

Remove version field from wycheproof* dev-deps to make Cargo publishable ycrypto/salty#13

Merged

Xanewok mentioned this pull request Jun 23, 2021

Facilitate publishing by removing version in codec dev-dependency paritytech/parity-scale-codec#276

Merged

ehuss added this to the 1.40.0 milestone Feb 6, 2022

steveej mentioned this pull request Feb 24, 2022

fetch proxy from bootstrap holochain/holochain#1242

Merged

2 tasks

Electron100 mentioned this pull request May 10, 2023

Fix publishing Electron100/butane#84

Merged

Morganamilo mentioned this pull request Jun 2, 2023

Cargo should strip features of dev dependencies #12225

Closed

SplittyDev mentioned this pull request Jul 6, 2023

Initial property test support AleoNet/snarkOS#2502

Merged

ryoqun mentioned this pull request Jul 10, 2023

Relax dcou dep. in order-crates-for-publishing.py solana-labs/solana#32432

Merged

epage mentioned this pull request Oct 14, 2023

Allow crates to be published with cyclic dev-dependencies #4242

Open

alexanderkjall mentioned this pull request Oct 20, 2023

add version information to dev-dependencies of gix-command Byron/gitoxide#1072

Closed

nicholasbishop mentioned this pull request Nov 12, 2023

uefi-macros: Change uefi dev-dependency from version to path rust-osdev/uefi-rs#998

Merged

2 tasks

KSaiAkshit mentioned this pull request Apr 24, 2024

feat: support for cargo binstall Feel-ix-343/markdown-oxide#58

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow publishing with dev-dependencies without a version. #7333

Allow publishing with dev-dependencies without a version. #7333

ehuss commented Sep 5, 2019

rust-highfive commented Sep 5, 2019

alexcrichton commented Sep 6, 2019

rfcbot commented Sep 6, 2019 •

edited by withoutboats

Loading

Eh2406 commented Sep 6, 2019

Mark-Simulacrum commented Sep 6, 2019

alexcrichton commented Sep 6, 2019

Mark-Simulacrum commented Sep 6, 2019

Eh2406 commented Sep 6, 2019

ehuss commented Sep 6, 2019

joshtriplett commented Sep 11, 2019 •

edited

Loading

Eh2406 commented Sep 11, 2019

alexcrichton commented Sep 27, 2019

Eh2406 commented Sep 27, 2019

alexcrichton commented Oct 3, 2019

alexcrichton commented Oct 3, 2019

rfcbot commented Oct 3, 2019

Allow publishing with dev-dependencies without a version. #7333

Allow publishing with dev-dependencies without a version. #7333

Conversation

ehuss commented Sep 5, 2019

rust-highfive commented Sep 5, 2019

alexcrichton commented Sep 6, 2019

rfcbot commented Sep 6, 2019 • edited by withoutboats Loading

Eh2406 commented Sep 6, 2019

Mark-Simulacrum commented Sep 6, 2019

alexcrichton commented Sep 6, 2019

Mark-Simulacrum commented Sep 6, 2019

Eh2406 commented Sep 6, 2019

ehuss commented Sep 6, 2019

joshtriplett commented Sep 11, 2019 • edited Loading

Eh2406 commented Sep 11, 2019

alexcrichton commented Sep 27, 2019

Eh2406 commented Sep 27, 2019

alexcrichton commented Oct 3, 2019

alexcrichton commented Oct 3, 2019

rfcbot commented Oct 3, 2019

rfcbot commented Sep 6, 2019 •

edited by withoutboats

Loading

joshtriplett commented Sep 11, 2019 •

edited

Loading