Skip to content
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

GitAuto: [FEATURE] Preserve original message for merge conflict resolutions #114

Open
wants to merge 15 commits into
base: main
Choose a base branch
from

Conversation

gitauto-ai[bot]
Copy link
Contributor

@gitauto-ai gitauto-ai bot commented Nov 7, 2024

Resolves #113

What is the feature

Implement functionality in the dotnet-aicommitmessage tool to preserve original commit messages that follow the auto-generated format used during merge conflict resolutions.

Why we need the feature

Currently, the tool replaces all commit messages generated via the ChatGPT API (LLM models), which can inadvertently modify the intended context of merge conflict resolutions. Preserving the original messages ensures a clear and accurate version history, maintaining the context and intent behind merge conflict resolutions.

How to implement and why

  1. Pattern Detection: Utilize C# regular expressions to detect if a commit message matches the predefined auto-generated pattern for merge conflict resolutions.

  2. Bypass API Generation: If a commit message matches the merge conflict resolution pattern, bypass the ChatGPT API and retain the original message.

  3. Integration: Modify the existing commit message processing workflow to include the detection step before deciding whether to generate a new message or preserve the original.

  4. Unit Testing: Add comprehensive unit tests to verify the correct detection of merge conflict resolution patterns and ensure that messages are preserved or processed as intended based on their pattern.

This step-by-step approach ensures that only relevant messages are preserved while others continue to leverage the AI-powered commit message generation.

About backward compatibility

This feature introduces new pattern detection logic without altering the existing commit message generation workflows for messages that do not match the merge conflict pattern. Therefore, existing functionality remains unaffected, ensuring backward compatibility.

Test these changes locally

git checkout -b gitauto/issue-113-347f3d44-b7bf-48ef-97fb-2935758325ab
git pull origin gitauto/issue-113-347f3d44-b7bf-48ef-97fb-2935758325ab

Copy link
Contributor

coderabbitai bot commented Nov 7, 2024

Important

Review skipped

Bot user detected.

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.


🪧 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.
    • 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 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 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 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 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.

Copy link

deepsource-io bot commented Nov 7, 2024

Here's the code health analysis summary for commits d71398b..eb3c060. View details on DeepSource ↗.

Analysis Summary

AnalyzerStatusSummaryLink
DeepSource Shell LogoShell✅ SuccessView Check ↗
DeepSource Test coverage LogoTest coverage⚠️ Artifact not reportedTimed out: Artifact was never reportedView Check ↗
DeepSource Secrets LogoSecrets✅ SuccessView Check ↗
DeepSource Docker LogoDocker✅ SuccessView Check ↗
DeepSource C# LogoC#❌ Failure
❗ 1 occurence introduced
View Check ↗

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

@github-actions github-actions bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Nov 7, 2024
Copy link
Contributor Author

gitauto-ai bot commented Nov 7, 2024

Committed the Check Run Build error fix! Running it again...

Copy link
Contributor Author

gitauto-ai bot commented Nov 7, 2024

Committed the Check Run linter-check error fix! Running it again...

Copy link
Contributor Author

gitauto-ai bot commented Nov 7, 2024

Committed the Check Run Deep Source Coverage report error fix! Running it again...

Copy link
Contributor Author

gitauto-ai bot commented Nov 7, 2024

Committed the Check Run linter-check error fix! Running it again...

Copy link
Contributor Author

gitauto-ai bot commented Nov 7, 2024

Committed the Check Run Deep Source Coverage report error fix! Running it again...

Copy link
Contributor Author

gitauto-ai bot commented Nov 7, 2024

Committed the Check Run Analyze (csharp) error fix! Running it again...

@github-actions github-actions bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Nov 7, 2024
Copy link
Contributor Author

gitauto-ai bot commented Nov 7, 2024

Committed the Check Run Analyze (csharp) error fix! Running it again...

@gstraccini gstraccini bot added enhancement New feature or request gitauto GitAuto label to trigger the app in a issue. good first issue Good for newcomers hacktoberfest Participation in the Hacktoberfest event help wanted Extra attention is needed 🕒 low effort A task that can be completed in a few minutes labels Nov 7, 2024
@gstraccini gstraccini bot requested a review from guibranco November 7, 2024 00:16
@gstraccini gstraccini bot added 🚦 awaiting triage Items that are awaiting triage or categorization 🤖 bot Automated processes or integrations labels Nov 7, 2024
Copy link

Infisical secrets check: ✅ No secrets leaked!

💻 Scan logs
4:57AM INF scanning for exposed secrets...
4:57AM INF 110 commits scanned.
4:57AM INF scan completed in 84.3ms
4:57AM INF no leaks found

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🚦 awaiting triage Items that are awaiting triage or categorization 🤖 bot Automated processes or integrations enhancement New feature or request gitauto GitAuto label to trigger the app in a issue. good first issue Good for newcomers hacktoberfest Participation in the Hacktoberfest event help wanted Extra attention is needed 🕒 low effort A task that can be completed in a few minutes size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[FEATURE] Preserve original message for merge conflict resolutions
1 participant