Merge branch 'release/1.3.0'

mingcheng · mingcheng · commit 91d7f07b8d4a · 2025-03-05T11:29:05.000+08:00
diff --git a/.github/workflows/rust.yml b/.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 (mingcheng@apache.org)
+# File Created: 2025-03-05 11:10:40
+#
+# Modified By: mingcheng (mingcheng@apache.org)
+# 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
diff --git a/Cargo.lock b/Cargo.lock
@@ -19,7 +19,7 @@ checksum = "512761e0bb2578dd7380c6baaa0f4ce03e84f95e960231d1dec8bf4d7d6e2627"
 
 [[package]]
 name = "aigitcommit"
-version = "1.2.0"
+version = "1.3.0"
 dependencies = [
  "arboard",
  "askama",
@@ -1153,9 +1153,9 @@ checksum = "7943c866cc5cd64cbc25b2e01621d07fa8eb2a1a23160ee81ce38704e97b8ecf"
 
 [[package]]
 name = "itoa"
-version = "1.0.14"
+version = "1.0.15"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "d75a2a4b1b190afb6f5425f10f6a8f959d2ea0b9c2b1d79553551850539e4674"
+checksum = "4a5f13b858c8d314ee3e8f639011f7ccefe71f97f96e50151fb991f267928e2c"
 
 [[package]]
 name = "jobserver"
@@ -1698,9 +1698,9 @@ dependencies = [
 
 [[package]]
 name = "redox_syscall"
-version = "0.5.9"
+version = "0.5.10"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "82b568323e98e49e2a0899dcee453dd679fae22d69adf9b11dd508d1549b7e2f"
+checksum = "0b8c0c260b63a8219631167be35e6a988e9554dbd323f8bd08439c8ed1302bd1"
 dependencies = [
  "bitflags 2.9.0",
 ]
@@ -1872,15 +1872,15 @@ dependencies = [
 
 [[package]]
 name = "rustversion"
-version = "1.0.19"
+version = "1.0.20"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f7c45b9784283f1b2e7fb61b42047c2fd678ef0960d4f6f1eba131594cc369d4"
+checksum = "eded382c5f5f786b989652c49544c4877d9f015cc22e145a5ea8ea66c2921cd2"
 
 [[package]]
 name = "ryu"
-version = "1.0.19"
+version = "1.0.20"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "6ea1a2d0a644769cc99faa24c3ad26b379b786fe7c36fd3c546254801650e6dd"
+checksum = "28d3b2b1366ec20994f1fd18c3c594f05c5dd4bc44d8bb0c1c632c8d6829481f"
 
 [[package]]
 name = "schannel"
@@ -2420,9 +2420,9 @@ checksum = "75b844d17643ee918803943289730bec8aac480150456169e647ed0b576ba539"
 
 [[package]]
 name = "unicode-ident"
-version = "1.0.17"
+version = "1.0.18"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "00e2473a93778eb0bad35909dff6a10d28e63f792f16ed15e404fca9d5eeedbe"
+checksum = "5a5f39404a5da50712a4c1eecf25e90dd62b613502b7e925fd4e4d19b5c96512"
 
 [[package]]
 name = "unicode-width"
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,21 +1,15 @@
 [package]
 name = "aigitcommit"
-version = "1.2.0"
-edition = "2021"
+version = "1.3.0"
+edition = "2024"
 description = "A simple git commit message generator by OpenAI compaction model."
 license = "MIT"
 readme = "README.md"
-keywords = [
-    "git",
-    "commit",
-    "message",
-    "generator",
-    "openai",
-    "compaction",
-    "model",
-]
+keywords = ["git", "openai", "tools"]
 authors = ["mingcheng<mingcheng@apache.org"]
 repository = "https://github.com/mingcheng/aigitcommit"
+homepage = "https://github.com/mingcheng/aigitcommit"
+exclude = ["assets/*", "hooks/*"]
 
 [dependencies]
 reqwest = { version = "0.12.12", features = [
diff --git a/README.md b/README.md
@@ -28,7 +28,13 @@ AIGitCommit is still in the early stages of development, I suggest you to instal
 cargo install --git https://github.com/mingcheng/aigitcommit.git
 ```
 
-This command will auto-download the latest version of the project and install it to your cargo bin directory.
+or, You can install from [crates.io](https://crates.io/crates/aigitcommit)
+
+```
+cargo install aigitcommit
+```
+
+Those command will auto-download the latest version of the project and install it to your cargo bin directory.
 
 ## Configuration
 
diff --git a/src/cli.rs b/src/cli.rs
@@ -9,13 +9,14 @@
  * File Created: 2025-03-03 19:31:27
  *
  * Modified By: mingcheng (mingcheng@apache.org)
- * Last Modified: 2025-03-04 16:31:19
+ * Last Modified: 2025-03-05 00:25:24
  */
 
 use clap::Parser;
 
 pub const CMD: &str = "aigitcommit";
 pub const CMD_ABOUT: &str = "A simple tool to help you write better Git commit messages using AI.";
+pub const CMD_ABOUT_URL: &str = "https://github.com/mingcheng/aigitcommit";
 
 #[derive(Debug, Parser)]
 #[command(name = CMD)]
diff --git a/src/git.rs b/src/git.rs
@@ -9,10 +9,10 @@
  * File Created: 2025-03-01 21:55:54
  *
  * Modified By: mingcheng (mingcheng@apache.org)
- * Last Modified: 2025-03-04 11:29:20
+ * Last Modified: 2025-03-05 10:12:04
  */
 
-use git2::{Repository, StatusOptions};
+use git2::{Repository, RepositoryOpenFlags, StatusOptions};
 use log::trace;
 use std::error::Error;
 use std::path::Path;
@@ -24,8 +24,16 @@ pub struct Git {
 impl Git {
     pub fn new(path: &str) -> Result<Git, Box<dyn Error>> {
         trace!("Opening repository at {}", path);
-        let repository = Repository::open(path)?;
+        // let repository = Repository::open(path)?;
+        let repository = Repository::open_ext(path, RepositoryOpenFlags::empty(), vec![path])?;
+
         trace!("Repository opened successfully");
+        if let Some(work_dir) = repository.workdir() {
+            trace!("The repository workdir is: {:?}", work_dir);
+        } else {
+            return Err("The repository has no workdir".into());
+        }
+
         Ok(Git { repository })
     }
 
diff --git a/src/main.rs b/src/main.rs
@@ -9,12 +9,13 @@
  * File Created: 2025-03-01 17:17:30
  *
  * Modified By: mingcheng (mingcheng@apache.org)
- * Last Modified: 2025-03-04 16:30:20
+ * Last Modified: 2025-03-05 10:12:30
  */
 
 use aigitcommit::cli::Cli;
+use aigitcommit::git::Git;
+use aigitcommit::openai;
 use aigitcommit::openai::OpenAI;
-use aigitcommit::{git, openai};
 use arboard::Clipboard;
 use async_openai::types::{
     ChatCompletionRequestSystemMessageArgs, ChatCompletionRequestUserMessageArgs,
@@ -25,7 +26,7 @@ use std::error::Error;
 use std::fs::File;
 use std::io::Write;
 use std::{env, fs};
-use tracing::{debug, trace, Level};
+use tracing::{Level, debug, trace};
 
 #[tokio::main]
 async fn main() -> std::result::Result<(), Box<dyn Error>> {
@@ -55,7 +56,7 @@ async fn main() -> std::result::Result<(), Box<dyn Error>> {
 
     trace!("Specified repository directory: {:?}", repo_dir);
     // Check if the directory is a valid git repository
-    let repository = git::Git::new(repo_dir.to_str().unwrap_or("."))?;
+    let repository = Git::new(repo_dir.to_str().unwrap_or("."))?;
 
     // Get the diff and logs from the repository
     let diffs = repository.get_diff()?;
@@ -78,11 +79,11 @@ async fn main() -> std::result::Result<(), Box<dyn Error>> {
     let client = openai::OpenAI::new();
 
     // Check if the OpenAI request is valid, if not, return error
-    if client.check().await.is_err() {
-        return Err(
-            "OpenAI API check with error, please check your API key or configuration".into(),
-        );
-    };
+    // if client.check().await.is_err() {
+    //     return Err(
+    //         "OpenAI API check with error, please check your API key or configuration".into(),
+    //     );
+    // };
 
     // Generate the prompt which will be sent to OpenAI API
     let content = OpenAI::prompt(&logs, &diffs)?;
diff --git a/src/openai.rs b/src/openai.rs
@@ -9,22 +9,26 @@
  * File Created: 2025-03-01 21:55:58
  *
  * Modified By: mingcheng (mingcheng@apache.org)
- * Last Modified: 2025-03-03 23:58:02
+ * Last Modified: 2025-03-05 10:46:26
  */
 
 use askama::Template;
 use async_openai::config::OPENAI_API_BASE;
 use async_openai::{
+    Client,
     config::OpenAIConfig,
     types::{ChatCompletionRequestMessage, CreateChatCompletionRequestArgs},
-    Client,
 };
 use log::trace;
+use reqwest::header::{HeaderMap, HeaderValue};
 use reqwest::{ClientBuilder, Proxy};
 use std::env;
 use std::error::Error;
+use std::time::Duration;
 use tracing::debug;
 
+use crate::cli;
+
 #[derive(Template)]
 #[template(path = "user.txt")]
 struct PromptTemplate<'a> {
@@ -42,33 +46,52 @@ 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()
             .with_api_key(env::var("OPENAI_API_TOKEN").unwrap_or_else(|_| String::from("")))
             .with_api_base(
                 env::var("OPENAI_API_BASE").unwrap_or_else(|_| String::from(OPENAI_API_BASE)),
-            );
-        let proxy_addr = env::var("OPENAI_APT_PROXY").unwrap_or_else(|_| String::from(""));
+            )
+            .with_org_id(cli::CMD);
+
+        // Set up HTTP client builder with default headers
+        let mut http_client_builder = ClientBuilder::new().user_agent(cli::CMD).default_headers({
+            let mut headers = HeaderMap::new();
+            headers.insert("HTTP-Referer", HeaderValue::from_static(cli::CMD_ABOUT_URL));
+            headers.insert("X-Title", HeaderValue::from_static(cli::CMD));
+            headers
+        });
 
-        let mut client = Client::with_config(ai_config);
+        // Set up proxy if specified
+        let proxy_addr = env::var("OPENAI_APT_PROXY").unwrap_or_else(|_| String::from(""));
         if !proxy_addr.is_empty() {
             trace!("Using proxy: {}", proxy_addr);
-            client = client.with_http_client({
-                let proxy = Proxy::all(proxy_addr).unwrap();
-                ClientBuilder::new().proxy(proxy).build().unwrap()
-            })
-        };
+            http_client_builder = http_client_builder.proxy(Proxy::all(proxy_addr).unwrap());
+        }
+
+        // Set up timeout and build the HTTP client
+        let http_client = http_client_builder
+            .timeout(Duration::from_secs(10))
+            .build()
+            .unwrap();
 
+        let client = Client::with_config(ai_config).with_http_client(http_client);
         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,
