From 63f6139af605f486d5eaaed1c69ed37274888b38 Mon Sep 17 00:00:00 2001
From: Clay McLeod <clay.l.mcleod@gmail.com>
Date: Wed, 4 Sep 2024 23:49:41 -0500
Subject: [PATCH] ci: adds continuous integration workflow

---
 .github/workflows/CI.yml | 52 ++++++++++++++++++++++++++++++++++++++++
 src/lib.rs               |  2 ++
 2 files changed, 54 insertions(+)
 create mode 100644 .github/workflows/CI.yml

diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
new file mode 100644
index 0000000..c4bfef6
--- /dev/null
+++ b/.github/workflows/CI.yml
@@ -0,0 +1,52 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  format:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v3
+      - name: Update Rust
+        run: rustup update nightly && rustup default nightly
+      - name: Install rustfmt
+        run: rustup component add rustfmt
+      - run: cargo fmt -- --check
+
+  lint:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v3
+      - name: Update Rust
+        run: rustup update stable && rustup default stable
+      - name: Install clippy
+        run: rustup component add clippy
+      - run: cargo clippy --all-features -- --deny warnings
+
+  test:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v3
+      - name: Update Rust
+        run: rustup update stable && rustup default stable
+      - run: cargo test --all-features
+
+  test-examples:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v3
+      - name: Update Rust
+        run: rustup update stable && rustup default stable
+      - run: cargo test --all-features --examples
+
+  docs:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v3
+      - name: Update Rust
+        run: rustup update stable && rustup default stable
+      - run: cargo doc
diff --git a/src/lib.rs b/src/lib.rs
index c96b2cd..1e39e88 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -21,6 +21,8 @@ pub type BoxedError = Box<dyn std::error::Error>;
 /// A simple example:
 ///
 /// ```rust
+/// use crankshaft::as_into_unwrap();
+///
 /// /// Services that can be registered within the engine.
 /// #[derive(Debug)]
 /// pub enum Service {