Configuration
Shuttle versions
How Shuttle versioning works
- When you start or restart a project, a Shuttle
deployer
Docker container is started with the latest released version of Shuttle. - When you deploy something to that project, the version of your
shuttle-runtime
and othershuttle-...
cargo dependencies are recommended to be of the same version ofdeployer
, as there might be breaking changes between releases. - It is also recommended to keep
cargo-shuttle
up to date with the current version of the Shuttle API (see latest release).
Upgrading Shuttle version
Combining all of the above, these are the recommended steps for upgrading a Shuttle app.
Note: Please check the release page for any considerations regarding breaking changes in the new release.
-
Upgrade your
cargo-shuttle
CLI with one of the options below:curl -sSfL https://www.shuttle.rs/install | bash
(Linux and macOS)cargo binstall cargo-shuttle
cargo install cargo-shuttle
-
Update your project’s
shuttle-...
dependencies inCargo.toml
:Cargo.tomlshuttle-runtime = "0.44.0" # etc
-
Test that your project works with
cargo check
/cargo build
/cargo shuttle run
. -
Upgrade your project container with
cargo shuttle project restart
(remember to use--idle-minutes
if relevant). This will not delete any databases, and you will keep your project name. -
Finally, redeploy your Shuttle app:
cargo shuttle deploy
. (if you want to, commit your changes first)
Was this page helpful?