fix: workaround to publish example_test

GitoxideLabs/cargo-smart-release#36

Author: MingweiSamuel

RELEASING.md

@@ -119,9 +119,14 @@ When adding a new crate which is published, you need to:
    (substitute correct version).
 3. You must commit a new (empty) file `my_crate/CHANGELOG.md` to ensure the file will be tracked
    by git and pushed by `cargo-smart-release`
-4. If you want your package to be lockstep-versioned alongside hydro then make sure to add it
+4. (A) If you want your crate to be lockstep-versioned alongside hydro then make sure to add it
    to the [command in the `release.yml` workflow](https://github.com/hydro-project/hydro/blob/main/.github/workflows/release.yml#L82).
    (also update the `cargo smart-release` test command above in this file).
+5. (B) Otherwise, if your crate is only used via `[dev-dependencies]` then the crate may not
+   initially publish due to https://github.com/Byron/cargo-smart-release/issues/36. To workaround
+   this, additionally add the crate as a regular `[dependencies]` but marked as `optional = true`.
+   When doing the dry run, look for `[INFO ] WOULD modify existing changelog for 'new_crate'.` to
+   verify it will publish.
 
 Then just run the release workflow as normal.
 

dfir_rs/Cargo.toml

@@ -59,6 +59,7 @@ web-time = "1.0.0"
 # added to workaround `cargo smart-release` https://github.com/Byron/cargo-smart-release/issues/36
 multiplatform_test = { path = "../multiplatform_test", version = "^0.5.0", optional = true }
 include_mdtests = { path = "../include_mdtests", version = "^0.0.0", optional = true }
+example_test = { path = "../example_test", version = "^0.0.0", optional = true }
 
 [target.'cfg(not(target_arch = "wasm32"))'.dependencies]
 tokio = { version = "1.29.0", features = [ "io-std" ] }

hydro_test/Cargo.toml

@@ -18,6 +18,9 @@ colored = "3.0.0"
 palette = "0.7.6"
 tokio = "1.29.0"
 
+# added to workaround `cargo smart-release` https://github.com/Byron/cargo-smart-release/issues/36
+example_test = { path = "../example_test", version = "^0.0.0", optional = true }
+
 [build-dependencies]
 stageleft_tool.workspace = true