Various CI improvements (#32)

* Add various CI improvements

* Consolidate and reorder jobs

* Add `--all-features` flag to `cargo doc`

Author: Nilirad

.github/workflows/ci.yaml

@@ -6,68 +6,29 @@ on:
   pull_request:
     branches: [main]
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 env:
   CARGO_TERM_COLOR: always
   CARGO_INCREMENTAL: 0
   CARGO_PROFILE_TEST_DEBUG: 0
   CARGO_PROFILE_DEV_DEBUG: 0
 
 jobs:
-  # Run cargo test --all-features
-  test:
-    name: Test Suite
+  # Check for typos
+  typos:
+    name: Spell Check
     runs-on: ubuntu-latest
-    timeout-minutes: 30
-    env:
-      RUSTFLAGS: "-C debuginfo=0 -D warnings"
+    timeout-minutes: 10
     steps:
       - name: Checkout sources
         uses: actions/checkout@v4
-      - name: Cache
-        uses: actions/cache@v4
-        with:
-          path: |
-            ~/.cargo/bin/
-            ~/.cargo/registry/index/
-            ~/.cargo/registry/cache/
-            ~/.cargo/git/db/
-            target/
-          key: ${{ runner.os }}-cargo-test-${{ hashFiles('**/Cargo.toml') }}
-      - name: Install stable toolchain
-        uses: dtolnay/rust-toolchain@stable
-      - name: Install Dependencies
-        run: sudo apt-get update; sudo apt-get install --no-install-recommends libasound2-dev libudev-dev libwayland-dev
-      - name: Run cargo test
-        run: cargo test --all-features
+      - name: Check for typos
+        uses: crate-ci/typos@v1
 
-  # Run cargo clippy --all-targets --all-features -- -D warnings
-  clippy_check:
-    name: Clippy
-    runs-on: ubuntu-latest
-    timeout-minutes: 30
-    steps:
-      - name: Checkout sources
-        uses: actions/checkout@v4
-      - name: Cache
-        uses: actions/cache@v4
-        with:
-          path: |
-            ~/.cargo/bin/
-            ~/.cargo/registry/index/
-            ~/.cargo/registry/cache/
-            ~/.cargo/git/db/
-            target/
-          key: ${{ runner.os }}-cargo-clippy-${{ hashFiles('**/Cargo.toml') }}
-      - name: Install stable toolchain
-        uses: dtolnay/rust-toolchain@stable
-        with:
-          components: clippy
-      - name: Install Dependencies
-        run: sudo apt-get update; sudo apt-get install --no-install-recommends libasound2-dev libudev-dev libwayland-dev
-      - name: Run clippy
-        run: cargo clippy --all-targets --all-features -- -D warnings
-
-  # Run cargo fmt --all -- --check
+  # Run `cargo fmt`
   format:
     name: Format
     runs-on: ubuntu-latest
@@ -82,29 +43,50 @@ jobs:
       - name: Run cargo fmt
         run: cargo fmt --all -- --check
 
-  # Run RUSTDOCFLAGS="-D warnings" cargo doc --workspace --document-private-items --no-deps
-  docs:
-    name: Docs
+  # Run `cargo test` (with dynamic linking) AND `cargo doc`
+  # Consolidated into one job to ensure reuse of build artifacts.
+  test:
+    name: Test Suite & Docs
+    needs: [typos, format]
     runs-on: ubuntu-latest
     timeout-minutes: 30
+    env:
+      RUSTFLAGS: "-C debuginfo=0 -D warnings"
     steps:
       - name: Checkout sources
         uses: actions/checkout@v4
-      - name: Cache
-        uses: actions/cache@v4
-        with:
-          path: |
-            ~/.cargo/bin/
-            ~/.cargo/registry/index/
-            ~/.cargo/registry/cache/
-            ~/.cargo/git/db/
-            target/
-          key: ${{ runner.os }}-cargo-doc-${{ hashFiles('**/Cargo.toml') }}
       - name: Install stable toolchain
         uses: dtolnay/rust-toolchain@stable
       - name: Install Dependencies
         run: sudo apt-get update; sudo apt-get install --no-install-recommends libasound2-dev libudev-dev libwayland-dev
+      - name: Rust Cache
+        uses: Swatinem/rust-cache@v2
+      - name: Run cargo test
+        run: cargo test --all-features --features "bevy/dynamic_linking"
       - name: Run cargo doc
         env:
           RUSTDOCFLAGS: "-D warnings"
-        run: cargo doc --workspace --document-private-items --no-deps
+        run: cargo doc --workspace --document-private-items --all-features --no-deps
+
+  # Run cargo clippy with various feature combinations
+  clippy_check:
+    name: Clippy
+    needs: [typos, format]
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    strategy:
+      matrix:
+        features: ["--no-default-features", "", "--all-features"]
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v4
+      - name: Install stable toolchain
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          components: clippy
+      - name: Install Dependencies
+        run: sudo apt-get update; sudo apt-get install --no-install-recommends libasound2-dev libudev-dev libwayland-dev
+      - name: Rust Cache
+        uses: Swatinem/rust-cache@v2
+      - name: Run clippy
+        run: cargo clippy --all-targets ${{ matrix.features }} -- -D warnings