Run benches once during tests, don't just build them

datrs · Oct 5, 2023 · 68ef0e0 · 68ef0e0
1 parent e8024d1
commit 68ef0e0
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 4 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -44,6 +44,8 @@ jobs:
         cargo test --no-default-features --features js_interop_tests,async-std
         cargo test --no-default-features --features js_interop_tests,async-std,sparse
         cargo test --no-default-features --features js_interop_tests,async-std,sparse,cache
+        cargo test --benches --no-default-features --features tokio
+        cargo test --benches --no-default-features --features async-std
 
   test-windows:
     runs-on: windows-latest
@@ -67,6 +69,8 @@ jobs:
           cargo test --no-default-features --features async-std
           cargo test --no-default-features --features async-std,sparse
           cargo test --no-default-features --features async-std,sparse,cache
+          cargo test --benches --no-default-features --features tokio
+          cargo test --benches --no-default-features --features async-std
 
   test-macos:
     runs-on: macos-latest
@@ -90,6 +94,8 @@ jobs:
           cargo test --no-default-features --features js_interop_tests,async-std
           cargo test --no-default-features --features js_interop_tests,async-std,sparse
           cargo test --no-default-features --features js_interop_tests,async-std,sparse,cache
+          cargo test --benches --no-default-features --features tokio
+          cargo test --benches --no-default-features --features async-std
 
   build-extra:
     runs-on: ubuntu-latest
@@ -103,10 +109,6 @@ jobs:
         run: |
           cargo build --target=wasm32-unknown-unknown --no-default-features --features tokio
           cargo build --target=wasm32-unknown-unknown --no-default-features --features async-std
-      - name: Build benches
-        run: |
-          cargo build --benches --no-default-features --features tokio
-          cargo build --benches --no-default-features --features async-std
       - name: Build release
         run: |
           cargo build --release --no-default-features --features tokio

diff --git a/README.md b/README.md
@@ -64,6 +64,20 @@ cargo add hypercore
 This crate uses ``#![forbid(unsafe_code)]`` to ensure everythong is implemented in
 100% Safe Rust.
 
+## Development
+
+To test interoperability with Javascript, enable the `js_interop_tests` feature:
+
+```bash
+cargo test --features js_interop_tests
+```
+
+Run benches with:
+
+```bash
+cargo bench
+```
+
 ## Contributing
 
 Want to join us? Check out our ["Contributing" guide][contributing] and take a