feat: add build info [latest]

Author: shenjinti

README.md

@@ -204,7 +204,7 @@ For detailed API documentation, see [API Documentation](./docs/api.md).
 
 ## 📚 Documentation
 
-- [API Reference](./docs/API.md) - Complete REST API documentation
+- [API Reference](./docs/api.md) - Complete REST API documentation
 - [Architecture Diagrams](docs/) - System architecture and workflows
 
 ## 🤝 Contributing

build.rs

@@ -0,0 +1,60 @@
+use std::env;
+use std::process::Command;
+
+fn main() {
+    println!(
+        "cargo:rustc-env=CARGO_PKG_VERSION={}",
+        env!("CARGO_PKG_VERSION")
+    );
+
+    let build_time = std::time::SystemTime::now()
+        .duration_since(std::time::UNIX_EPOCH)
+        .unwrap()
+        .as_secs();
+    let build_time_str = format!("{}", build_time);
+    println!("cargo:rustc-env=BUILD_TIME={}", build_time_str);
+
+    let git_commit = get_git_commit_hash();
+    println!("cargo:rustc-env=GIT_COMMIT_HASH={}", git_commit);
+
+    let git_branch = get_git_branch();
+    println!("cargo:rustc-env=GIT_BRANCH={}", git_branch);
+
+    let git_dirty = get_git_dirty();
+    println!("cargo:rustc-env=GIT_DIRTY={}", git_dirty);
+
+    println!("cargo:rerun-if-changed=Cargo.toml");
+    println!("cargo:rerun-if-changed=.git/HEAD");
+    println!("cargo:rerun-if-changed=.git/index");
+}
+
+fn get_git_commit_hash() -> String {
+    Command::new("git")
+        .args(["rev-parse", "--short", "HEAD"])
+        .output()
+        .map(|output| String::from_utf8_lossy(&output.stdout).trim().to_string())
+        .unwrap_or_else(|_| "unknown".to_string())
+}
+
+fn get_git_branch() -> String {
+    Command::new("git")
+        .args(["rev-parse", "--abbrev-ref", "HEAD"])
+        .output()
+        .map(|output| String::from_utf8_lossy(&output.stdout).trim().to_string())
+        .unwrap_or_else(|_| "unknown".to_string())
+}
+
+fn get_git_dirty() -> String {
+    Command::new("git")
+        .args(["diff", "--quiet", "--ignore-submodules"])
+        .output()
+        .map(|output| {
+            if output.status.success() {
+                "clean"
+            } else {
+                "dirty"
+            }
+        })
+        .unwrap_or_else(|_| "unknown")
+        .to_string()
+}

docs/api.md

@@ -139,9 +139,9 @@ sequenceDiagram
     RustPBX->>Client: Send Answer Event with SDP
     Client->>RustPBX: Set Remote Description
     
-    Note over Client,RustPBX: SIP/RTP Media Flow
-    Client->>RustPBX: RTP Audio Packets (PCMA/PCMU/G722/Opus)
-    RustPBX->>Client: RTP Audio Response
+    Note over SIP UA,SIP Server: SIP/RTP Media Flow
+    SIP UA->>SIP Server: RTP Audio Packets (PCMA/PCMU/G722/Opus)
+    SIP Server->>SIP UA: RTP Audio Response
     
     Client->>RustPBX: Send TTS/Play Commands
     RustPBX->>Client: Send Audio Events

src/bin/rustpbx.rs

@@ -1,7 +1,7 @@
 use anyhow::Result;
 use clap::Parser;
 use dotenv::dotenv;
-use rustpbx::{app::AppStateBuilder, config::Config};
+use rustpbx::{app::AppStateBuilder, config::Config, version};
 use std::fs::File;
 use tokio::select;
 use tracing::{info, level_filters::LevelFilter};
@@ -10,8 +10,9 @@ use tracing_subscriber::{layer::SubscriberExt, util::SubscriberInitExt, EnvFilte
 #[derive(Parser, Debug)]
 #[command(
     author,
-    version,
-    about = "A versatile SIP PBX server implemented in Rust"
+    version = version::get_short_version(),
+    about = "A versatile SIP PBX server implemented in Rust",
+    long_about = version::get_version_info()
 )]
 struct Cli {
     /// Path to the configuration file
@@ -34,6 +35,7 @@ async fn main() -> Result<()> {
         .map(|conf| Config::load(&conf).expect("Failed to load config"))
         .unwrap_or_default();
 
+    println!("{}", version::get_version_info());
     let mut env_filter = EnvFilter::from_default_env();
     if let Some(Ok(level)) = config
         .log_level

src/bin/text2wav.rs

@@ -4,7 +4,7 @@ use dotenv::dotenv;
 use futures::StreamExt;
 use hound::{SampleFormat, WavSpec, WavWriter};
 use regex::Regex;
-use rustpbx::PcmBuf;
+use rustpbx::{version, PcmBuf};
 use std::path::PathBuf;
 use tracing::{debug, error, info};
 
@@ -21,7 +21,12 @@ struct TextSegment {
 
 /// Convert text to WAV audio files using text-to-speech
 #[derive(Parser, Debug)]
-#[command(author, version, about, long_about = None)]
+#[command(
+    author,
+    version = version::get_short_version(),
+    about = "Convert text to WAV audio files using text-to-speech",
+    long_about = version::get_version_info()
+)]
 struct Args {
     /// Input text to convert to speech
     ///

src/bin/wav2text.rs

@@ -4,13 +4,19 @@ use rustpbx::{
     event::SessionEvent,
     media::track::file::read_wav_file,
     transcription::{TencentCloudAsrClientBuilder, TranscriptionClient, TranscriptionOption},
+    version,
 };
 use std::{path::PathBuf, time::Duration};
 use tracing::{debug, info};
 
 /// Convert WAV audio files to text using speech recognition
 #[derive(Parser, Debug)]
-#[command(author, version, about, long_about = None)]
+#[command(
+    author,
+    version = version::get_short_version(),
+    about = "Convert WAV audio files to text using speech recognition",
+    long_about = version::get_version_info()
+)]
 struct Args {
     /// Path to input WAV file
     #[arg(value_name = "INPUT")]

src/lib.rs

@@ -13,6 +13,7 @@ pub mod proxy;
 pub mod synthesis;
 pub mod transcription;
 pub mod useragent;
+pub mod version;
 
 pub type TrackId = String;
 pub type Sample = i16;

src/version.rs

@@ -0,0 +1,39 @@
+use chrono::{DateTime, Local};
+
+pub fn get_version_info() -> &'static str {
+    let version = env!("CARGO_PKG_VERSION");
+    let build_time = env!("BUILD_TIME");
+    let git_commit = env!("GIT_COMMIT_HASH");
+    let git_branch = env!("GIT_BRANCH");
+    let git_dirty = env!("GIT_DIRTY");
+
+    let build_timestamp: i64 = build_time.parse().unwrap_or(0);
+    let build_datetime: DateTime<Local> = DateTime::from_timestamp(build_timestamp, 0)
+        .map(|utc| utc.with_timezone(&Local))
+        .unwrap_or_else(|| Local::now());
+    let build_time_str = build_datetime.format("%Y-%m-%d %H:%M:%S %Z").to_string();
+
+    Box::leak(
+        format!(
+            "rustpbx {}\n\
+         Build Time: {}\n\
+         Git Commit: {}\n\
+         Git Branch: {}\n\
+         Git Status: {}",
+            version, build_time_str, git_commit, git_branch, git_dirty
+        )
+        .into_boxed_str(),
+    )
+}
+
+pub fn get_short_version() -> &'static str {
+    let version = env!("CARGO_PKG_VERSION");
+    let git_commit = env!("GIT_COMMIT_HASH");
+    let git_dirty = env!("GIT_DIRTY");
+
+    if git_dirty == "dirty" {
+        Box::leak(format!("{}-{}-dirty", version, git_commit).into_boxed_str())
+    } else {
+        Box::leak(format!("{}-{}", version, git_commit).into_boxed_str())
+    }
+}