chore: add CI workflow for rust 🚀

- Enable automated build and test for push and pull requests
- Config matrix for stable, beta, and nightly toolchains
- Run clippy, fmt, build, and test

Author: mingcheng

.github/workflows/rust.yml

@@ -0,0 +1,40 @@
+#!#
+# Copyright (c) 2025 Hangzhou Guanwaii Technology Co,.Ltd.
+#
+# This source code is licensed under the MIT License,
+# which is located in the LICENSE file in the source tree's root directory.
+#
+# File: rust.yml
+# Author: mingcheng ([email protected])
+# File Created: 2025-03-05 11:10:40
+#
+# Modified By: mingcheng ([email protected])
+# Last Modified: 2025-03-05 11:12:03
+##
+
+name: Cargo Build & Test
+
+on:
+  push:
+  pull_request:
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  build_and_test:
+    name: Rust project - latest
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        toolchain:
+          - stable
+          - beta
+          - nightly
+    steps:
+      - uses: actions/checkout@v4
+      - run: rustup update ${{ matrix.toolchain }} && rustup default ${{ matrix.toolchain }}
+      - run: cargo clippy -- -D warnings
+      - run: cargo fmt --all -- --check
+      - run: cargo build --verbose
+      - run: cargo test --verbose

Cargo.toml

@@ -16,6 +16,8 @@ keywords = [
 ]
 authors = ["mingcheng<[email protected]"]
 repository = "https://github.com/mingcheng/aigitcommit"
+homepage = "https://github.com/mingcheng/aigitcommit"
+exclude = ["assets/*", "hooks/*"]
 
 [dependencies]
 reqwest = { version = "0.12.12", features = [

src/openai.rs

@@ -9,7 +9,7 @@
  * File Created: 2025-03-01 21:55:58
  *
  * Modified By: mingcheng ([email protected])
- * Last Modified: 2025-03-05 10:41:39
+ * Last Modified: 2025-03-05 10:46:26
  */
 
 use askama::Template;
@@ -46,6 +46,8 @@ impl Default for OpenAI {
 }
 
 impl OpenAI {
+    /// Create a new OpenAI client instance.
+    /// This function sets up the OpenAI client with the API key, base URL, and optional proxy settings.
     pub fn new() -> Self {
         // Set up OpenAI client configuration
         let ai_config = OpenAIConfig::new()
@@ -80,13 +82,16 @@ impl OpenAI {
         OpenAI { client }
     }
 
+    #[deprecated]
+    /// Check if the OpenAI API is reachable.
     pub async fn check(&self) -> Result<(), Box<dyn Error>> {
         match self.client.models().list().await {
             Ok(_) => Ok(()),
             Err(e) => Err(e.into()),
         }
     }
 
+    /// Send a chat message to the OpenAI API and return the response.
     pub async fn chat(
         &self,
         model_name: &str,