Create prepare-commit-msg #64
Conversation
|
Review changes with |
👋 Hi there!Everything looks good!
|
Please double check the following review of the pull request:Issues counts
Changes in the diff
Identified IssuesThere are no identified issues as the diff is empty. Missing TestsSince there are no changes in the diff, there are no missing tests to generate. Summon me to re-review when updated! Yours, Gooroo.dev |
|
🧙 Sourcery has finished reviewing your pull request! Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
WalkthroughThe changes introduce a new shell script located at Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Git
participant Script
participant DotnetAI
User->>Git: Initiates commit
Git->>Script: Executes prepare-commit-msg
Script->>Script: Check GIT_AICOMMIT_SKIP
Script->>Script: Verify dotnet-aicommitmessage presence
Script->>Script: Check commit message file existence
Script->>DotnetAI: Generate new commit message
DotnetAI-->>Script: Return generated message
Script->>Script: Validate generated message
alt Valid message
Script->>Git: Write new message
else Invalid message
Script->>Script: Restore original message
end
Script->>Script: Cleanup and exit
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Feedback
Great work on this PR! 🚀👍 |
Potential issues, bugs, and flaws that can introduce unwanted behavior:
Code suggestions and improvements for better exception handling, logic, standardization, and consistency:
By addressing these potential issues and applying the suggested improvements, the script can become more robust, maintainable, and user-friendly. |
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @guibranco - I've reviewed your changes and they look great!
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
![korbit-ai[bot]](https://avatars.githubusercontent.com/in/322216?s=60&v=4){kind=small}
There was a problem hiding this comment.
I've completed my review and didn't find any issues.
Need a new review? Comment
/korbit-reviewon this PR and I'll review your latest changes.Korbit Guide: Usage and Customization
Interacting with Korbit
- You can manually ask Korbit to review your PR using the
/korbit-reviewcommand in a comment at the root of your PR.- You can ask Korbit to generate a new PR description using the
/korbit-generate-pr-descriptioncommand in any comment on your PR.- Too many Korbit comments? I can resolve all my comment threads if you use the
/korbit-resolvecommand in any comment on your PR.- Chat with Korbit on issues we post by tagging @korbit-ai in your reply.
- Help train Korbit to improve your reviews by giving a 👍 or 👎 on the comments Korbit posts.
Customizing Korbit
- Check out our docs on how you can make Korbit work best for you and your team.
- Customize Korbit for your organization through the Korbit Console.
Current Korbit Configuration
General Settings
Setting Value Review Schedule Automatic excluding drafts Max Issue Count 10 Automatic PR Descriptions ✅ Issue Categories
Category Enabled Naming ✅ Database Operations ✅ Documentation ✅ Logging ✅ Error Handling ✅ Systems and Environment ✅ Objects and Data Structures ✅ Readability and Maintainability ✅ Asynchronous Processing ✅ Design Patterns ✅ Third-Party Libraries ✅ Performance ✅ Security ✅ Functionality ✅ Feedback and Support
|
Infisical secrets check: ✅ No secrets leaked! 💻 Scan logs3:50PM INF scanning for exposed secrets...
3:50PM INF 63 commits scanned.
3:50PM INF scan completed in 68ms
3:50PM INF no leaks found
|
![gstraccini[bot]](https://avatars.githubusercontent.com/in/480132?s=60&v=4){kind=small}
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🧹 Outside diff range and nitpick comments (2)
.githooks/prepare-commit-msg (2)
1-9: Consider enhancing the script header and documentation.While the current implementation is functional, consider these improvements:
- Use
/bin/shinstead ofenv shfor better portability- Add usage examples and environment variable documentation
-#!/usr/bin/env sh +#!/bin/sh # This script generates an AI-powered commit message using dotnet-aicommitmessage. # It can be bypassed by setting the GIT_AICOMMIT_SKIP environment variable. +# +# Usage: +# This script is intended to be used as a Git prepare-commit-msg hook. +# To install: cp .githooks/prepare-commit-msg .git/hooks/ +# +# Environment variables: +# GIT_AICOMMIT_SKIP: Set to any value to bypass AI commit message generation
44-60: Implement trap-based cleanup for better reliability.While the current cleanup is good, using a trap ensures cleanup happens even if the script exits unexpectedly.
+# Setup cleanup trap +cleanup() { + [ -f "${COMMIT_MSG_FILE}.bak" ] && rm "${COMMIT_MSG_FILE}.bak" +} +trap cleanup EXIT + # Check if the generated message is empty if [ -z "$AI_MESSAGE" ] || echo "$AI_MESSAGE" | grep -q '^[[:space:]]*$'; then echo "Error: Generated commit message is empty." >&2 exit 1 fi # Write the new commit message back to the file if ! echo "$AI_MESSAGE" > "$COMMIT_MSG_FILE" 2>/dev/null; then echo "Error: Failed to write new commit message" >&2 cp "${COMMIT_MSG_FILE}.bak" "$COMMIT_MSG_FILE" - rm "${COMMIT_MSG_FILE}.bak" exit 1 fi -# Remove the backup file -rm "${COMMIT_MSG_FILE}.bak" exit 0
| # Read the current commit message | ||
| CURRENT_MESSAGE=$(cat "$COMMIT_MSG_FILE") | ||
|
|
||
| # Backup the commit message file | ||
| cp "$COMMIT_MSG_FILE" "${COMMIT_MSG_FILE}.bak" | ||
|
|
||
| # Generate the AI commit message | ||
| if ! AI_MESSAGE=$(dotnet-aicommitmessage generate-message -m "$CURRENT_MESSAGE" 2>/dev/null); then | ||
| echo "Error: Failed to generate AI commit message. Using original message." >&2 | ||
| exit 0 | ||
| fi |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Enhance error handling for the AI message generation.
The current implementation could be more robust by explicitly checking the tool's exit code and providing more detailed error information.
-if ! AI_MESSAGE=$(dotnet-aicommitmessage generate-message -m "$CURRENT_MESSAGE" 2>/dev/null); then
+# Capture both output and exit code
+AI_MESSAGE=$(dotnet-aicommitmessage generate-message -m "$CURRENT_MESSAGE" 2>&1)
+EXIT_CODE=$?
+if [ $EXIT_CODE -ne 0 ]; then
echo "Error: Failed to generate AI commit message. Using original message." >&2
+ echo "Details: $AI_MESSAGE" >&2
exit 0
fi📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| # Read the current commit message | |
| CURRENT_MESSAGE=$(cat "$COMMIT_MSG_FILE") | |
| # Backup the commit message file | |
| cp "$COMMIT_MSG_FILE" "${COMMIT_MSG_FILE}.bak" | |
| # Generate the AI commit message | |
| if ! AI_MESSAGE=$(dotnet-aicommitmessage generate-message -m "$CURRENT_MESSAGE" 2>/dev/null); then | |
| echo "Error: Failed to generate AI commit message. Using original message." >&2 | |
| exit 0 | |
| fi | |
| # Read the current commit message | |
| CURRENT_MESSAGE=$(cat "$COMMIT_MSG_FILE") | |
| # Backup the commit message file | |
| cp "$COMMIT_MSG_FILE" "${COMMIT_MSG_FILE}.bak" | |
| # Generate the AI commit message | |
| # Capture both output and exit code | |
| AI_MESSAGE=$(dotnet-aicommitmessage generate-message -m "$CURRENT_MESSAGE" 2>&1) | |
| EXIT_CODE=$? | |
| if [ $EXIT_CODE -ne 0 ]; then | |
| echo "Error: Failed to generate AI commit message. Using original message." >&2 | |
| echo "Details: $AI_MESSAGE" >&2 | |
| exit 0 | |
| fi |
| # Check if dotnet-aicommitmessage is installed and in PATH | ||
| if ! command -v dotnet-aicommitmessage >/dev/null 2>&1; then | ||
| echo "Error: dotnet-aicommitmessage is not installed or not in PATH" >&2 | ||
| echo "Please install it by running 'dotnet tool install -g aicommitmessage'" >&2 | ||
| exit 1 | ||
| fi |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add version compatibility check for dotnet-aicommitmessage.
While the tool presence check is good, it's important to ensure compatibility by verifying the tool version.
if ! command -v dotnet-aicommitmessage >/dev/null 2>&1; then
echo "Error: dotnet-aicommitmessage is not installed or not in PATH" >&2
echo "Please install it by running 'dotnet tool install -g aicommitmessage'" >&2
exit 1
fi
+
+# Check tool version
+REQUIRED_VERSION="1.0.0" # Replace with minimum required version
+CURRENT_VERSION=$(dotnet-aicommitmessage --version 2>/dev/null)
+if [ $? -ne 0 ] || ! echo "$CURRENT_VERSION" | grep -q "^$REQUIRED_VERSION"; then
+ echo "Error: dotnet-aicommitmessage version $REQUIRED_VERSION or higher is required" >&2
+ echo "Current version: $CURRENT_VERSION" >&2
+ exit 1
+fiCommittable suggestion skipped: line range outside the PR's diff.
| # Ensure the commit message file is provided | ||
| if [ -z "$1" ]; then | ||
| echo "Error: Commit message file not provided" >&2 | ||
| exit 1 | ||
| fi | ||
|
|
||
| COMMIT_MSG_FILE="$1" | ||
|
|
||
| # Check if the commit message file exists | ||
| if [ ! -f "$COMMIT_MSG_FILE" ]; then | ||
| echo "Error: Commit message file '$COMMIT_MSG_FILE' not found" >&2 | ||
| exit 1 | ||
| fi |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add file permission checks.
While the file existence check is good, it's important to verify read/write permissions to prevent failures later.
if [ ! -f "$COMMIT_MSG_FILE" ]; then
echo "Error: Commit message file '$COMMIT_MSG_FILE' not found" >&2
exit 1
fi
+
+# Check file permissions
+if [ ! -r "$COMMIT_MSG_FILE" ] || [ ! -w "$COMMIT_MSG_FILE" ]; then
+ echo "Error: Insufficient permissions for '$COMMIT_MSG_FILE'" >&2
+ exit 1
+fi📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| # Ensure the commit message file is provided | |
| if [ -z "$1" ]; then | |
| echo "Error: Commit message file not provided" >&2 | |
| exit 1 | |
| fi | |
| COMMIT_MSG_FILE="$1" | |
| # Check if the commit message file exists | |
| if [ ! -f "$COMMIT_MSG_FILE" ]; then | |
| echo "Error: Commit message file '$COMMIT_MSG_FILE' not found" >&2 | |
| exit 1 | |
| fi | |
| # Ensure the commit message file is provided | |
| if [ -z "$1" ]; then | |
| echo "Error: Commit message file not provided" >&2 | |
| exit 1 | |
| fi | |
| COMMIT_MSG_FILE="$1" | |
| # Check if the commit message file exists | |
| if [ ! -f "$COMMIT_MSG_FILE" ]; then | |
| echo "Error: Commit message file '$COMMIT_MSG_FILE' not found" >&2 | |
| exit 1 | |
| fi | |
| # Check file permissions | |
| if [ ! -r "$COMMIT_MSG_FILE" ] || [ ! -w "$COMMIT_MSG_FILE" ]; then | |
| echo "Error: Insufficient permissions for '$COMMIT_MSG_FILE'" >&2 | |
| exit 1 | |
| fi |
| #!/usr/bin/env sh | ||
|
|
||
| # This script generates an AI-powered commit message using dotnet-aicommitmessage. | ||
| # It can be bypassed by setting the GIT_AICOMMIT_SKIP environment variable. | ||
|
|
||
| # Exit immediately if GIT_AICOMMIT_SKIP is set | ||
| if [ -n "$GIT_AICOMMIT_SKIP" ]; then | ||
| exit 0 | ||
| fi | ||
|
|
||
| # Check if dotnet-aicommitmessage is installed and in PATH | ||
| if ! command -v dotnet-aicommitmessage >/dev/null 2>&1; then | ||
| echo "Error: dotnet-aicommitmessage is not installed or not in PATH" >&2 | ||
| echo "Please install it by running 'dotnet tool install -g aicommitmessage'" >&2 | ||
| exit 1 | ||
| fi | ||
|
|
||
| # Ensure the commit message file is provided | ||
| if [ -z "$1" ]; then | ||
| echo "Error: Commit message file not provided" >&2 | ||
| exit 1 | ||
| fi | ||
|
|
||
| COMMIT_MSG_FILE="$1" | ||
|
|
||
| # Check if the commit message file exists | ||
| if [ ! -f "$COMMIT_MSG_FILE" ]; then | ||
| echo "Error: Commit message file '$COMMIT_MSG_FILE' not found" >&2 | ||
| exit 1 | ||
| fi | ||
|
|
||
| # Read the current commit message | ||
| CURRENT_MESSAGE=$(cat "$COMMIT_MSG_FILE") | ||
|
|
||
| # Backup the commit message file | ||
| cp "$COMMIT_MSG_FILE" "${COMMIT_MSG_FILE}.bak" | ||
|
|
||
| # Generate the AI commit message | ||
| if ! AI_MESSAGE=$(dotnet-aicommitmessage generate-message -m "$CURRENT_MESSAGE" 2>/dev/null); then | ||
| echo "Error: Failed to generate AI commit message. Using original message." >&2 | ||
| exit 0 | ||
| fi | ||
|
|
||
| # Check if the generated message is empty | ||
| if [ -z "$AI_MESSAGE" ] || echo "$AI_MESSAGE" | grep -q '^[[:space:]]*$'; then | ||
| echo "Error: Generated commit message is empty." >&2 | ||
| exit 1 | ||
| fi | ||
|
|
||
| # Write the new commit message back to the file | ||
| if ! echo "$AI_MESSAGE" > "$COMMIT_MSG_FILE" 2>/dev/null; then | ||
| echo "Error: Failed to write new commit message" >&2 | ||
| cp "${COMMIT_MSG_FILE}.bak" "$COMMIT_MSG_FILE" | ||
| rm "${COMMIT_MSG_FILE}.bak" | ||
| exit 1 | ||
| fi | ||
|
|
||
| # Remove the backup file | ||
| rm "${COMMIT_MSG_FILE}.bak" | ||
| exit 0 |
There was a problem hiding this comment.
💡 Codebase verification
Git hooks setup process needs to be implemented
The repository lacks an automated Git hooks installation process. Neither the installation scripts (install.sh, install.ps1) nor the README contain any mention of Git hooks setup.
- The
.githooks/prepare-commit-msghook won't be automatically installed for developers. - No documentation exists about manual hook installation.
- No automated setup process found for configuring Git hooks.
Consider implementing one of these solutions:
- Add
git config core.hooksPath .githooksto both installation scripts - Add documentation in README.md about manual hook installation
- Use a Git hooks management tool like Husky
🔗 Analysis chain
Verify Git hook installation process.
The script is placed in .githooks/, but we should verify if there's a process to automatically install/update this hook for all developers.
Consider adding one of these options to automate hook installation:
- Add hook installation to the project's setup/install script
- Use
git config core.hooksPath .githooksin the project setup - Document the manual installation process in the README
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Check if there's any automated hook installation process
rg -l "prepare-commit-msg" --type sh
Length of output: 36
Script:
#!/bin/bash
# Let's check for any setup scripts, package.json, or README that might mention git hooks setup
fd -t f "^(package\.json|README\.md|setup.*|install.*|init\..*|configure\..*|husky\..*|\.husky.*|\.git.*)"
# Also check for any files mentioning git hooks configuration
rg -l "git.*hooks?" --type-not lock
Length of output: 179
Script:
#!/bin/bash
# Let's check the content of install scripts and README for git hooks setup
cat install.sh
cat install.ps1
cat README.md
Length of output: 2764
Closes #
📑 Description
✅ Checks
☢️ Does this introduce a breaking change?
ℹ Additional Information
Description by Korbit AI
What change is being made?
Add a Git hook script
prepare-commit-msgthat usesdotnet-aicommitmessageto automatically generate an AI-powered commit message, allowing manual override via theGIT_AICOMMIT_SKIPenvironment variable.Why are these changes being made?
This change introduces automation to enhance commit message quality by leveraging AI, streamlining the commit process and potentially improving consistency and descriptiveness of commit logs. The inclusion of a skip option ensures flexibility for manual input when needed or preferred.
Summary by CodeRabbit