xtask command to use a local registry

Author: bjoernQ

.cargo/config.toml

@@ -6,3 +6,4 @@ xfmt     = "xtask fmt-packages"
 qa       = "xtask run example qa-test"
 xcheck   = "run --quiet --package xtask --features=semver-checks --"
 xrelease = "run --package xtask --features=release -- release"
+xrel-check = "run --package xtask --features=rel-check -- rel-check"

Cargo.toml

@@ -29,4 +29,6 @@ exclude  = [
     "xtensa-lx",
     "xtensa-lx-rt",
     "xtensa-lx-rt-proc-macros",
+
+    "compile-tests",
 ]

compile-tests/README.md

@@ -0,0 +1,51 @@
+# Tests to check if "released" crates work
+
+This folder in special in a couple of ways.
+
+It's meant to check that released crates work well together. Especially it's meant to "simulate" a release
+by using a private registry (i.e. a local registry).
+
+For that reason the projects under this folder don't use path-dependencies.
+
+This folder (and it's sub-folders) are also not known to the general `xtask` commands. (except the `rel-check` command)
+
+The projects don't contain real code but just define dependencies to make sure they compile.
+
+## Walkthrough how to use it with the `rel-check` command
+
+`cargo xrel-check init`
+
+This will initialize the local registry with the dependencies used by the projects found in the `compile-tests` folder.
+
+`cargo xrel-check check`
+
+This just tries to build every project in the `compile-tests` folder.
+Please note that we remove `Cargo.lock` files before the build if they are present.
+If the local registry is initialized this will use it.
+
+To test how a version bump affects the test projects let's bump `esp-backtrace` to e.g. `0.999.0`. (manually)
+
+`cargo xrel-check update esp-backtrace`
+
+This will package and add the esp-backtrace crate.
+
+Let's see if it still compiles. (the test projects still use the current version - so this is expected to work)
+
+`cargo xrel-check check`
+
+Now get the test projects updated to use the bumped version of `esp-backtrace`:
+
+`cargo xrel-check yolo-bump`
+
+Notice the change in the `Cargo.toml`s - executing `cargo xrel-check check` should still work using the freshly "released" version of `esp-backtrace`.
+
+Now lets see how a bad release looks like!
+
+Bump the patch version of `esp-rom-sys` and change the name of the `init_syscall_table` function.
+
+`cargo xrel-check update esp-rom-sys` will "release" this breaking update.
+
+`cargo xrel-check check` should fail now because the test project will pickup the problematic patch release of `esp-rom-sys`.
+Even without changing anything anything in the test project.
+
+When done: `cargo xtask rel-check deinit` and revert local changes

compile-tests/basic-c6/.cargo/config.toml

@@ -0,0 +1,16 @@
+[target.riscv32imac-unknown-none-elf]
+runner = "espflash flash --monitor --chip esp32c6"
+
+[env]
+ESP_LOG="info"
+
+[build]
+rustflags = [
+  "-C", "link-arg=-Tlinkall.x",
+  "-C", "force-frame-pointers",
+]
+
+target = "riscv32imac-unknown-none-elf"
+
+[unstable]
+build-std = ["alloc", "core"]

compile-tests/basic-c6/Cargo.toml

@@ -0,0 +1,78 @@
+[package]
+edition      = "2024"
+name         = "basic-c6"
+rust-version = "1.88"
+version      = "0.1.0"
+
+[dependencies]
+esp-hal = { version = "1.0.0", features = ["esp32c6", "log-04", "unstable"] }
+
+esp-rtos = { version = "0.2.0", features = [
+  "embassy",
+  "esp-alloc",
+  "esp-radio",
+  "esp32c6",
+  "log-04",
+] }
+
+esp-bootloader-esp-idf = { version = "0.4.0", features = ["esp32c6", "log-04"] }
+log                    = "0.4.27"
+
+embassy-net = { version = "0.7.1", features = [
+  "dhcpv4",
+  "log",
+  "medium-ethernet",
+  "tcp",
+  "udp",
+] }
+embedded-io = "0.7.1"
+embedded-io-async = "0.7.0"
+esp-alloc = "0.9.0"
+esp-backtrace = { version = "0.18.1", features = [
+  "esp32c6",
+  "panic-handler",
+  "println",
+] }
+esp-println = { version = "0.16.1", features = ["esp32c6", "log-04"] }
+
+embassy-executor = { version = "0.9.1", features = ["log"] }
+embassy-time = { version = "0.5.0", features = ["log"] }
+esp-radio = { version = "0.17.0", features = [
+  "esp-alloc",
+  "esp32c6",
+  "log-04",
+  "smoltcp",
+  "unstable",
+  "wifi",
+] }
+smoltcp = { version = "0.12.0", default-features = false, features = [
+  "log",
+  "medium-ethernet",
+  "multicast",
+  "proto-dhcpv4",
+  "proto-dns",
+  "proto-ipv4",
+  "socket-dns",
+  "socket-icmp",
+  "socket-raw",
+  "socket-tcp",
+  "socket-udp",
+] }
+
+critical-section = "1.2.0"
+static_cell      = "2.1.1"
+
+
+[profile.dev]
+# Rust debug is too slow.
+# For debug builds always builds with some optimization
+opt-level = "s"
+
+[profile.release]
+codegen-units    = 1     # LLVM can perform better optimizations using a single thread
+debug            = 2
+debug-assertions = false
+incremental      = false
+lto              = 'fat'
+opt-level        = 's'
+overflow-checks  = false

compile-tests/basic-c6/src/main.rs

@@ -0,0 +1,15 @@
+#![no_std]
+#![no_main]
+
+use esp_backtrace as _;
+
+extern crate alloc;
+
+esp_bootloader_esp_idf::esp_app_desc!();
+
+#[esp_rtos::main]
+async fn main(_spawner: embassy_executor::Spawner) -> ! {
+    // nothing really here
+
+    loop {}
+}

xtask/Cargo.toml

@@ -55,3 +55,4 @@ preview-docs = ["dep:opener", "dep:rocket"]
 semver-checks = [ "dep:cargo-semver-checks", "dep:flate2", "dep:temp-file" ]
 release = ["semver-checks", "dep:opener", "dep:urlencoding", "dep:regex"]
 report = ["dep:regex"]
+rel-check = ["dep:regex"]

xtask/src/commands/mod.rs

@@ -17,6 +17,8 @@ mod check_changelog;
 pub mod generate_report;
 mod release;
 mod run;
+#[cfg(feature = "rel-check")]
+pub mod relcheck;
 
 // ----------------------------------------------------------------------------
 // Subcommand Arguments