Move embedded-hal to a subdir, add workspace, simplify CI.

rust-embedded · Sep 26, 2022 · 6d22f98 · 6d22f98
1 parent 3b6b07d
commit 6d22f98
Show file tree

Hide file tree

Showing 25 changed files with 55 additions and 187 deletions.
diff --git a/.github/workflows/ci-async.yml b/.github/workflows/ci-async.yml
diff --git a/.github/workflows/ci-bus.yml b/.github/workflows/ci-bus.yml
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
diff --git a/.github/workflows/clippy-async.yml b/.github/workflows/clippy-async.yml
diff --git a/.github/workflows/clippy-bus.yml b/.github/workflows/clippy-bus.yml
diff --git a/.github/workflows/clippy.yml b/.github/workflows/clippy.yml
@@ -5,14 +5,16 @@ on:
 
 name: Clippy check
 jobs:
-  clippy_check:
+  clippy:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
       - uses: actions-rs/toolchain@v1
         with:
           profile: minimal
-          toolchain: stable
+          # embedded-hal-async needs nightly.
+          # Use a pinned version to avoid spontaneous breakages (new clippy lints are added often)
+          toolchain: nightly-2022-09-05  
           override: true
           components: clippy
       - uses: actions-rs/clippy-check@v1

diff --git a/.github/workflows/rustfmt.yml b/.github/workflows/rustfmt.yml
@@ -16,9 +16,4 @@ jobs:
           toolchain: nightly
           override: true
           components: rustfmt
-      - uses: actions-rs/cargo@v1
-        with:
-          command: fmt
-          args: --all -- --check
-      - run: cargo fmt --all -- --check
-        working-directory: embedded-hal-async
+      - run: cargo fmt --check
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -3,35 +3,41 @@ on:
     branches: [ staging, trying, master ]
   pull_request:
 
-name: Test Suite
+name: Continuous integration
 
 env:
   RUSTFLAGS: '--deny warnings'
 
 jobs:
-  ci-linux-test:
+  test:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        rust: [stable]
+        # All generated code should be running on stable now
+        rust:
+          - stable
+          - 1.54.0  # MSRV
+          - nightly
 
-        include:
-          - rust: 1.54.0
-            TARGET: x86_64-unknown-linux-gnu
-
-          # Test nightly but don't fail
-          - rust: nightly
-            experimental: true
-            TARGET: x86_64-unknown-linux-gnu
+        # The default target we're compiling on and for
+        target:
+          - x86_64-unknown-linux-gnu
+          - thumbv6m-none-eabi
+          - thumbv7m-none-eabi
 
     steps:
       - uses: actions/checkout@v2
       - uses: actions-rs/toolchain@v1
         with:
           profile: minimal
           toolchain: ${{ matrix.rust }}
-          target: ${{ matrix.TARGET }}
+          target: ${{ matrix.target }}
           override: true
-      - uses: actions-rs/cargo@v1
-        with:
-          command: test
+
+      - run: sed -i '/nightly-only/d' Cargo.toml 
+        if: matrix.toolchain != 'nightly'
+
+      - run: cargo check --target=${{ matrix.target }}
+
+      - run: cargo test --target=${{ matrix.target }}
+        if: contains(matrix.target, 'linux')
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,16 +1,10 @@
-[package]
-authors = [
-  "The Embedded HAL Team <embedded-hal@teams.rust-embedded.org>",
-  "Jorge Aparicio <jorge@japaric.io>",
-  "Jonathan 'theJPster' Pallant <github@thejpster.org.uk>"
+[workspace]
+
+# CI removes lines containing 'nightly-only' when not building with nightly.
+members = [
+    "embedded-hal",
+    "embedded-hal-async",  # nightly-only
+    "embedded-hal-nb",
+    "embedded-hal-bus",
+    "embedded-can",
 ]
-categories = ["asynchronous", "embedded", "hardware-support", "no-std"]
-description = " A Hardware Abstraction Layer (HAL) for embedded systems "
-documentation = "https://docs.rs/embedded-hal"
-edition = "2018"
-keywords = ["hal", "IO"]
-license = "MIT OR Apache-2.0"
-name = "embedded-hal"
-readme = "README.md"
-repository = "https://github.com/rust-embedded/embedded-hal"
-version = "1.0.0-alpha.8"
diff --git a/embedded-can/Cargo.toml b/embedded-can/Cargo.toml
@@ -12,5 +12,5 @@ readme = "README.md"
 repository = "https://github.com/rust-embedded/embedded-hal"
 
 [dependencies]
-embedded-hal = { version = "=1.0.0-alpha.8", path = ".." }
+embedded-hal = { version = "=1.0.0-alpha.8", path = "../embedded-hal" }
 nb = "1"
diff --git a/embedded-hal-async/Cargo.toml b/embedded-hal-async/Cargo.toml
@@ -14,4 +14,4 @@ repository = "https://github.com/rust-embedded/embedded-hal"
 version = "0.1.0-alpha.1"
 
 [dependencies]
-embedded-hal = { version = "=1.0.0-alpha.8", path = ".." }
+embedded-hal = { version = "=1.0.0-alpha.8", path = "../embedded-hal" }
diff --git a/embedded-hal-bus/Cargo.toml b/embedded-hal-bus/Cargo.toml
@@ -14,4 +14,4 @@ repository = "https://github.com/rust-embedded/embedded-hal"
 version = "0.1.0-alpha.0"
 
 [dependencies]
-embedded-hal = { version = "=1.0.0-alpha.8", path = ".." }
+embedded-hal = { version = "=1.0.0-alpha.8", path = "../embedded-hal" }
diff --git a/embedded-hal-nb/Cargo.toml b/embedded-hal-nb/Cargo.toml
@@ -12,7 +12,7 @@ readme = "README.md"
 repository = "https://github.com/rust-embedded/embedded-hal"
 
 [dependencies]
-embedded-hal = { version = "=1.0.0-alpha.8", path = ".." }
+embedded-hal = { version = "=1.0.0-alpha.8", path = "../embedded-hal" }
 nb = "1"
 
 [dev-dependencies.stm32f1]

diff --git a/CHANGELOG.md → embedded-hal/CHANGELOG.md b/CHANGELOG.md → embedded-hal/CHANGELOG.md
diff --git a/embedded-hal/Cargo.toml b/embedded-hal/Cargo.toml
@@ -0,0 +1,16 @@
+[package]
+authors = [
+  "The Embedded HAL Team <embedded-hal@teams.rust-embedded.org>",
+  "Jorge Aparicio <jorge@japaric.io>",
+  "Jonathan 'theJPster' Pallant <github@thejpster.org.uk>"
+]
+categories = ["asynchronous", "embedded", "hardware-support", "no-std"]
+description = " A Hardware Abstraction Layer (HAL) for embedded systems "
+documentation = "https://docs.rs/embedded-hal"
+edition = "2018"
+keywords = ["hal", "IO"]
+license = "MIT OR Apache-2.0"
+name = "embedded-hal"
+readme = "README.md"
+repository = "https://github.com/rust-embedded/embedded-hal"
+version = "1.0.0-alpha.8"
diff --git a/LICENSE-APACHE → embedded-hal/LICENSE-APACHE b/LICENSE-APACHE → embedded-hal/LICENSE-APACHE
diff --git a/LICENSE-MIT → embedded-hal/LICENSE-MIT b/LICENSE-MIT → embedded-hal/LICENSE-MIT
diff --git a/README.md → embedded-hal/README.md b/README.md → embedded-hal/README.md
diff --git a/src/delay.rs → embedded-hal/src/delay.rs b/src/delay.rs → embedded-hal/src/delay.rs
diff --git a/src/digital.rs → embedded-hal/src/digital.rs b/src/digital.rs → embedded-hal/src/digital.rs
diff --git a/src/i2c.rs → embedded-hal/src/i2c.rs b/src/i2c.rs → embedded-hal/src/i2c.rs
diff --git a/src/lib.rs → embedded-hal/src/lib.rs b/src/lib.rs → embedded-hal/src/lib.rs
diff --git a/src/serial.rs → embedded-hal/src/serial.rs b/src/serial.rs → embedded-hal/src/serial.rs
diff --git a/src/spi-shared-bus.svg → embedded-hal/src/spi-shared-bus.svg b/src/spi-shared-bus.svg → embedded-hal/src/spi-shared-bus.svg
diff --git a/src/spi.rs → embedded-hal/src/spi.rs b/src/spi.rs → embedded-hal/src/spi.rs