Working with Gitar
How Gitar works with you on your PRs/MRs
Gitar works on every PR/MR
When a new PR/MR is created, Gitar posts a welcome message
This notifies that Gitar is actively monitoring for failures and comments that start with Gitar.
There are options in the comment to control default behavior like disabling automatic ci failure fixing etc. The default behavior for all repositories can be configured in settings
This comment is the centralized dashboard for Gitar to post status updates about it's activity to the PR/MR. This comemnt is updated as Gitar takes actions and will show a live status of what it is working on.
Fix CI Failures
When CI fails, Gitar analyzes logs, identifies root causes, implements fixes, and pushes changes to the branch.
Gitar is capable of fixing build errors, linting errors, test failures, and more.
Address Review Comments
Start comments with Gitar and Gitar will address the comment and push a fix. Gitar only processes comments from users with repository write access for security reasons. Be specific and actionable in your requests.
Gitar reacts to your comment with 👀 to indicate it has started working on it.
Example Workflow
Here is an example workflow of Gitar fixing CI failures and addressing user comments on a PR.
After the initail message, a user posts a request via a comment. Gitar acknowledges it is looking at the request.
CI has also failed because of test failures, at this point Gitar will update it's comment with the current status.
After a few minutes, Gitar resolves both issues and pushes commits to the PR and explains what it did. At this point, the user comment as well as CI failures are solved. CI is green and the PR is ready for merging.
Troubleshooting
Gitar Isn't Responding to Comments
Start comments with "Gitar" - Make sure your comment begins with Gitar (case insensitive) to trigger a response.
Check repository permissions - Ensure you have write access to the repository. Only users with write access can trigger Gitar responses.
Verify the integration is enabled - Check that the [x] Do not fix CI failures box isn't checked in the welcome message.
CI Still Failing After Gitar's Fixes
Multiple iterations may be needed - Complex CI failures sometimes require several rounds of fixes. Gitar will automatically iterate on new CI failures to resolve them and make CI green.
Provide additional context - If Gitar's fixes aren't working as expected, add a comment with more details about the specific failure. Gitar maintains full context of your PR/MR throughout it's lifetime so you can comment to steer the Gitar agent's behavior at anytime.
Instruct Gitar on how to use your build system / development practices - Consider instructing Gitar on how to best use your build environments, development practices, or other behaviors it should follow by giving it custom AI rules.