shuttle-hq · chesedo · Aug 21, 2023 · Aug 21, 2023 · Aug 21, 2023 · Aug 21, 2023
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -97,7 +97,7 @@ commands:
             shuttle-shared-db = { path = "$PWD/resources/shared-db" }
             shuttle-secrets = { path = "$PWD/resources/secrets" }
             shuttle-static-folder = { path = "$PWD/resources/static-folder" }
-            shuttle-service-info = { path = "$PWD/resources/service-info" }
+            shuttle-metadata = { path = "$PWD/resources/metadata" }
             shuttle-turso = { path = "$PWD/resources/turso" }
 
             shuttle-axum = { path = "$PWD/services/shuttle-axum" }
@@ -621,7 +621,7 @@ workflows:
                 - resources/persist
                 - resources/secrets
                 - resources/static-folder
-                - resources/service-info
+                - resources/metadata
                 - resources/turso
                 - services/shuttle-actix-web
                 - services/shuttle-axum
@@ -836,7 +836,7 @@ workflows:
                   "resources/secrets",
                   "resources/shared-db",
                   "resources/static-folder",
-                  "resources/service-info",
+                  "resources/metadata",
                   "resources/turso",
                 ]
           name: publish-<< matrix.path >>

diff --git a/DEVELOPING.md b/DEVELOPING.md
@@ -144,7 +144,7 @@ shuttle-persist = { path = "[base]/shuttle/resources/persist" }
 shuttle-shared-db = { path = "[base]/shuttle/resources/shared-db" }
 shuttle-secrets = { path = "[base]/shuttle/resources/secrets" }
 shuttle-static-folder = { path = "[base]/shuttle/resources/static-folder" }
-shuttle-service-info = { path = "[base]/shuttle/resources/service-info" }
+shuttle-metadata = { path = "[base]/shuttle/resources/metadata" }
 shuttle-turso = { path = "[base]/shuttle/resources/turso" }
 
 shuttle-axum = { path = "[base]/shuttle/services/shuttle-axum" }

diff --git a/Makefile b/Makefile
@@ -268,7 +268,7 @@ publish-resources: publish-resources/aws-rds \
 	publish-resources/persist \
 	publish-resources/shared-db \
 	publish-resources/static-folder \
-	publish-resources/service-info
+	publish-resources/metadata
 
 publish-cargo-shuttle: publish-resources/secrets
 	cd cargo-shuttle; cargo publish

diff --git a/deployer/prepare.sh b/deployer/prepare.sh
@@ -41,7 +41,7 @@ if [[ $PROD != "true" ]]; then
     shuttle-shared-db = { path = "/usr/src/shuttle/resources/shared-db" }
     shuttle-secrets = { path = "/usr/src/shuttle/resources/secrets" }
     shuttle-static-folder = { path = "/usr/src/shuttle/resources/static-folder" }
-    shuttle-service-info = { path = "/usr/src/shuttle/resources/service-info" }
+    shuttle-metadata = { path = "/usr/src/shuttle/resources/metadata" }
     shuttle-turso = { path = "/usr/src/shuttle/resources/turso" }
 
     shuttle-actix-web = { path = "/usr/src/shuttle/services/shuttle-actix-web" }

diff --git a/e2e/tests/integration/helpers/mod.rs b/e2e/tests/integration/helpers/mod.rs
@@ -46,7 +46,7 @@ shuttle-persist = {{ path = "{}" }}
 shuttle-shared-db = {{ path = "{}" }}
 shuttle-secrets = {{ path = "{}" }}
 shuttle-static-folder = {{ path = "{}" }}
-shuttle-service-info = {{ path = "{}" }}
+shuttle-metadata = {{ path = "{}" }}
 
 shuttle-axum = {{ path = "{}" }}
 shuttle-actix-web = {{ path = "{}" }}
@@ -72,7 +72,7 @@ shuttle-warp = {{ path = "{}" }}"#,
                         .display(),
                     WORKSPACE_ROOT
                         .join("resources")
-                        .join("service-info")
+                        .join("metadata")
                         .display(),
                     WORKSPACE_ROOT
                         .join("services")

diff --git a/resources/service-info/Cargo.toml → resources/metadata/Cargo.toml b/resources/service-info/Cargo.toml → resources/metadata/Cargo.toml
@@ -1,10 +1,10 @@
 [package]
-name = "shuttle-service-info"
+name = "shuttle-metadata"
 version = "0.24.0"
 edition = "2021"
 license = "Apache-2.0"
 description = "Plugin to get Shuttle service information"
-keywords = ["shuttle-service", "service-info"]
+keywords = ["shuttle-service", "metadata"]
 
 [dependencies]
 async-trait = "0.1.56"

diff --git a/resources/metadata/README.md b/resources/metadata/README.md
@@ -0,0 +1,22 @@
+# Shuttle Metadata
+
+This plugin allows applications to obtain certain information about their runtime environment.
+
+## Usage
+
+Add `shuttle-metadata` to the dependencies for your service.
+
+You can get this resource using the `shuttle_metadata::ShuttleServiceInfo` attribute to get a `ServiceInfo`. This struct will contain information such as the Shuttle service name.
+
+```rust
+#[shuttle_runtime::main]
+async fn app(
+    #[shuttle_metadata::ShuttleServiceInfo] service_info: shuttle_metadata::ServiceInfo,
+) -> __ { ... }
+```
+
+#### Example projects that use `shuttle-metadata`
+
+| Framework | Link                                                                                   |
+| --------- | -------------------------------------------------------------------------------------- |
+| Axum      | [axum example](https://github.com/shuttle-hq/shuttle-examples/tree/main/axum/metadata) |
diff --git a/resources/service-info/src/lib.rs → resources/metadata/src/lib.rs b/resources/service-info/src/lib.rs → resources/metadata/src/lib.rs
diff --git a/resources/service-info/README.md b/resources/service-info/README.md