feat: improve the --version output

Author: Mcdostone

.dockerignore

@@ -2,4 +2,5 @@
 !crates/
 !Cargo.toml
 !Cargo.lock
-.env
+.env
+!.git/HEAD

.github/workflows/build.yml

@@ -43,6 +43,9 @@ jobs:
     - uses: Swatinem/rust-cache@v2
     - name: Run cargo check
       run: cargo check --locked --release --package ${{ matrix.package }}
+    - name: Print version
+      if: matrix.package == 'yozefu'
+      run: cargo run -- --version
 
   build:
     name: Build w/o features

Cargo.lock

@@ -40,23 +40,21 @@ rdkafka = { version = "0.37.0", features = [
     "libz-static",
     "curl-static",
     "zstd",
-    "external-lz4"
+    "external-lz4",
 ] }
 extism = { version = "1.10.0" }
 indexmap = "2.8.0"
 tui = { workspace = true }
 app = { workspace = true }
 lib = { workspace = true }
 reqwest = { version = "0.12.15", features = ["json"] }
+const_format = { version = "0.2.34", features = ["rust_1_64"] }
+const-str = "0.6.2"
 
 [features]
-ssl-vendored = [
-    "rdkafka/ssl-vendored",
-    "tui/ssl-vendored",
-    "app/ssl-vendored"
-]
+ssl-vendored = ["rdkafka/ssl-vendored", "tui/ssl-vendored", "app/ssl-vendored"]
 gssapi-vendored = [
     "rdkafka/gssapi-vendored",
     "tui/gssapi-vendored",
-    "app/gssapi-vendored"
+    "app/gssapi-vendored",
 ]

crates/command/Cargo.toml

@@ -2,6 +2,7 @@
 use crate::cluster::Cluster;
 use crate::command::{Command, MainCommand, UtilityCommands};
 use crate::theme::init_themes_file;
+use crate::version::VERSION_MESSAGE;
 use app::APPLICATION_NAME;
 use app::configuration::{ClusterConfig, GlobalConfig, SchemaRegistryConfig, YozefuConfig};
 use clap::command;
@@ -14,14 +15,6 @@ use tui::error::TuiError;
 pub use clap::Parser;
 use indexmap::IndexMap;
 
-const VERSION_MESSAGE: &str = concat!(
-    env!("CARGO_PKG_VERSION"),
-    "\n",
-    env!("CARGO_PKG_REPOSITORY"),
-    "\n",
-    env!("CARGO_PKG_AUTHORS")
-);
-
 // https://github.com/clap-rs/clap/issues/975
 /// CLI parser
 #[derive(Parser)]

crates/command/src/cli.rs

@@ -7,6 +7,7 @@ mod command;
 mod headless;
 mod log;
 mod theme;
+mod version;
 use app::configuration::GlobalConfig;
 pub use clap::Parser;
 pub use cli::Cli;

crates/command/src/lib.rs

@@ -0,0 +1,43 @@
+//! Inspired of <https://vallentin.dev/blog/post/versioning>
+//!
+//! Github environment variables <https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/store-information-in-variables>
+//! The version message looks like this:
+//! ```
+//! yozefu 0.0.9 (develop:unknown, debug build, macos [aarch64])
+//! https://github.com/MAIF/yozefu
+//! Yann Prono <[email protected]>
+//! ```
+use const_format::{formatcp, str_index, str_split};
+use const_str::split_lines;
+use std::env::consts::{ARCH, OS};
+
+#[cfg(debug_assertions)]
+const BUILD_TYPE: &str = "debug";
+
+#[cfg(not(debug_assertions))]
+const BUILD_TYPE: &'static str = "release";
+
+const GIT_BRANCH: &str = match option_env!("GITHUB_REF_NAME") {
+    Some(v) => v,
+    None => {
+        const FIRST_LINE: &str = split_lines!(include_str!("../../../.git/HEAD"))[0];
+        str_split!(FIRST_LINE, "/")[2]
+    }
+};
+
+const GIT_COMMIT: &str = match option_env!("GITHUB_SHA") {
+    Some(v) => v,
+    None => "unknown",
+};
+
+pub(super) const VERSION_MESSAGE: &str = formatcp!(
+    "{} ({}:{}, {} build, {} [{}]) \n{}\n{}",
+    env!("CARGO_PKG_VERSION"),
+    GIT_BRANCH,
+    str_index!(GIT_COMMIT, 0..7),
+    BUILD_TYPE,
+    OS,
+    ARCH,
+    env!("CARGO_PKG_REPOSITORY"),
+    env!("CARGO_PKG_AUTHORS"),
+);

crates/command/src/version.rs

@@ -110,6 +110,10 @@ exceptions = [
     { allow = ["BSL-1.0"], crate = "lazy-bytes-cast" },
     { allow = ["Zlib"], crate = "throbber-widgets-tui" },
     { allow = ["Zlib"], crate = "adler32" },
+    { allow = ["Zlib"], crate = "const_format" },
+    { allow = ["Zlib"], crate = "konst_macro_rules" },
+    { allow = ["Zlib"], crate = "const_format_proc_macros" },
+    { allow = ["Zlib"], crate = "konst" }
 ]
 
 # Some crates don't have (easily) machine readable licensing information,

deny.toml

@@ -32,14 +32,15 @@ The choices I made are completely personal. I use a qwerty apple keyboard for yo
 <br />
 
 **Records list**
-| Keybinding                   | Description                                   |
-| ---------------------------- | :-------------------------------------------- |
-| <kbd>C</kbd>                 | Copy kafka record to clipboard                |
-| <kbd>O</kbd>                 | Open the kafka record in the web browser      |
-| <kbd>E</kbd>                 | Export kafka record to the file               |
-| <kbd>F</kbd>                 | Keep selecting the last consumed kafka record |
-| <kbd>Enter</kbd>             | Open the selected record                      |
-| <kbd>↑</kbd> or <kbd>↓</kbd> | Previous/next record                          |
+| Keybinding                     | Description                                   |
+| ------------------------------ | :-------------------------------------------- |
+| <kbd>C</kbd>                   | Copy kafka record to clipboard                |
+| <kbd>O</kbd>                   | Open the kafka record in the web browser      |
+| <kbd>E</kbd>                   | Export kafka record to the file               |
+| <kbd>Ctrl</kbd> + <kbd>E</kbd> | Export all records to the file                |
+| <kbd>F</kbd>                   | Keep selecting the last consumed kafka record |
+| <kbd>Enter</kbd>               | Open the selected record                      |
+| <kbd>↑</kbd> or <kbd>↓</kbd>   | Previous/next record                          |
 
 
 <br />
@@ -68,8 +69,8 @@ The choices I made are completely personal. I use a qwerty apple keyboard for yo
 
 
 **Search**
-| Keybinding                   | Description           |
-| ---------------------------- | :-------------------- |
-| <kbd>↓</kbd> or <kbd>↑</kbd> | Browse history        |
-| <kbd>→</kbd>                 | Accept autocomplete |
-| <kbd>Enter</kbd>             | Search kafka records  |
+| Keybinding                   | Description          |
+| ---------------------------- | :------------------- |
+| <kbd>↓</kbd> or <kbd>↑</kbd> | Browse history       |
+| <kbd>→</kbd>                 | Accept autocomplete  |
+| <kbd>Enter</kbd>             | Search kafka records |