From ce44c997045ac4fc717b82aedf3d1f7191ff3f9c Mon Sep 17 00:00:00 2001 From: Ryan Butler Date: Mon, 6 May 2024 17:46:50 -0400 Subject: [PATCH 1/2] mcu-util: rename to orb-mcu-util and add to CI release options --- .github/workflows/release.yaml | 1 + .github/workflows/rust-ci.yaml | 10 ++++----- Cargo.lock | 38 +++++++++++++++++----------------- mcu-util/Cargo.toml | 2 +- mcu-util/README.md | 2 +- 5 files changed, 27 insertions(+), 26 deletions(-) diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index 820482c1..3fce62f5 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -11,6 +11,7 @@ on: - orb-attest - orb-thermal-cam-ctrl - orb-ui + - orb-mcu-util channel: description: | Which release channel? diff --git a/.github/workflows/rust-ci.yaml b/.github/workflows/rust-ci.yaml index ee075ddc..535767d7 100644 --- a/.github/workflows/rust-ci.yaml +++ b/.github/workflows/rust-ci.yaml @@ -116,13 +116,13 @@ jobs: if: ${{ matrix.platform == 'macos-13' }} run: | MAC_EXCLUDE=( - "--exclude orb-thermal-cam-ctrl" - "--exclude seek-camera" - "--exclude seek-camera-sys" "--exclude can-rs" - "--exclude mcu-util" + "--exclude orb-mcu-util" "--exclude orb-sound" + "--exclude orb-thermal-cam-ctrl" "--exclude orb-ui" + "--exclude seek-camera" + "--exclude seek-camera-sys" ) echo MAC_EXCLUDE="${MAC_EXCLUDE[*]}" >>${GITHUB_ENV} cat ${GITHUB_ENV} @@ -168,9 +168,9 @@ jobs: uname -a nix develop -c env binaries=( - mcu-util orb-attest orb-backend-state + orb-mcu-util orb-slot-ctrl orb-thermal-cam-ctrl orb-ui diff --git a/Cargo.lock b/Cargo.lock index 19f61163..d0d0dc54 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -2332,25 +2332,6 @@ version = "0.7.3" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "0e7465ac9959cc2b1404e8e2367b43684a6d13790fe23056cc8c6c5a6b7bcb94" -[[package]] -name = "mcu-util" -version = "0.7.0" -dependencies = [ - "anyhow", - "async-trait", - "can-rs", - "clap", - "crc32fast", - "eyre", - "image", - "orb-messages", - "prost", - "tokio", - "tokio-serial", - "tracing", - "tracing-subscriber", -] - [[package]] name = "memchr" version = "2.7.1" @@ -2833,6 +2814,25 @@ dependencies = [ "url", ] +[[package]] +name = "orb-mcu-util" +version = "0.7.0" +dependencies = [ + "anyhow", + "async-trait", + "can-rs", + "clap", + "crc32fast", + "eyre", + "image", + "orb-messages", + "prost", + "tokio", + "tokio-serial", + "tracing", + "tracing-subscriber", +] + [[package]] name = "orb-messages" version = "0.3.0" diff --git a/mcu-util/Cargo.toml b/mcu-util/Cargo.toml index d74fe899..6ba9f59b 100644 --- a/mcu-util/Cargo.toml +++ b/mcu-util/Cargo.toml @@ -1,5 +1,5 @@ [package] -name = "mcu-util" +name = "orb-mcu-util" version = "0.7.0" authors = ["Cyril Fougeray "] description = "Debug microcontrollers and manage firmware images" diff --git a/mcu-util/README.md b/mcu-util/README.md index cf58c580..4aa52777 100644 --- a/mcu-util/README.md +++ b/mcu-util/README.md @@ -1,4 +1,4 @@ -# mcu-util +# orb-mcu-util Utility for debugging microcontrollers and managing firmware. From a3a7b45c87ad91e92ba53bc7591ddea7bd6ff2a6 Mon Sep 17 00:00:00 2001 From: Ryan Butler Date: Mon, 6 May 2024 17:49:36 -0400 Subject: [PATCH 2/2] docs: Document the orb- naming convention --- CONTRIBUTING.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a1ca2654..2c48e007 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,8 +23,11 @@ change things in a backwards-incompatible way at any time! libc. PRs that use `libc` will be rejected if an equivalent safe function in `nix` exists. - PR names and the final squashed commit that gets merged, should start with an - area prefix, like `ir-camera:`. This helps disambigutate which part of the + area prefix, like `ir-camera:`. This helps disambiguate which part of the monorepo changed at a glance. +- All first-party crates should start with the `orb-` prefix for the crate name, + and the crates' directories should omit this prefix. For example, the `attest` + dir contains the `orb-attest` crate. ## First time Setup