git: Fix git message parsing #329

Donach · 2024-07-25T20:54:17Z

Add data of Author and Date to footer

Why

I've tested the tool and decided to implement it in our company.
However, there are some logical flaws which prevent us from using it.
We have a policy that if a commit change is small enough, there is no need to fill in the body - the tool itself also allows to set for empty body of commit message.

However parsing of git commits with no body message creates problems.
At the same time, it seems like the tool doesn't even properly split the messages, since when you use "--pretty=%B", it will return only subject+body of the commit message, so the fn extract_commit_messages will not work to separate commits properly.

By applying this fix, I was able to fix this major flaw, it also breaks no tests and no other changes are necessary.

One minor bug -> if somebody would "abuse" my usage of "|" as artificial separator, it might break the logic a bit, but IMO that is very rare case to happen.

I'm open for discussion on how to improve it further, as we don't wanna overhaul the whole tool just to fit our "few special needs".

Summary by CodeRabbit

New Features
- Enhanced commit message retrieval with additional details such as author, date, and commit hash.
- Improved parsing of commit messages to eliminate empty messages and accommodate various formatting styles.
Bug Fixes
- Fixed issues with commit message extraction by refining delimiters and ensuring only valid message lines are processed.

coderabbitai · 2024-07-25T20:54:24Z

Warning

Rate limit exceeded

@Donach has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 20 minutes and 58 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between c9cb50d and 4cc9dcb.

Walkthrough

The recent changes enhance the functionality of commit message retrieval and processing in the src/git.rs file. Adjustments to the read and extract_commit_messages functions improve the format and quality of commit messages extracted from the git log. By including additional commit details and refining message parsing rules, the updates ensure better handling and representation of commit information.

Changes

File	Change Summary
`src/git.rs`	Updated `read` function to use a more detailed git log format. Modified `extract_commit_messages` to improve message splitting and prevent empty messages. Adjusted `parse_commit_message` conditions for footer recognition.

Poem

In the world of commits, so bright and grand,
A rabbit hops swiftly, with changes so planned.
With messages clearer, and formats so neat,
Our git logs are tidy, a marvelous feat!
So let’s dance with joy, in the digital air,
For every new commit, with love and with care! 🐇✨

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?

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>.
- Generate unit testing code for this file.
- 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 generate unit testing code for this file.
- @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 generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @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.

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 as 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 resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 2755233 and c9cb50d.

Files selected for processing (1)

src/git.rs (3 hunks)

Additional comments not posted (3)

src/git.rs (3)

35-35: LGTM! The updated format string enhances the information retrieved from the git log.

The new format string includes additional commit details, which improves the functionality.

51-61: LGTM! The changes improve the handling of commits without body messages.

The regular expression modification and the conditional check ensure that only non-empty message lines are included, improving the quality of the output.

94-94: LGTM! The changes broaden the criteria for recognizing the end of the message body.

Considering lines that contain only a pipe character (|) improves the functionality by accommodating different formatting styles in commit messages.

Donach · 2024-07-25T20:55:40Z

src/git.rs

@@ -89,7 +91,7 @@ pub fn parse_commit_message(

    for line in lines_iter {
        if line.trim().is_empty() {
-            if in_body {
+            if in_body || line.trim() == "|" {


In case there is no body, this is necessary as we will skip the body and the "|" will help us switch to footers.

Thank you!

I would like to have a unit test for no body test case 🙏

- Add data of Author and Date to footer

Donach · 2024-07-25T21:04:58Z

src/git.rs

        .arg("--no-merges")
        .arg("--no-decorate")
        .arg("--reverse")
        .arg(range)
+        .arg(opt_target)


This is also quite handy - in case no range is specified, this will ensure we compare only current branch - IMO quite major use-case for regular every day development.
You don't care for commit linting on master, since you cannot usually just rebase it as you want. -> also if all commits that are merged to master are already valid by commitlint, no need to run it there at all...

KeisukeYamashita

Thank you for your PR! I'll check this not later than this weekend!

KeisukeYamashita · 2024-07-30T00:02:47Z

Sorry for the delay, thank you for your PR!
We need some unit tests for it!

Donach · 2024-08-02T21:46:46Z

I'll try to take a look within the next few weeks if there are some sensible tests to be added...

Donach requested a review from KeisukeYamashita as a code owner July 25, 2024 20:54

coderabbitai bot reviewed Jul 25, 2024

View reviewed changes

Donach commented Jul 25, 2024

View reviewed changes

Donach force-pushed the donach/Fix-git-message-parsing branch 2 times, most recently from 95c2ee0 to 0bb0a17 Compare July 25, 2024 21:01

git: Fix git message parsing

4cc9dcb

- Add data of Author and Date to footer

Donach force-pushed the donach/Fix-git-message-parsing branch from 0bb0a17 to 4cc9dcb Compare July 25, 2024 21:03

Donach commented Jul 25, 2024

View reviewed changes

KeisukeYamashita assigned Donach Jul 26, 2024

KeisukeYamashita reviewed Jul 26, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

git: Fix git message parsing #329

git: Fix git message parsing #329

Donach commented Jul 25, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jul 25, 2024 •

edited

Loading

Rate limit exceeded

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

Donach Jul 25, 2024

KeisukeYamashita Aug 2, 2024 •

edited

Loading

Donach Jul 25, 2024

KeisukeYamashita left a comment •

edited

Loading

KeisukeYamashita commented Jul 30, 2024

Donach commented Aug 2, 2024

git: Fix git message parsing #329

Are you sure you want to change the base?

git: Fix git message parsing #329

Conversation

Donach commented Jul 25, 2024 • edited by coderabbitai bot Loading

Why

Summary by CodeRabbit

coderabbitai bot commented Jul 25, 2024 • edited Loading

Rate limit exceeded

Walkthrough

Changes

Poem

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

Donach Jul 25, 2024

Choose a reason for hiding this comment

KeisukeYamashita Aug 2, 2024 • edited Loading

Choose a reason for hiding this comment

Donach Jul 25, 2024

Choose a reason for hiding this comment

KeisukeYamashita left a comment • edited Loading

Choose a reason for hiding this comment

KeisukeYamashita commented Jul 30, 2024

Donach commented Aug 2, 2024

Donach commented Jul 25, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jul 25, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

KeisukeYamashita Aug 2, 2024 •

edited

Loading

KeisukeYamashita left a comment •

edited

Loading