chore: v0.55.0 (#336)

jonaro00 · web-flow · commit fc1da1df0321 · 2025-05-21T11:11:46.000+02:00
* 0.55.0

* add rama example
diff --git a/docs/logs.mdx b/docs/logs.mdx
@@ -46,7 +46,7 @@ By default, Shuttle will set up a global tracing subscriber behind the scenes.
 If you'd rather set up your own tracing or logging, you can opt-out by disabling the default features on `shuttle-runtime`:
 
 ```toml Cargo.toml
-shuttle-runtime = { version = "0.54.0", default-features = false }
+shuttle-runtime = { version = "0.55.0", default-features = false }
 ```
 
 With the default features enabled you can skip the step of initializing your subscriber when implementing [tracing](https://docs.rs/tracing/latest/tracing/)
diff --git a/docs/telemetry/getting-started.mdx b/docs/telemetry/getting-started.mdx
@@ -24,7 +24,7 @@ cargo add shuttle-runtime -F setup-otel-exporter
 The `shuttle-runtime` entry in your project's `Cargo.toml` should now look something like:
 
 ```toml
-shuttle-runtime = { version = "0.54.0", features = ["setup-otel-exporter"] }
+shuttle-runtime = { version = "0.55.0", features = ["setup-otel-exporter"] }
 ```
 > **Note:** Your specific entry may not be *identical*, that's OK. The important part is that `"setup-otel-exporter"` appears in the `features` array.
 
diff --git a/examples/actix-cookie-authentication.mdx b/examples/actix-cookie-authentication.mdx
@@ -33,8 +33,8 @@ edition = "2021"
 actix-identity = "0.6.0"
 actix-session = { version = "0.8.0", features = ["cookie-session"] }
 actix-web = "4.3.1"
-shuttle-actix-web = "0.54.0"
-shuttle-runtime = "0.54.0"
+shuttle-actix-web = "0.55.0"
+shuttle-runtime = "0.55.0"
 tokio = "1.26.0"
 ```
 Your `main.rs` should look like this:
diff --git a/examples/actix-postgres.mdx b/examples/actix-postgres.mdx
@@ -117,10 +117,10 @@ edition = "2021"
 
 [dependencies]
 actix-web = "4.3.1"
-shuttle-actix-web = "0.54.0"
-shuttle-runtime = "0.54.0"
+shuttle-actix-web = "0.55.0"
+shuttle-runtime = "0.55.0"
 serde = "1.0.148"
-shuttle-shared-db = { version = "0.54.0", features = ["postgres", "sqlx"] }
+shuttle-shared-db = { version = "0.55.0", features = ["postgres", "sqlx"] }
 sqlx = "0.8.2"
 tokio = "1.26.0"
 ```
diff --git a/examples/actix-static-files.mdx b/examples/actix-static-files.mdx
@@ -59,8 +59,8 @@ edition = "2021"
 [dependencies]
 actix-web = "4.3.1"
 actix-files = "0.6.2"
-shuttle-actix-web = "0.54.0"
-shuttle-runtime = "0.54.0"
+shuttle-actix-web = "0.55.0"
+shuttle-runtime = "0.55.0"
 tokio = "1.26.0"
 ```
 
diff --git a/examples/actix-websocket-actorless.mdx b/examples/actix-websocket-actorless.mdx
@@ -405,8 +405,8 @@ futures = "0.3"
 reqwest = "0.11"
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
-shuttle-actix-web = "0.54.0"
-shuttle-runtime = "0.54.0"
+shuttle-actix-web = "0.55.0"
+shuttle-runtime = "0.55.0"
 tokio = { version = "1", features = ["rt-multi-thread", "sync"] }
 tracing = "0.1"
 ```
diff --git a/examples/actix.mdx b/examples/actix.mdx
@@ -46,8 +46,8 @@ edition = "2021"
 
 [dependencies]
 actix-web = "4.3.1"
-shuttle-actix-web = "0.54.0"
-shuttle-runtime = "0.54.0"
+shuttle-actix-web = "0.55.0"
+shuttle-runtime = "0.55.0"
 tokio = "1.26.0"
 ```
 </CodeGroup>
diff --git a/examples/axum-jwt-authentication.mdx b/examples/axum-jwt-authentication.mdx
@@ -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.54.0"
-shuttle-runtime = "0.54.0"
+shuttle-axum = "0.55.0"
+shuttle-runtime = "0.55.0"
 tokio = "1.28.2"
 tracing-subscriber = "0.3.17"
 ```
diff --git a/examples/axum-postgres.mdx b/examples/axum-postgres.mdx
@@ -102,9 +102,9 @@ edition = "2021"
 [dependencies]
 axum = "0.7.3"
 serde = { version = "1.0.188", features = ["derive"] }
-shuttle-axum = "0.54.0"
-shuttle-runtime = "0.54.0"
-shuttle-shared-db = { version = "0.54.0", features = ["postgres", "sqlx"] }
+shuttle-axum = "0.55.0"
+shuttle-runtime = "0.55.0"
+shuttle-shared-db = { version = "0.55.0", features = ["postgres", "sqlx"] }
 sqlx = "0.8.2"
 tokio = "1.28.2"
 ```
diff --git a/examples/axum-static-files.mdx b/examples/axum-static-files.mdx
@@ -58,8 +58,8 @@ publish = false
 
 [dependencies]
 axum = "0.7.3"
-shuttle-axum = "0.54.0"
-shuttle-runtime = "0.54.0"
+shuttle-axum = "0.55.0"
+shuttle-runtime = "0.55.0"
 tokio = "1.28.2"
 tower-http = { version = "0.5.0", features = ["fs"] }
 ```
diff --git a/examples/axum-websockets.mdx b/examples/axum-websockets.mdx
@@ -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.54.0"
-shuttle-runtime = "0.54.0"
+shuttle-axum = "0.55.0"
+shuttle-runtime = "0.55.0"
 tokio = "1.28.2"
 tower-http = { version = "0.5.0", features = ["fs"] }
 ```
diff --git a/examples/axum.mdx b/examples/axum.mdx
@@ -44,8 +44,8 @@ edition = "2021"
 
 [dependencies]
 axum = "0.7.4"
-shuttle-axum = "0.54.0"
-shuttle-runtime = "0.54.0"
+shuttle-axum = "0.55.0"
+shuttle-runtime = "0.55.0"
 tokio = "1.28.2"
 ```
 </CodeGroup>
diff --git a/examples/other.mdx b/examples/other.mdx
@@ -1,6 +1,6 @@
 ---
 title: "Other Examples"
-description: "This section contains examples for the following frameworks: Tower, Warp, Salvo, Poem, Thruster, and Tide."
+description: "This section contains examples for the following frameworks: Rama, Tower, Warp, Salvo, Poem, Thruster, and Tide."
 ---
 
 ### Hello World
@@ -12,6 +12,47 @@ In order to get started, initialize your project with `shuttle init` and pick th
 Once you are done, your project should be setup with all the required dependencies so go ahead and copy/paste the relevant code snippet from below into your `main.rs` file.
 
 <CodeGroup>
+```rust Rama
+use rama::{
+    Context, Layer,
+    error::ErrorContext,
+    http::{
+        StatusCode,
+        layer::forwarded::GetForwardedHeaderLayer,
+        service::web::{Router, response::Result},
+    },
+    net::forwarded::Forwarded,
+};
+
+async fn hello_world(ctx: Context<()>) -> Result<String> {
+    Ok(match ctx.get::<Forwarded>() {
+        Some(forwarded) => format!(
+            "Hello cloud user @ {}!",
+            forwarded
+                .client_ip()
+                .context("missing IP information from user")
+                .map_err(|err| (StatusCode::INTERNAL_SERVER_ERROR, err.to_string()))?
+        ),
+        None => "Hello local user! Are you developing?".to_owned(),
+    })
+}
+
+#[shuttle_runtime::main]
+async fn main() -> Result<impl shuttle_rama::ShuttleService, shuttle_rama::ShuttleError> {
+    let router = Router::new().get("/", hello_world);
+
+    let app =
+        // Shuttle sits behind a load-balancer,
+        // so in case you want the real IP of the user,
+        // you need to ensure this headers is handled.
+        //
+        // Learn more at <https://docs.shuttle.dev/docs/deployment-environment#https-traffic>
+        GetForwardedHeaderLayer::x_forwarded_for().into_layer(router);
+
+    Ok(shuttle_rama::RamaService::application(app))
+}
+```
+
 ```rust Tower
 use std::convert::Infallible;
 use std::future::Future;
diff --git a/examples/poise.mdx b/examples/poise.mdx
@@ -72,9 +72,9 @@ publish = false
 [dependencies]
 anyhow = "1.0.68"
 poise = "0.6.1"
-shuttle-runtime = "0.54.0"
+shuttle-runtime = "0.55.0"
 # Since poise is a serenity command framework, it can run on Shuttle with shuttle-serenity
-shuttle-serenity = "0.54.0"
+shuttle-serenity = "0.55.0"
 tracing = "0.1.37"
 tokio = "1.26.0"
 ```
diff --git a/examples/rocket-jwt-authentication.mdx b/examples/rocket-jwt-authentication.mdx
@@ -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.54.0"
-shuttle-runtime = "0.54.0"
+shuttle-rocket = "0.55.0"
+shuttle-runtime = "0.55.0"
 tokio = "1.26.0"
 ```
 Your `main.rs` should look like this:
diff --git a/examples/rocket-postgres.mdx b/examples/rocket-postgres.mdx
@@ -104,9 +104,9 @@ edition = "2021"
 [dependencies]
 rocket = { version = "0.5.0", features = ["json"] }
 serde = "1.0.148"
-shuttle-rocket = "0.54.0"
-shuttle-runtime = "0.54.0"
-shuttle-shared-db = { version = "0.54.0", features = ["postgres", "sqlx"] }
+shuttle-rocket = "0.55.0"
+shuttle-runtime = "0.55.0"
+shuttle-shared-db = { version = "0.55.0", features = ["postgres", "sqlx"] }
 sqlx = "0.8.2"
 tokio = "1.26.0"
 ```
diff --git a/examples/rocket-static-files.mdx b/examples/rocket-static-files.mdx
@@ -76,8 +76,8 @@ publish = false
 
 [dependencies]
 rocket = "0.5.0"
-shuttle-rocket = "0.54.0"
-shuttle-runtime = "0.54.0"
+shuttle-rocket = "0.55.0"
+shuttle-runtime = "0.55.0"
 tokio = "1.26.0"
 ```
 
diff --git a/examples/rocket.mdx b/examples/rocket.mdx
@@ -44,8 +44,8 @@ edition = "2021"
 
 [dependencies]
 rocket = "0.5.0"
-shuttle-rocket = "0.54.0"
-shuttle-runtime = "0.54.0"
+shuttle-rocket = "0.55.0"
+shuttle-runtime = "0.55.0"
 tokio = "1.26.0"
 ```
 </CodeGroup>
diff --git a/examples/serenity-todo.mdx b/examples/serenity-todo.mdx
@@ -270,9 +270,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.54.0"
-shuttle-serenity = "0.54.0"
-shuttle-shared-db = { version = "0.54.0", features = ["postgres", "sqlx"] }
+shuttle-runtime = "0.55.0"
+shuttle-serenity = "0.55.0"
+shuttle-shared-db = { version = "0.55.0", features = ["postgres", "sqlx"] }
 sqlx = "0.8.2"
 tokio = "1.26.0"
 tracing = "0.1.37"
diff --git a/examples/serenity.mdx b/examples/serenity.mdx
@@ -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.54.0"
-shuttle-serenity = "0.54.0"
+shuttle-runtime = "0.55.0"
+shuttle-serenity = "0.55.0"
 tokio = "1.26.0"
 tracing = "0.1.37"
 ```
diff --git a/guides/upgrade.mdx b/guides/upgrade.mdx
@@ -15,7 +15,7 @@ icon: "code-merge"
 
 3. Update your project's Shuttle dependencies in `Cargo.toml`:
    ```toml Cargo.toml
-   shuttle-runtime = "0.54.0"
+   shuttle-runtime = "0.55.0"
    # do the same for other shuttle dependencies
    ```
 
diff --git a/integrations/custom-resources.mdx b/integrations/custom-resources.mdx
@@ -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.54.0"
-shuttle-axum = "0.54.0"
-shuttle-runtime = "0.54.0"
+shuttle-service = "0.55.0"
+shuttle-axum = "0.55.0"
+shuttle-runtime = "0.55.0"
 tokio = "1.28.2"
 ```
 </CodeGroup>
diff --git a/platform-update/migration.mdx b/platform-update/migration.mdx
@@ -55,7 +55,7 @@ This is the list of required changes.
 Update to the latest version of Shuttle dependencies:
 
 ```toml Cargo.toml
-shuttle-runtime = "0.54.0"
+shuttle-runtime = "0.55.0"
 # do the same for all other shuttle crates
 ```
 
diff --git a/templates/tutorials/custom-service.mdx b/templates/tutorials/custom-service.mdx
@@ -48,7 +48,7 @@ axum = "0.6.4"
 hyper = "0.14.24"
 poise = "0.5.2"
 serde = "1.0"
-shuttle-runtime = "0.54.0"
+shuttle-runtime = "0.55.0"
 tokio = "1.26.0"
 ```
 
diff --git a/templates/tutorials/url-shortener.mdx b/templates/tutorials/url-shortener.mdx
@@ -130,8 +130,8 @@ edition = "2021"
 
 [dependencies]
 rocket = "0.5.0"
-shuttle-rocket = "0.54.0"
-shuttle-runtime = "0.54.0"
+shuttle-rocket = "0.55.0"
+shuttle-runtime = "0.55.0"
 tokio = "1.26.0"
 ```
 
@@ -153,8 +153,8 @@ $ shuttle deploy
    Compiling rocket_http v0.5.0
    Compiling rocket_codegen v0.5.0
    Compiling rocket v0.5.0
-   Compiling shuttle-rocket v0.54.0
-   Compiling shuttle-runtime v0.54.0
+   Compiling shuttle-rocket v0.55.0
+   Compiling shuttle-runtime v0.55.0
    Compiling url-shortener v0.1.0 (/opt/shuttle/crates/url-shortener)
     Finished dev [unoptimized + debuginfo] target(s) in 1m 01s
 
diff --git a/templates/tutorials/websocket-chat-app-js.mdx b/templates/tutorials/websocket-chat-app-js.mdx
@@ -256,8 +256,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.54.0"
-shuttle-runtime = "0.54.0"
+shuttle-axum = "0.55.0"
+shuttle-runtime = "0.55.0"
 sync_wrapper = "0.1"
 tokio = { version = "1", features = ["full"] }
 tower-http = { version = "0.3.5", features = ["fs", "auth"]}
diff --git a/welcome/introduction.mdx b/welcome/introduction.mdx
@@ -100,6 +100,7 @@ To make life easier we have implemented all the boilerplate required for these R
 - [Axum](/examples/axum)
 - [Actix Web](/examples/actix)
 - [Rocket](/examples/rocket)
+- [Rama](/examples/other)
 - [Warp](/examples/other)
 - [Tower](/examples/other)
 - [Salvo](/examples/other)
