Skip to content

Publish shuttle-tokio as 1.0.0 - #327

Merged
sarsko merged 1 commit into
mainfrom
bump-shuttle-tokio-1
Sep 4, 2026
Merged

sarsko merged 1 commit into
mainfrom
bump-shuttle-tokio-1

Conversation

@sarsko

@sarsko sarsko commented Aug 22, 2026

Copy link
Copy Markdown
Contributor

The wrappers mirror the version of the crate they wrap, so that a downstream crate can depend on the wrapper using the same version requirement it would have used for the real crate:

Wrapper Version Wraps
shuttle-parking_lot 0.12.5 parking_lot 0.12
shuttle-dashmap 6.1.0 dashmap 6.1
shuttle-lazy_static 1.5.0 lazy_static 1.5
shuttle-rand 0.8.6 rand 0.8.6
shuttle-async-stream 0.3.6 async-stream 0.3.6
shuttle-tokio-util 0.7.0 tokio-util 0.7
shuttle-tokio-retry 0.3.0 tokio-retry 0.3
shuttle-tokio 0.1.0 tokio 1.x

shuttle-tokio was the odd one out. It also made wrappers/README.md contradict itself, telling users to write version = "1" in two places and version = "0.1.0" in a third.

This bumps it to 1.0.0 so it follows the same scheme as its siblings, and fixes the one stale reference in wrappers/README.md so all three examples agree.

Notes for review

  • This is a major version bump of an already-published crate — 0.1.0 is on crates.io. Under Cargo's rules 0.1.0 and 1.0.0 are separate incompatible lines, so anyone currently on version = "0.1" keeps resolving to 0.1.0 and is not broken by the release; they opt in by changing their requirement to 1.
  • Nothing in this repository depends on shuttle-tokio. It is a leaf that only downstream users consume, so the change is contained to its own manifest. Verified with grep -rn 'package = "shuttle-tokio"' --include=Cargo.toml, which matches only its own [package] name.
  • The shuttle-tokio README and crate docs use a VERSION_NUMBER placeholder rather than a literal, so they needed no change.
  • shuttle-tokio-stream stays at 0.1.0: tokio-stream is itself 0.1.x, so it already matches the scheme.
  • cargo check --workspace and cargo fmt --all -- --check clean with RUSTFLAGS=-Dwarnings.

No CHANGELOG entry, matching the convention that release-prep PRs aggregate them.

Relation to other open PRs


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

bkragl
bkragl previously approved these changes Sep 3, 2026
# Wrappers mirror the version of the crate they wrap, so that a downstream crate can depend on the
# wrapper using the same version requirement it would have used for the real crate. `tokio` is at
# 1.x, so this is too.
version = "1.0.0"

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

did we make a mistake in other wrappers?

like, shuttle-parking_lot is v0.12.5. seems like it should have been v0.12.0.

@sarsko
sarsko force-pushed the bump-shuttle-tokio-1 branch from e96f8ad to e4a9948 Compare September 3, 2026 22:43
The wrappers mirror the version of the crate they wrap, so that a downstream
crate can depend on the wrapper using the same version requirement it would
have used for the real crate. shuttle-parking_lot is 0.12.5 for parking_lot
0.12, shuttle-dashmap is 6.1.0 for dashmap 6.1, shuttle-lazy_static is 1.5.0
for lazy_static 1.5, shuttle-tokio-util is 0.7.0 for tokio-util 0.7, and so on.

shuttle-tokio was the exception: it wraps tokio 1.x but was published as
0.1.0. That also made wrappers/README.md self-contradictory, telling users to
write `version = "1"` in two places and `version = "0.1.0"` in a third.

Bump it to 1.0.0 so it follows the same scheme as its siblings, and fix the one
stale reference in wrappers/README.md so all three examples agree.

This is a major version bump of an already-published crate (0.1.0 is on
crates.io). Nothing in this repository depends on shuttle-tokio -- it is a leaf
that only downstream users consume -- so the change is contained to its own
manifest.
@sarsko
sarsko force-pushed the bump-shuttle-tokio-1 branch from e4a9948 to 7f13da0 Compare September 4, 2026 18:17
@sarsko
sarsko enabled auto-merge (squash) September 4, 2026 18:36
@sarsko
sarsko disabled auto-merge September 4, 2026 18:43
@sarsko
sarsko merged commit 6d2df4b into main Sep 4, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants