Merge pull request #860 from jerrysxie/v0.2.0-to-main

Merge v0.2.0 into main

Author: jerrysxie

.github/copilot-instructions.md

@@ -6,7 +6,7 @@ This is an embedded controller (EC) services workspace — a collection of `no_s
 
 ## Build, Test, and Lint
 
-Toolchain: Rust 1.88 (`rust-toolchain.toml`), edition 2024. Targets: `x86_64-unknown-linux-gnu` (std/testing) and `thumbv8m.main-none-eabihf` (ARM Cortex-M33).
+Toolchain: Rust 1.90 (`rust-toolchain.toml`), edition 2024. Targets: `x86_64-unknown-linux-gnu` (std/testing) and `thumbv8m.main-none-eabihf` (ARM Cortex-M33).
 
 ```shell
 # Format
@@ -196,3 +196,13 @@ Basic development tools (git, cargo, editors) should not be listed.
 AI agents **must** verify their own identity (agent name and model version) before composing the `Assisted-by` trailer — do not assume or hard-code a model name from a previous session.
 
 AI agents **MUST NOT** add `Signed-off-by` tags. Only humans can certify the Developer Certificate of Origin.
+
+## Rust PR Review Instructions
+CI overview:
+* CI will build the project and run `cargo test` and `cargo clippy`.
+* Feature combinations are checked with `cargo hack`.
+* Do not comment on compile errors, compiler warnings, or clippy warnings.
+
+Pay special attention to...
+* code that uses async selection APIs such as `select`, `selectN`, `select_array`, `select_slice`, or is marked with a drop safety comment. These functions drop the futures that don't finish. Check that values are not lost when this happens.
+* code that could possibly panic or is marked with a panic safety comment.

.github/workflows/check.yml

@@ -31,6 +31,9 @@ concurrency:
   group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
   cancel-in-progress: true
 name: check
+env:
+  # Crates that require std and won't build on embedded-targets
+  STD_CRATES: "fw-update-interface-mocks"
 jobs:
 
   fmt:
@@ -93,6 +96,8 @@ jobs:
         # Get early warning of new lints which are regularly introduced in beta channels.
         toolchain: [stable, beta]
         target: [x86_64-unknown-linux-gnu, thumbv8m.main-none-eabihf]
+    env:
+      COMMON_HACK_ARGS: "--feature-powerset --mutually-exclusive-features=log,defmt,defmt-timestamp-uptime"
     steps:
       - uses: actions/checkout@v4
         with:
@@ -112,7 +117,11 @@ jobs:
       # intentionally no target specifier; see https://github.com/jonhoo/rust-ci-conf/pull/4
       # --feature-powerset runs for every combination of features
       - name: cargo hack
-        run: cargo hack --feature-powerset --mutually-exclusive-features=log,defmt,defmt-timestamp-uptime clippy --locked --target ${{ matrix.target }}
+        if: ${{ matrix.target == 'x86_64-unknown-linux-gnu' }}
+        run: cargo hack $COMMON_HACK_ARGS clippy --locked --target ${{ matrix.target }}
+      - name: cargo hack
+        if: ${{ matrix.target != 'x86_64-unknown-linux-gnu' }}
+        run: cargo hack $COMMON_HACK_ARGS clippy --exclude $STD_CRATES --locked --target ${{ matrix.target }}
 
   deny:
     # cargo-deny checks licenses, advisories, sources, and bans for
@@ -148,17 +157,35 @@ jobs:
           submodules: true
       - name: Install stable
         uses: dtolnay/rust-toolchain@stable
+        with:
+          # For grcov
+          components: llvm-tools
       - name: Download Cargo.lock files
         if: ${{ inputs.download-lockfiles }}
         uses: actions/download-artifact@v4
         with:
           name: updated-lock-files
       - name: cargo test
         run: cargo test --locked
+        env:
+          RUSTFLAGS: '-C instrument-coverage'
+          CARGO_INCREMENTAL: '0'
         # After ensuring tests pass, finally ensure the test code itself contains no clippy warnings
       - name: cargo clippy
         run: |
           cargo clippy --locked --tests
+      # Generate and upload test coverage report
+      - name: Install grcov
+        uses: taiki-e/install-action@grcov
+      - name: Generate test coverage report
+        run: |
+          grcov . --binary-path ./target/debug/deps -s . --branch --ignore-not-existing --ignore "/home/runner/*" -t html -o ./target/debug/coverage
+          grcov . --binary-path ./target/debug/deps -s . --branch --ignore-not-existing --ignore "/home/runner/*" -t markdown >> $GITHUB_STEP_SUMMARY
+      - name: Upload test coverage report
+        uses: actions/upload-artifact@v4
+        with:
+          name: test-coverage-report
+          path: ./target/debug/coverage
 
   msrv:
     # check that we can build using the minimal rust version that is specified by this crate
@@ -185,9 +212,15 @@ jobs:
         with:
           name: updated-lock-files
       - name: cargo +${{ matrix.msrv }} check
+        if: ${{ matrix.target == 'x86_64-unknown-linux-gnu' }}
         run: |
           cargo check -F log --locked --target ${{ matrix.target }}
           cargo check -F defmt --locked --target ${{ matrix.target }}
+      - name: cargo +${{ matrix.msrv }} check
+        if: ${{ matrix.target != 'x86_64-unknown-linux-gnu' }}
+        run: |
+          cargo check -F log --locked --workspace --exclude $STD_CRATES --target ${{ matrix.target }}
+          cargo check -F defmt --locked --workspace --exclude $STD_CRATES --target ${{ matrix.target }}
 
   check-arm-examples:
     runs-on: ubuntu-latest
@@ -239,6 +272,31 @@ jobs:
         run: |
           cargo clippy --locked
 
+  check-pico-de-gallo-examples:
+    runs-on: ubuntu-latest
+    # we use a matrix here just because env can't be used in job names
+    # https://docs.github.com/en/actions/learn-github-actions/contexts#context-availability
+    strategy:
+      fail-fast: false
+      matrix:
+        example_directory: ["examples/pico-de-gallo"]
+    name: ubuntu / check-examples
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+      - name: Install stable
+        uses: dtolnay/rust-toolchain@stable
+      - name: Download Cargo.lock files
+        if: ${{ inputs.download-lockfiles }}
+        uses: actions/download-artifact@v4
+        with:
+          name: updated-lock-files
+      - name: cargo clippy
+        working-directory: ${{ matrix.example_directory }}
+        run: |
+          cargo clippy --locked
+
   machete:
     # cargo-machete checks for unused dependencies in Cargo.toml files
     runs-on: ubuntu-latest

.vscode/settings.json

@@ -14,6 +14,7 @@
         "Cargo.toml",
         "examples/rt633/Cargo.toml",
         "examples/rt685s-evk/Cargo.toml",
-        "examples/std/Cargo.toml"
+        "examples/std/Cargo.toml",
+        "examples/pico-de-gallo/Cargo.toml"
     ]
-}
+}