Skip to content

style: update log message formatting in git and openai modules πŸ–ŒοΈ #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 30, 2025

Conversation

mingcheng
Copy link
Owner

  • Replace static string formatting with variable interpolation in log messages
  • Apply consistent formatting for trace logs across git.rs and openai.rs

Copy link

coderabbitai bot commented Jun 30, 2025

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❀️ Share
πŸͺ§ Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

- Replace static string formatting with variable interpolation in log messages
- Apply consistent formatting for trace logs across `git.rs` and `openai.rs`

Signed-off-by: mingcheng <mingcheng@apache.org>
@mingcheng mingcheng merged commit 5dd81d2 into develop Jun 30, 2025
8 checks passed
@mingcheng mingcheng deleted the fix-lint-check branch June 30, 2025 23:14
mingcheng added a commit that referenced this pull request Jun 30, 2025
- Replace static string formatting with variable interpolation in log messages
- Apply consistent formatting for trace logs across `git.rs` and `openai.rs`

Signed-off-by: mingcheng <mingcheng@apache.org>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
mingcheng added a commit that referenced this pull request Jun 30, 2025
#12)

* fix: update artifact attestation in CI workflow πŸ“

- Change push-to-registry to false in `ghcr.yml`

Signed-off-by: mingcheng <mingcheng@apache.org>

* docs: enhance Docker usage instructions in README πŸ“š

- Expand Docker instructions with additional options and environment variables
- Add note about write access for --commit option
- Include --yes option tip

Signed-off-by: mingcheng <mingcheng@apache.org>

* refactor: update template instructions for commit messages πŸ“

- Modify bullet point phrasing in system.txt
- Clarify the use of optional bullet points

Signed-off-by: mingcheng <mingcheng@apache.org>

* feat: implement signoff feature for commit messages ✍️

- Add signoff option to CLI arguments in `cli.rs`
- Implement author name and email retrieval in `git.rs`
- Append signoff to commit message in `main.rs` if enabled
- Add tests for author name and email functions in `git.rs`

Signed-off-by: mingcheng <mingcheng@apache.org>

* feat: add auto signoff detection from environment variable ✍️

- Implement detection of GIT_AUTO_SIGNOFF environment variable
- Enable signoff if environment variable is set to true or 1
- Update logic to combine CLI signoff option with environment variable check

Signed-off-by: mingcheng <mingcheng@apache.org>

* docs: update README with new environment variable for signoff πŸ“š

- Add `AIGITCOMMIT_SIGNOFF` environment variable to README
- Mention auto sign-off feature when variable is set to true

Signed-off-by: mingcheng <mingcheng@apache.org>

* chore(deps): bump tokio from 1.44.1 to 1.44.2

Bumps [tokio](https://github.com/tokio-rs/tokio) from 1.44.1 to 1.44.2.
- [Release notes](https://github.com/tokio-rs/tokio/releases)
- [Commits](tokio-rs/tokio@tokio-1.44.1...tokio-1.44.2)

---
updated-dependencies:
- dependency-name: tokio
  dependency-version: 1.44.2
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>

* chore(deps): bump openssl from 0.10.71 to 0.10.72

Bumps [openssl](https://github.com/sfackler/rust-openssl) from 0.10.71 to 0.10.72.
- [Release notes](https://github.com/sfackler/rust-openssl/releases)
- [Commits](sfackler/rust-openssl@openssl-v0.10.71...openssl-v0.10.72)

---
updated-dependencies:
- dependency-name: openssl
  dependency-version: 0.10.72
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>

* style: update log message formatting in git and openai modules πŸ–ŒοΈ (#13)

- Replace static string formatting with variable interpolation in log messages
- Apply consistent formatting for trace logs across `git.rs` and `openai.rs`

Signed-off-by: mingcheng <mingcheng@apache.org>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* docs: correct environment variable name in README πŸ“š

- Update `AIGITCOMMIT_SIGNOFF` to `GIT_AUTO_SIGNOFF` in README for consistency
- Reflect the correct variable used in the code for auto signoff feature

Signed-off-by: mingcheng <mingcheng@apache.org>

---------

Signed-off-by: mingcheng <mingcheng@apache.org>
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
mingcheng added a commit that referenced this pull request Jun 30, 2025
- Replace static string formatting with variable interpolation in log messages
- Apply consistent formatting for trace logs across `git.rs` and `openai.rs`

Signed-off-by: mingcheng <mingcheng@apache.org>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
mingcheng added a commit that referenced this pull request Jul 1, 2025
* fix: update artifact attestation in CI workflow πŸ“

- Change push-to-registry to false in `ghcr.yml`

Signed-off-by: mingcheng <mingcheng@apache.org>

* docs: enhance Docker usage instructions in README πŸ“š

- Expand Docker instructions with additional options and environment variables
- Add note about write access for --commit option
- Include --yes option tip

Signed-off-by: mingcheng <mingcheng@apache.org>

* refactor: update template instructions for commit messages πŸ“

- Modify bullet point phrasing in system.txt
- Clarify the use of optional bullet points

Signed-off-by: mingcheng <mingcheng@apache.org>

* feat: implement signoff feature for commit messages ✍️

- Add signoff option to CLI arguments in `cli.rs`
- Implement author name and email retrieval in `git.rs`
- Append signoff to commit message in `main.rs` if enabled
- Add tests for author name and email functions in `git.rs`

Signed-off-by: mingcheng <mingcheng@apache.org>

* feat: add auto signoff detection from environment variable ✍️

- Implement detection of GIT_AUTO_SIGNOFF environment variable
- Enable signoff if environment variable is set to true or 1
- Update logic to combine CLI signoff option with environment variable check

Signed-off-by: mingcheng <mingcheng@apache.org>

* docs: update README with new environment variable for signoff πŸ“š

- Add `AIGITCOMMIT_SIGNOFF` environment variable to README
- Mention auto sign-off feature when variable is set to true

Signed-off-by: mingcheng <mingcheng@apache.org>

* chore(deps): bump tokio from 1.44.1 to 1.44.2

Bumps [tokio](https://github.com/tokio-rs/tokio) from 1.44.1 to 1.44.2.
- [Release notes](https://github.com/tokio-rs/tokio/releases)
- [Commits](tokio-rs/tokio@tokio-1.44.1...tokio-1.44.2)

---
updated-dependencies:
- dependency-name: tokio
  dependency-version: 1.44.2
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>

* chore(deps): bump openssl from 0.10.71 to 0.10.72

Bumps [openssl](https://github.com/sfackler/rust-openssl) from 0.10.71 to 0.10.72.
- [Release notes](https://github.com/sfackler/rust-openssl/releases)
- [Commits](sfackler/rust-openssl@openssl-v0.10.71...openssl-v0.10.72)

---
updated-dependencies:
- dependency-name: openssl
  dependency-version: 0.10.72
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>

* style: update log message formatting in git and openai modules πŸ–ŒοΈ (#13)

- Replace static string formatting with variable interpolation in log messages
- Apply consistent formatting for trace logs across `git.rs` and `openai.rs`

Signed-off-by: mingcheng <mingcheng@apache.org>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* docs: correct environment variable name in README πŸ“š

- Update `AIGITCOMMIT_SIGNOFF` to `GIT_AUTO_SIGNOFF` in README for consistency
- Reflect the correct variable used in the code for auto signoff feature

Signed-off-by: mingcheng <mingcheng@apache.org>

* style: update log message formatting in git and openai modules πŸ–ŒοΈ (#13)

- Replace static string formatting with variable interpolation in log messages
- Apply consistent formatting for trace logs across `git.rs` and `openai.rs`

Signed-off-by: mingcheng <mingcheng@apache.org>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* docs: correct environment variable name in README πŸ“š

- Update `AIGITCOMMIT_SIGNOFF` to `GIT_AUTO_SIGNOFF` in README for consistency
- Reflect the correct variable used in the code for auto signoff feature

Signed-off-by: mingcheng <mingcheng@apache.org>

* docs: update file modification timestamps πŸ“…

- Adjust last modified timestamps in `main.rs` and `openai.rs` for accuracy
- Resolve merge conflict timestamp in `main.rs` to reflect latest update

Signed-off-by: mingcheng <mingcheng@apache.org>

---------

Signed-off-by: mingcheng <mingcheng@apache.org>
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
mingcheng added a commit that referenced this pull request Jul 11, 2025
- Replace static string formatting with variable interpolation in log messages
- Apply consistent formatting for trace logs across `git.rs` and `openai.rs`

Signed-off-by: mingcheng <mingcheng@apache.org>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
mingcheng added a commit that referenced this pull request Jul 11, 2025
- Replace static string formatting with variable interpolation in log messages
- Apply consistent formatting for trace logs across `git.rs` and `openai.rs`

Signed-off-by: mingcheng <mingcheng@apache.org>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
mingcheng added a commit that referenced this pull request Jul 11, 2025
* feat: implement signoff feature for commit messages ✍️

- Add signoff option to CLI arguments in `cli.rs`
- Implement author name and email retrieval in `git.rs`
- Append signoff to commit message in `main.rs` if enabled
- Add tests for author name and email functions in `git.rs`

Signed-off-by: mingcheng <mingcheng@apache.org>

* feat: add auto signoff detection from environment variable ✍️

- Implement detection of GIT_AUTO_SIGNOFF environment variable
- Enable signoff if environment variable is set to true or 1
- Update logic to combine CLI signoff option with environment variable check

Signed-off-by: mingcheng <mingcheng@apache.org>

* docs: update README with new environment variable for signoff πŸ“š

- Add `AIGITCOMMIT_SIGNOFF` environment variable to README
- Mention auto sign-off feature when variable is set to true

Signed-off-by: mingcheng <mingcheng@apache.org>

* style: update log message formatting in git and openai modules πŸ–ŒοΈ (#13)

- Replace static string formatting with variable interpolation in log messages
- Apply consistent formatting for trace logs across `git.rs` and `openai.rs`

Signed-off-by: mingcheng <mingcheng@apache.org>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* docs: correct environment variable name in README πŸ“š

- Update `AIGITCOMMIT_SIGNOFF` to `GIT_AUTO_SIGNOFF` in README for consistency
- Reflect the correct variable used in the code for auto signoff feature

Signed-off-by: mingcheng <mingcheng@apache.org>

* style: update log message formatting in git and openai modules πŸ–ŒοΈ (#13)

- Replace static string formatting with variable interpolation in log messages
- Apply consistent formatting for trace logs across `git.rs` and `openai.rs`

Signed-off-by: mingcheng <mingcheng@apache.org>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* docs: correct environment variable name in README πŸ“š

- Update `AIGITCOMMIT_SIGNOFF` to `GIT_AUTO_SIGNOFF` in README for consistency
- Reflect the correct variable used in the code for auto signoff feature

Signed-off-by: mingcheng <mingcheng@apache.org>

* docs: update file modification timestamps πŸ“…

- Adjust last modified timestamps in `main.rs` and `openai.rs` for accuracy
- Resolve merge conflict timestamp in `main.rs` to reflect latest update

Signed-off-by: mingcheng <mingcheng@apache.org>

* feat: update version to 1.3.3 and add grok keyword πŸš€

- Bump version from 1.3.2 to 1.3.3 in Cargo.toml
- Add "grok" to keywords list in package metadata

* feat: add CLI check for OpenAI API and model availability πŸ”

- Introduce --check flag in CLI to verify API key and model
- Implement check_model function to list and validate available models
- Integrate check logic in main.rs with error handling
- Comment out unused dependencies in Cargo.toml
- Update package categories in Cargo.toml

* refactor: simplify string formatting in model validation πŸ› οΈ

- Update error message formatting in main.rs to use direct variable interpolation
- Simplify debug and error messages in openai.rs with consistent string formatting
- Remove redundant string concatenation for cleaner code readability

Signed-off-by: mingcheng <mingcheng@apache.org>

* feat: implement signoff feature for git commits ✍️

- Add support for signed-off-by line in commit messages with configurable option
- Refactor commit function to accept signoff parameter in git.rs
- Retrieve author name and email from repository config for signoff
- Remove redundant signoff logic from main.rs and centralize in git.rs
- Update commit call in main.rs to pass signoff requirement

Signed-off-by: mingcheng <mingcheng@apache.org>

---------

Signed-off-by: mingcheng <mingcheng@apache.org>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
mingcheng added a commit that referenced this pull request Jul 11, 2025
* feat: implement signoff feature for commit messages ✍️

- Add signoff option to CLI arguments in `cli.rs`
- Implement author name and email retrieval in `git.rs`
- Append signoff to commit message in `main.rs` if enabled
- Add tests for author name and email functions in `git.rs`

Signed-off-by: mingcheng <mingcheng@apache.org>

* feat: add auto signoff detection from environment variable ✍️

- Implement detection of GIT_AUTO_SIGNOFF environment variable
- Enable signoff if environment variable is set to true or 1
- Update logic to combine CLI signoff option with environment variable check

Signed-off-by: mingcheng <mingcheng@apache.org>

* docs: update README with new environment variable for signoff πŸ“š

- Add `AIGITCOMMIT_SIGNOFF` environment variable to README
- Mention auto sign-off feature when variable is set to true

Signed-off-by: mingcheng <mingcheng@apache.org>

* style: update log message formatting in git and openai modules πŸ–ŒοΈ (#13)

- Replace static string formatting with variable interpolation in log messages
- Apply consistent formatting for trace logs across `git.rs` and `openai.rs`

Signed-off-by: mingcheng <mingcheng@apache.org>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* docs: correct environment variable name in README πŸ“š

- Update `AIGITCOMMIT_SIGNOFF` to `GIT_AUTO_SIGNOFF` in README for consistency
- Reflect the correct variable used in the code for auto signoff feature

Signed-off-by: mingcheng <mingcheng@apache.org>

* style: update log message formatting in git and openai modules πŸ–ŒοΈ (#13)

- Replace static string formatting with variable interpolation in log messages
- Apply consistent formatting for trace logs across `git.rs` and `openai.rs`

Signed-off-by: mingcheng <mingcheng@apache.org>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* docs: correct environment variable name in README πŸ“š

- Update `AIGITCOMMIT_SIGNOFF` to `GIT_AUTO_SIGNOFF` in README for consistency
- Reflect the correct variable used in the code for auto signoff feature

Signed-off-by: mingcheng <mingcheng@apache.org>

* docs: update file modification timestamps πŸ“…

- Adjust last modified timestamps in `main.rs` and `openai.rs` for accuracy
- Resolve merge conflict timestamp in `main.rs` to reflect latest update

Signed-off-by: mingcheng <mingcheng@apache.org>

* feat: update version to 1.3.3 and add grok keyword πŸš€

- Bump version from 1.3.2 to 1.3.3 in Cargo.toml
- Add "grok" to keywords list in package metadata

* feat: add CLI check for OpenAI API and model availability πŸ”

- Introduce --check flag in CLI to verify API key and model
- Implement check_model function to list and validate available models
- Integrate check logic in main.rs with error handling
- Comment out unused dependencies in Cargo.toml
- Update package categories in Cargo.toml

* refactor: simplify string formatting in model validation πŸ› οΈ

- Update error message formatting in main.rs to use direct variable interpolation
- Simplify debug and error messages in openai.rs with consistent string formatting
- Remove redundant string concatenation for cleaner code readability

Signed-off-by: mingcheng <mingcheng@apache.org>

* feat: implement signoff feature for git commits ✍️

- Add support for signed-off-by line in commit messages with configurable option
- Refactor commit function to accept signoff parameter in git.rs
- Retrieve author name and email from repository config for signoff
- Remove redundant signoff logic from main.rs and centralize in git.rs
- Update commit call in main.rs to pass signoff requirement

Signed-off-by: mingcheng <mingcheng@apache.org>

---------

Signed-off-by: mingcheng <mingcheng@apache.org>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant