Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: 0.47.0 #286

Merged
merged 6 commits into from
Jul 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions configuration/environment.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This page answers:

Deployments are currently built and run in our `shuttle-deployer` container, which is based on a Rust Bookworm docker image (Debian 12).

The current Rust version is `1.75.0`, toolchain `stable-x86_64-unknown-linux-gnu`.
The current Rust version is `1.79.0`, toolchain `stable-x86_64-unknown-linux-gnu`.
It's not currently possible for you to change this, but being able to choose which toolchain your project will be compiled with is a planned feature.

The target `wasm32-unknown-unknown` is installed, which enables compiling WASM frontends.
Expand All @@ -41,12 +41,12 @@ Additionally, these tools are installed:
## Environment variables

There are some environment variables set in the Shuttle container.
Check for `SHUTTLE=true` for custom behavior when running on Shuttle.
Check for `SHUTTLE=true` or use [the shuttle feature flag](./project-structure#cargo-feature-flags) for custom behavior when running on Shuttle.

```bash
SHUTTLE=true
RUST_VERSION="1.75.0"
RUSTUP_TOOLCHAIN="1.75.0"
RUST_VERSION="1.79.0"
RUSTUP_TOOLCHAIN="1.79.0"
```

### Build environment
Expand All @@ -69,6 +69,12 @@ rustflags = ["-C", "link-arg=-fuse-ld=/usr/bin/ld.lld"]

See [Shuttle Secrets](/resources/shuttle-secrets)

## Multiple environments

Multiple environments (such as development, staging and production) within a project is a planned feature.
Until that feature is ready, you can use a workflow of using one Shuttle project for each environment (for example `project` and `project-dev`).
To deploy to the non-default project name, you can use the `deploy` command with `--name` for targetting a different project, and `--secrets` to use a different secrets file.

## Limitations

<Warning>
Expand Down
6 changes: 6 additions & 0 deletions configuration/files.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,12 @@ You can double check which files are included in your deployment by turning on d
cargo shuttle --debug deploy
```

or inspect the archive after writing it to disk:

```bash
cargo shuttle deploy --output-archive deployment.tar
```

## Serving static files

Serving a web project often means that there are static HTML, CSS, or JavaScript files to serve.
Expand Down
2 changes: 1 addition & 1 deletion configuration/shuttle-versions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Combining all of the above, these are the recommended steps for upgrading a Shut

2. Update your project's `shuttle-...` dependencies in `Cargo.toml`:
```toml Cargo.toml
shuttle-runtime = "0.46.0"
shuttle-runtime = "0.47.0"
# etc
```

Expand Down
6 changes: 3 additions & 3 deletions examples/actix-postgres.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -117,10 +117,10 @@ edition = "2021"

[dependencies]
actix-web = "4.3.1"
shuttle-actix-web = "0.46.0"
shuttle-runtime = "0.46.0"
shuttle-actix-web = "0.47.0"
shuttle-runtime = "0.47.0"
serde = "1.0.148"
shuttle-shared-db = { version = "0.46.0", features = ["postgres", "sqlx"] }
shuttle-shared-db = { version = "0.47.0", features = ["postgres", "sqlx"] }
sqlx = "0.7.1"
tokio = "1.26.0"
```
Expand Down
4 changes: 2 additions & 2 deletions examples/actix-websocket-actorless.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -407,8 +407,8 @@ futures = "0.3"
reqwest = "0.11"
serde = { version = "1.0", features = ["derive"] }
serde_json = "1.0"
shuttle-actix-web = "0.46.0"
shuttle-runtime = "0.46.0"
shuttle-actix-web = "0.47.0"
shuttle-runtime = "0.47.0"
tokio = { version = "1", features = ["rt-multi-thread", "sync"] }
tracing = "0.1"
```
Expand Down
4 changes: 2 additions & 2 deletions examples/actix.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ edition = "2021"

[dependencies]
actix-web = "4.3.1"
shuttle-actix-web = "0.46.0"
shuttle-runtime = "0.46.0"
shuttle-actix-web = "0.47.0"
shuttle-runtime = "0.47.0"
tokio = "1.26.0"
```
</CodeGroup>
Expand Down
4 changes: 2 additions & 2 deletions examples/axum-jwt-authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -221,8 +221,8 @@ jsonwebtoken = "8.3.0"
once_cell = "1.18.0"
serde = { version = "1.0.188", features = ["derive"] }
serde_json = "1.0.107"
shuttle-axum = "0.46.0"
shuttle-runtime = "0.46.0"
shuttle-axum = "0.47.0"
shuttle-runtime = "0.47.0"
tokio = "1.28.2"
tracing-subscriber = "0.3.17"
```
Expand Down
6 changes: 3 additions & 3 deletions examples/axum-postgres.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -102,9 +102,9 @@ edition = "2021"
[dependencies]
axum = "0.7.3"
serde = { version = "1.0.188", features = ["derive"] }
shuttle-axum = "0.46.0"
shuttle-runtime = "0.46.0"
shuttle-shared-db = { version = "0.46.0", features = ["postgres", "sqlx"] }
shuttle-axum = "0.47.0"
shuttle-runtime = "0.47.0"
shuttle-shared-db = { version = "0.47.0", features = ["postgres", "sqlx"] }
sqlx = "0.7.1"
tokio = "1.28.2"
```
Expand Down
4 changes: 2 additions & 2 deletions examples/axum-static-files.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,8 @@ publish = false

[dependencies]
axum = "0.7.3"
shuttle-axum = "0.46.0"
shuttle-runtime = "0.46.0"
shuttle-axum = "0.47.0"
shuttle-runtime = "0.47.0"
tokio = "1.28.2"
tower-http = { version = "0.5.0", features = ["fs"] }
```
Expand Down
4 changes: 2 additions & 2 deletions examples/axum-websockets.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -266,8 +266,8 @@ futures = "0.3.28"
reqwest = "0.11.23"
serde = { version = "1.0.163", features = ["derive"] }
serde_json = "1.0.96"
shuttle-axum = "0.46.0"
shuttle-runtime = "0.46.0"
shuttle-axum = "0.47.0"
shuttle-runtime = "0.47.0"
tokio = "1.28.2"
tower-http = { version = "0.5.0", features = ["fs"] }
```
Expand Down
4 changes: 2 additions & 2 deletions examples/axum.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ edition = "2021"

[dependencies]
axum = "0.7.3"
shuttle-axum = "0.46.0"
shuttle-runtime = "0.46.0"
shuttle-axum = "0.47.0"
shuttle-runtime = "0.47.0"
tokio = "1.28.2"
```
</CodeGroup>
Expand Down
4 changes: 2 additions & 2 deletions examples/poise.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,9 @@ publish = false
[dependencies]
anyhow = "1.0.68"
poise = "0.6.1"
shuttle-runtime = "0.46.0"
shuttle-runtime = "0.47.0"
# Since poise is a serenity command framework, it can run on Shuttle with shuttle-serenity
shuttle-serenity = "0.46.0"
shuttle-serenity = "0.47.0"
tracing = "0.1.37"
tokio = "1.26.0"
```
Expand Down
4 changes: 2 additions & 2 deletions examples/rocket-jwt-authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ jsonwebtoken = { version = "8.1.1", default-features = false }
lazy_static = "1.4.0"
rocket = { version = "0.5.0", features = ["json"] }
serde = { version = "1.0.148", features = ["derive"] }
shuttle-rocket = "0.46.0"
shuttle-runtime = "0.46.0"
shuttle-rocket = "0.47.0"
shuttle-runtime = "0.47.0"
tokio = "1.26.0"
```
Your `main.rs` should look like this:
Expand Down
6 changes: 3 additions & 3 deletions examples/rocket-postgres.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -104,9 +104,9 @@ edition = "2021"
[dependencies]
rocket = { version = "0.5.0", features = ["json"] }
serde = "1.0.148"
shuttle-rocket = "0.46.0"
shuttle-runtime = "0.46.0"
shuttle-shared-db = { version = "0.46.0", features = ["postgres", "sqlx"] }
shuttle-rocket = "0.47.0"
shuttle-runtime = "0.47.0"
shuttle-shared-db = { version = "0.47.0", features = ["postgres", "sqlx"] }
sqlx = "0.7.1"
tokio = "1.26.0"
```
Expand Down
4 changes: 2 additions & 2 deletions examples/rocket-static-files.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,8 @@ publish = false

[dependencies]
rocket = "0.5.0"
shuttle-rocket = "0.46.0"
shuttle-runtime = "0.46.0"
shuttle-rocket = "0.47.0"
shuttle-runtime = "0.47.0"
tokio = "1.26.0"
```

Expand Down
4 changes: 2 additions & 2 deletions examples/rocket.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ edition = "2021"

[dependencies]
rocket = "0.5.0"
shuttle-rocket = "0.46.0"
shuttle-runtime = "0.46.0"
shuttle-rocket = "0.47.0"
shuttle-runtime = "0.47.0"
tokio = "1.26.0"
```
</CodeGroup>
Expand Down
6 changes: 3 additions & 3 deletions examples/serenity-todo.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -269,9 +269,9 @@ edition = "2021"
anyhow = "1.0.66"
serde = "1.0.148"
serenity = { version = "0.12.0", default-features = false, features = ["client", "gateway", "rustls_backend", "model"] }
shuttle-runtime = "0.46.0"
shuttle-serenity = "0.46.0"
shuttle-shared-db = { version = "0.46.0", features = ["postgres", "sqlx"] }
shuttle-runtime = "0.47.0"
shuttle-serenity = "0.47.0"
shuttle-shared-db = { version = "0.47.0", features = ["postgres", "sqlx"] }
sqlx = "0.7.1"
tokio = "1.26.0"
tracing = "0.1.37"
Expand Down
4 changes: 2 additions & 2 deletions examples/serenity.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,8 @@ edition = "2021"
[dependencies]
anyhow = "1.0.66"
serenity = { version = "0.12.0", default-features = false, features = ["client", "gateway", "rustls_backend", "model"] }
shuttle-runtime = "0.46.0"
shuttle-serenity = "0.46.0"
shuttle-runtime = "0.47.0"
shuttle-serenity = "0.47.0"
tokio = "1.26.0"
tracing = "0.1.37"
```
Expand Down
2 changes: 0 additions & 2 deletions getting-started/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,6 @@ Although a bit slower, you can also install directly with cargo:
cargo install cargo-shuttle
```

<Note>Installing cargo-shuttle from source requires Rust 1.75+. You can verify by running `cargo --version`.</Note>

### Distro packages (unofficial)

`cargo-shuttle` is also packaged by community members for some distros:
Expand Down
5 changes: 5 additions & 0 deletions getting-started/shuttle-commands.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -98,3 +98,8 @@ All project-related commands can use:
Use `cargo shuttle generate shell <shell>` with one of: bash, elvish, fish, powershell, zsh.

Example configuration for Zsh on Linux: add `eval "$(cargo shuttle generate shell zsh)"` to `~/.zshrc`.

### Utility

- `cargo shuttle --debug <command>`: Turn on tracing output for Shuttle libraries. (WARNING: can print sensitive data)
- `cargo shuttle deploy --output-archive <path>`: Dump the deployment archive to disk instead of deploying it. Useful for debugging.
6 changes: 3 additions & 3 deletions resources/custom-resources.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -91,9 +91,9 @@ edition = "2021"
async-trait = "0.1.56"
axum = "0.7.3"
serde = { version = "1.0.148", default-features = false, features = ["derive"] }
shuttle-service = "0.46.0"
shuttle-axum = "0.46.0"
shuttle-runtime = "0.46.0"
shuttle-service = "0.47.0"
shuttle-axum = "0.47.0"
shuttle-runtime = "0.47.0"
tokio = "1.28.2"
```
</CodeGroup>
2 changes: 1 addition & 1 deletion templates/tutorials/custom-service.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ axum = "0.6.4"
hyper = "0.14.24"
poise = "0.5.2"
serde = "1.0"
shuttle-runtime = "0.46.0"
shuttle-runtime = "0.47.0"
tokio = "1.26.0"
```

Expand Down
8 changes: 4 additions & 4 deletions templates/tutorials/url-shortener.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -129,8 +129,8 @@ edition = "2021"

[dependencies]
rocket = "0.5.0"
shuttle-rocket = "0.46.0"
shuttle-runtime = "0.46.0"
shuttle-rocket = "0.47.0"
shuttle-runtime = "0.47.0"
tokio = "1.26.0"
```

Expand All @@ -152,8 +152,8 @@ $ cargo shuttle deploy
Compiling rocket_http v0.5.0
Compiling rocket_codegen v0.5.0
Compiling rocket v0.5.0
Compiling shuttle-rocket v0.46.0
Compiling shuttle-runtime v0.46.0
Compiling shuttle-rocket v0.47.0
Compiling shuttle-runtime v0.47.0
Compiling url-shortener v0.1.0 (/opt/shuttle/crates/url-shortener)
Finished dev [unoptimized + debuginfo] target(s) in 1m 01s

Expand Down
4 changes: 2 additions & 2 deletions templates/tutorials/websocket-chat-app-js.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -257,8 +257,8 @@ hyper = { version = "0.14", features = ["client", "http2"] }
hyper-tls = "0.5"
serde = { version = "1.0", features = ["derive"] }
serde_json = "1.0"
shuttle-axum = "0.46.0"
shuttle-runtime = "0.46.0"
shuttle-axum = "0.47.0"
shuttle-runtime = "0.47.0"
sync_wrapper = "0.1"
tokio = { version = "1", features = ["full"] }
tower-http = { version = "0.3.5", features = ["fs", "auth"]}
Expand Down
Loading