Merge pull request #55 from jscatena88/integrate-cargo-make

.github/workflows/firmware.yml

@@ -1,7 +1,19 @@
-name: Firmware CI Checks
+name: Firmware Checks
 
 on:
-  push
+  push:
+    branches:
+      - master
+      - dev-*
+    paths-ignore:
+      - '*.py'
+      - 'inputmodule-control/**'
+  pull_request:
+    branches:
+      - '*'
+    paths-ignore:
+      - '*.py'
+      - 'inputmodule-control/**'
 
 env:
   CARGO_TERM_COLOR: always
@@ -17,22 +29,22 @@ jobs:
       - name: Setup Rust toolchain
         run: rustup show
 
+      - run: cargo install cargo-make
+
       - run: cargo install flip-link
-      - run: cargo build -p ledmatrix
-      - run: cargo build -p b1display
-      - run: cargo build -p c1minimal
-      - run: cargo build -p ledmatrix --release
-      - run: cargo build -p b1display --release
-      - run: cargo build -p c1minimal --release
+      - run: cargo make --cwd b1display
+      - run: cargo make --cwd c1minimal
+      - run: cargo make --cwd ledmatrix build-release
+      - run: cargo make --cwd b1display build-release
+      - run: cargo make --cwd c1minimal build-release
 
       - name: Convert to UF2 format
         run: |
             sudo apt-get update
             sudo apt-get install -y libudev-dev
-            cargo install elf2uf2-rs
-            elf2uf2-rs target/thumbv6m-none-eabi/release/b1display b1display.uf2
-            elf2uf2-rs target/thumbv6m-none-eabi/release/c1minimal c1minimal.uf2
-            elf2uf2-rs target/thumbv6m-none-eabi/release/ledmatrix ledmatrix.uf2
+            cargo make --cwd b1display uf2
+            cargo make --cwd c1minimal uf2
+            cargo make --cwd ledmatrix uf2
 
       - name: Upload UF2 files
         uses: actions/upload-artifact@v3
@@ -47,9 +59,9 @@ jobs:
         run: |
             sudo apt-get update
             sudo apt-get install -y llvm
-            llvm-objcopy -O binary target/thumbv6m-none-eabi/release/b1display b1display.bin
-            llvm-objcopy -O binary target/thumbv6m-none-eabi/release/c1minimal c1minimal.bin
-            llvm-objcopy -O binary target/thumbv6m-none-eabi/release/ledmatrix ledmatrix.bin
+            cargo make --cwd b1display bin
+            cargo make --cwd c1minimal bin
+            cargo make --cwd ledmatrix bin
 
       - name: Upload bin files
         uses: actions/upload-artifact@v3
@@ -65,8 +77,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-        with:
-          submodules: true
 
       - name: Setup Rust toolchain
         run: rustup show
@@ -93,8 +103,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-        with:
-          submodules: true
 
       - name: Setup Rust toolchain
         run: rustup show

.github/workflows/software.yml

@@ -1,6 +1,23 @@
-name: Software CI Checks
+name: Software Checks
+
 on:
   push:
+    branches:
+      - master
+      - dev-*
+    paths-ignore:
+      - 'b1display/**'
+      - 'c1minimal/**'
+      - 'fl16-inputmodules/**'
+      - 'ledmatrix/**'
+  pull_request:
+    branches:
+      - '*'
+    paths-ignore:
+      - 'b1display/**'
+      - 'c1minimal/**'
+      - 'fl16-inputmodules/**'
+      - 'ledmatrix/**'
 
 env:
   CARGO_TERM_COLOR: always
@@ -43,11 +60,13 @@ jobs:
     - name: Setup Rust toolchain
       run: rustup show
 
+    - run: cargo install cargo-make
+
     - name: Build Linux tool
-      run: cargo build --release --target x86_64-unknown-linux-gnu -p inputmodule-control
+      run: cargo make --cwd inputmodule-control build-release
 
     - name: Check if Linux tool can start
-      run: cargo run --release --target x86_64-unknown-linux-gnu -p inputmodule-control -- --help
+      run: cargo make --cwd inputmodule-control run -- --help | grep 'RAW HID and VIA commandline'
 
     - name: Upload Linux tool
       uses: actions/upload-artifact@v3
@@ -64,11 +83,13 @@ jobs:
     - name: Setup Rust toolchain
       run: rustup show
 
+    - run: cargo install cargo-make
+
     - name: Build Windows tool
-      run: cargo build --release --target x86_64-pc-windows-msvc -p inputmodule-control
+      run: cargo make --cwd inputmodule-control build-release
 
     - name: Check if Windows tool can start
-      run: cargo run --release --target x86_64-pc-windows-msvc -p inputmodule-control -- --help
+      run: cargo make --cwd inputmodule-control run -- --help | grep 'RAW HID and VIA commandline'
 
     - name: Upload Windows App
       uses: actions/upload-artifact@v3

.github/workflows/traditional-cargo.yml

@@ -0,0 +1,99 @@
+# Test builds without cargo-make
+# Not the recommended path, but should make sure it still works
+name: Traditional Cargo Workflow
+
+on:
+  push:
+    branches:
+      - master
+      - dev-*
+    paths-ignore:
+      - '*.py'
+  pull_request:
+    branches:
+      - '*'
+    paths-ignore:
+      - '*.py'
+
+env:
+  CARGO_TERM_COLOR: always
+  CARGO_NET_GIT_FETCH_WITH_CLI: true
+
+jobs:
+  firmware:
+    name: Building
+    runs-on: [ubuntu-latest]
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup Rust toolchain
+        run: rustup show
+
+      - run: cargo install flip-link
+
+      - run: cargo build -p ledmatrix
+      - run: cargo build -p b1display
+      - run: cargo build -p c1minimal
+
+  linux-software:
+    name: Build Linux
+    runs-on: ubuntu-22.04
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Install dependencies
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y libudev-dev libasound2-dev
+
+    - name: Setup Rust toolchain
+      run: rustup show
+
+    - name: Build tool
+      run: cargo build --release --target x86_64-unknown-linux-gnu -p inputmodule-control
+
+    - name: Check if tool can start
+      run: cargo run --release --target x86_64-unknown-linux-gnu -p inputmodule-control -- --help | grep 'RAW HID and VIA commandline'
+
+  windows-software:
+    name: Build Windows
+    runs-on: windows-2022
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Setup Rust toolchain
+      run: rustup show
+
+    - run: cargo install cargo-make
+
+    - name: Build tool
+      run: cargo build --release --target x86_64-pc-windows-msvc -p inputmodule-control
+
+    - name: Check if tool can start
+      run: cargo run --release --target x86_64-pc-windows-msvc -p inputmodule-control -- --help | grep 'RAW HID and VIA commandline'
+
+  lint-format:
+    name: Lint and format check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y libudev-dev libasound2-dev
+
+      - name: Setup Rust toolchain
+        run: rustup show
+
+      - name: Firmware clippy
+        run: |
+          cargo clippy -p b1display -- --deny=warnings
+          cargo clippy -p c1minimal -- --deny=warnings
+          cargo clippy -p ledmatrix -- --deny=warnings
+
+      - name: Software clippy
+        run: cargo clippy --target x86_64-unknown-linux-gnu -p inputmodule-control -- -D warnings
+
+      - name: All cargo fmt
+        run: cargo fmt --all -- --check

Makefile.toml

@@ -0,0 +1,22 @@
+[env]
+TARGET_TRIPLE = "thumbv6m-none-eabi"
+CARGO_MAKE_EXTEND_WORKSPACE_MAKEFILE = true
+FEATURES = ""
+
+[tasks.build]
+args = [
+    "build",
+    "@@remove-empty(BUILD_TYPE)",
+    "--target",
+    "${TARGET_TRIPLE}",
+    "--features",
+    "${FEATURES}",
+]
+
+[tasks.build-release]
+clear = true
+env.BUILD_TYPE = "--release"
+run_task = "build"
+
+[tasks.test]
+disabled = true

README.md

@@ -131,23 +131,22 @@ Prepare Rust toolchain (once):
 ```sh
 rustup target install thumbv6m-none-eabi
 cargo install flip-link
-cargo install elf2uf2-rs --locked
 ```
 
 Build:
 
 ```sh
-cargo build -p ledmatrix
-cargo build -p b1display
-cargo build -p c1minimal
+cargo make --cwd ledmatrix
+cargo make --cwd b1display
+cargo make --cwd c1minimal
 ```
 
 Generate the UF2 update file:
 
 ```sh
-elf2uf2-rs target/thumbv6m-none-eabi/debug/ledmatrix ledmatrix.uf2
-elf2uf2-rs target/thumbv6m-none-eabi/debug/b1display b1dipslay.uf2
-elf2uf2-rs target/thumbv6m-none-eabi/debug/c1minimal c1minimal.uf2
+cargo make --cwd ledmatrix uf2
+cargo make --cwd b1display uf2
+cargo make --cwd c1minimal uf2
 ```
 
 ## Building the Application
@@ -158,8 +157,11 @@ Currently have to specify the build target because it's not possible to specify
 Tracking issue: https://github.com/rust-lang/cargo/issues/9406
 
 ```
-> cargo build --target x86_64-unknown-linux-gnu -p inputmodule-control
-> cargo run --target x86_64-unknown-linux-gnu -p inputmodule-control
+# Build it
+> cargo make --cwd inputmodule-control
+
+# Build and run it, showing the tool version
+> cargo make --cwd inputmodule-control run -- --version
 ```
 
 ### Check the firmware version of the device

b1display/Makefile.toml

@@ -0,0 +1,12 @@
+extend = "../Makefile.toml"
+
+[tasks.uf2]
+command = "elf2uf2-rs"
+args = ["../target/thumbv6m-none-eabi/release/b1display", "../target/thumbv6m-none-eabi/release/b1display.uf2"]
+dependencies = ["build-release"]
+install_crate = "elf2uf2-rs"
+
+[tasks.bin]
+command = "llvm-objcopy"
+args = ["-Obinary", "../target/thumbv6m-none-eabi/release/b1display", "../target/thumbv6m-none-eabi/release/b1display.bin"]
+dependencies = ["build-release"]

c1minimal/Makefile.toml

@@ -0,0 +1,12 @@
+extend = "../Makefile.toml"
+
+[tasks.uf2]
+command = "elf2uf2-rs"
+args = ["../target/thumbv6m-none-eabi/release/c1minimal", "../target/thumbv6m-none-eabi/release/c1minimal.uf2"]
+dependencies = ["build-release"]
+install_crate = "elf2uf2-rs"
+
+[tasks.bin]
+command = "llvm-objcopy"
+args = ["-Obinary", "../target/thumbv6m-none-eabi/release/c1minimal", "../target/thumbv6m-none-eabi/release/c1minimal.bin"]
+dependencies = ["build-release"]

fl16-inputmodules/Makefile.toml

@@ -0,0 +1,21 @@
+extend = "../Makefile.toml"
+
+[tasks.build-all]
+run_task = { name = [
+    "build-ledmatrix",
+    "build-b1display",
+    "build-c1minimal",
+], parallel = true }
+
+
+[tasks.build-ledmatrix]
+env.FEATURES = "ledmatrix"
+run_task = "build"
+
+[tasks.build-b1display]
+env.FEATURES = "b1display"
+run_task = "build"
+
+[tasks.build-c1minimal]
+env.FEATURES = "c1minimal"
+run_task = "build"

fl16-inputmodules/src/lib.rs

@@ -1,6 +1,13 @@
 #![allow(clippy::needless_range_loop)]
 #![no_std]
 
+#[cfg(any(
+    all(feature = "ledmatrix", feature = "b1display"),
+    all(feature = "ledmatrix", feature = "c1minimal"),
+    all(feature = "b1display", feature = "c1minimal"),
+))]
+compile_error!("Features \"ledmatrix\", \"b1display\", and \"c1minimal\" are mutually exclusive");
+
 #[cfg(feature = "ledmatrix")]
 pub mod fl16;
 #[cfg(feature = "ledmatrix")]

inputmodule-control/Makefile.toml

@@ -0,0 +1,14 @@
+extend = "../Makefile.toml"
+
+# Since it's a tool, build it for the platform we're running on
+[env]
+TARGET_TRIPLE = "${CARGO_MAKE_RUST_TARGET_TRIPLE}"
+
+[tasks.run]
+command = "cargo"
+args = [
+    "run",
+    "--target",
+    "${CARGO_MAKE_RUST_TARGET_TRIPLE}",
+    "${@}",
+]

ledmatrix/Makefile.toml

@@ -0,0 +1,12 @@
+extend = "../Makefile.toml"
+
+[tasks.uf2]
+command = "elf2uf2-rs"
+args = ["../target/thumbv6m-none-eabi/release/ledmatrix", "../target/thumbv6m-none-eabi/release/ledmatrix.uf2"]
+dependencies = ["build-release"]
+install_crate = "elf2uf2-rs"
+
+[tasks.bin]
+command = "llvm-objcopy"
+args = ["-Obinary", "../target/thumbv6m-none-eabi/release/ledmatrix", "../target/thumbv6m-none-eabi/release/ledmatrix.bin"]
+dependencies = ["build-release"]