Enable Attestations for Release Artifacts

Author: nullstalgia

.github/workflows/release.yml

@@ -68,6 +68,6 @@ jobs:
           archive: $bin-lite-$tag-$target
           token: ${{ secrets.GITHUB_TOKEN }}
           checksum: sha512
-      # - uses: actions/attest-build-provenance@v1
-      #   with:
-      #     subject-path: "**/*.tar.gz,**/*.zip"
+      - uses: actions/attest-build-provenance@v1
+        with:
+          subject-path: "**/*.tar.gz,**/*.zip"

Cargo.lock

@@ -1,7 +1,7 @@
 [package]
 name = "yap"
 repository = "https://github.com/nullstalgia/yap"
-version = "0.1.0-pre.0"
+version = "0.1.0"
 # Note to self, if doing a pre-release:
 # start at: -pre.0
 # just -pre will go before any .x entries

Cargo.toml

@@ -82,3 +82,16 @@ Try to connect to found USB device with VID 303A and PID 1001 and Serial Number
 ```
 yap 303A:1001:123456 9600
 ```
+
+## Antivirus notice:
+
+Downloaded Windows builds of `yap` may falsely trigger Windows Defender, likely due to the executable's capacity to self-update.
+
+Release builds have GitHub Attestations enabled to help you to verify their authenticity!
+
+
+## Acknowledgements:
+
+Inspired by the likes of [minicom](https://salsa.debian.org/minicom-team/minicom)/[picocom](https://github.com/npat-efault/picocom), [Termite](https://www.compuphase.com/software_termite.htm), [CuteCom](https://cutecom.sourceforge.net/), [PuTTY](https://www.chiark.greenend.org.uk/~sgtatham/putty/), and others.
+
+This wouldn't have been possible without the prior work of the original [`ansi-to-tui`](https://github.com/ratatui/ansi-to-tui) crate, [`esp-rs`'s team](https://github.com/esp-rs), [Ferrous Systems](https://ferrous-systems.com/), and many many other incredible crate authors and educators. Thank you all!

README.md

@@ -1,3 +1,6 @@
+# Place as many Color Rules here as you like!
+# Ensure each one starts with [[literal]] or [[regex]] to denote the rule type.
+
 # Color Highlight Rule Example: case-insensitive match
 # Example
 # [[regex]] ## type of rule (regex/literal)

example_configs/yap_colors.toml.blank

@@ -1,3 +1,6 @@
+# Place as many espflash profiles here as you like!
+# Ensure each one starts with [[bin]] or [[elf]] to denote the profile type.
+
 # .bin example
 # [[bin]] ## type of profile (bin/elf)
 # name = "PlatformIO Core v2 Build" ## name in macros and UI

example_configs/yap_espflash_profiles.toml.blank

@@ -0,0 +1,3 @@
+`tcp_log_listener` is a helpful listener for Tracing events (since the console is taken up by the App TUI). It's presently hardcoded to listen to `127.0.0.1:7331`.
+
+`tcp_log_send_test` is just to help smoke-test `tcp_log_listener`.

examples/README.md

@@ -4,6 +4,7 @@ fn main() -> color_eyre::Result<()> {
 
 // Sooner TODOs:
 // deduplication of code for defmt and logging defmt
+// SignPath for release binaries
 
 // General TODOs:
 // Mouse select in line mode?

src/main.rs

@@ -42,12 +42,15 @@ const DEFAULT_LOG_LEVEL: Level = Level::Trace;
 #[cfg(not(debug_assertions))]
 const DEFAULT_LOG_LEVEL: Level = Level::Debug;
 
-const DEFAULT_LOG_SOCKET: SocketAddr = {
+#[cfg(debug_assertions)]
+const DEFAULT_LOG_SOCKET_OPT: Option<SocketAddr> = {
     let addr = Ipv4Addr::new(127, 0, 0, 1);
     let port = 7331;
 
-    SocketAddr::new(IpAddr::V4(addr), port)
+    Some(SocketAddr::new(IpAddr::V4(addr), port))
 };
+#[cfg(not(debug_assertions))]
+const DEFAULT_LOG_SOCKET_OPT: Option<SocketAddr> = None;
 
 #[serde_inline_default]
 #[derive(Debug, Clone, Serialize, Deserialize, Derivative)]
@@ -91,7 +94,7 @@ pub struct Misc {
     pub log_level: Level,
 
     #[serde_inline_default_parent]
-    #[derivative(Default(value = "Some(DEFAULT_LOG_SOCKET)"))]
+    #[derivative(Default(value = "DEFAULT_LOG_SOCKET_OPT"))]
     #[serde_as(as = "NoneAsEmptyString")]
     pub log_tcp_socket: Option<SocketAddr>,
 }