Refactor CI workflows into a consolidated Rust CI pipeline.

Merged linting and testing workflows into a unified `rust.yml` file for better organization and efficiency. Updated README with a single badge reflecting the new "Rust CI" workflow. Introduced enhanced test configurations, including feature-specific and doctest runs.
malik672 · Jan 11, 2025 · fcd99c4 · fcd99c4
1 parent 3e138da
commit fcd99c4
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 49 deletions.
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml
@@ -1,4 +1,4 @@
-name: Rust Tests
+name: Rust CI
 
 on:
   push:
@@ -10,31 +10,57 @@ env:
   CARGO_TERM_COLOR: always
 
 jobs:
-  build:
-    name: Rust Tests
+  lint:
+    name: Rust Lint Check
     runs-on: ubuntu-latest
     timeout-minutes: 30
     steps:
       - uses: actions/checkout@v4
         with:
           submodules: recursive
-
       - name: Cache Cargo registry
         uses: actions/cache@v4
         with:
           path: |
             ~/.cargo/registry
             ~/.cargo/git
             target
-          key: ${{ runner.os }}-cargo-registry-${{ hashFiles('**/Cargo.lock') }}
+          key: ${{ runner.os }}-cargo-registry-${{ hashFiles('**/Cargo.toml') }}
           restore-keys: |
             ${{ runner.os }}-cargo-registry-
+      - name: Install Rust toolchain via rustup
+        run: |
+          rustup component add clippy
+          rustup component add rustfmt
+      - name: Check linting
+        run: cargo clippy --all-targets --all-features -- -D warnings
+      - name: Check formatting
+        run: cargo fmt --all -- --check
 
+  test:
+    needs: lint
+    name: Rust Tests
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+      - name: Cache Cargo registry
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cargo/registry
+            ~/.cargo/git
+            target
+          key: ${{ runner.os }}-cargo-registry-${{ hashFiles('**/Cargo.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-cargo-registry-
       - name: Build
         run: cargo build
-
-      - name: Run tests
+      - name: Run tests for default feature
         run: cargo test
-
-      - name: Run tests with all features
-        run: cargo test --all-features
+      - name: Run tests for std feature
+        run: cargo test --features std
+      - name: Run doc tests
+        run: cargo test --doc --all-features
diff --git a/README.md b/README.md
@@ -1,7 +1,6 @@
 # Uniswap SDK Core Rust
 
-[![Unit Tests](https://github.com/malik672/uniswap-sdk-core-rust/workflows/Rust%20Tests/badge.svg)](https://github.com/malik672/uniswap-sdk-core-rust/actions?query=workflow%3A%22Rust+Tests%22)
-[![Lint](https://github.com/malik672/uniswap-sdk-core-rust/workflows/Rust%20Linting/badge.svg)](https://github.com/malik672/uniswap-sdk-core-rust/actions?query=workflow%3A%22Rust%20Linting%22)
+[![Rust CI](https://github.com/malik672/uniswap-sdk-core-rust/actions/workflows/rust.yml/badge.svg)](https://github.com/malik672/uniswap-sdk-core-rust/actions/workflows/rust.yml)
 ![CodeRabbit Pull Request Reviews](https://img.shields.io/coderabbit/prs/github/malik672/uniswap-sdk-core-rust?logo=rust&label=CodeRabbit&color=orange)
 [![docs.rs](https://img.shields.io/docsrs/uniswap-sdk-core)](https://docs.rs/uniswap-sdk-core/latest)
 [![crates.io](https://img.shields.io/crates/v/uniswap-sdk-core.svg)](https://crates.io/crates/uniswap-sdk-core)