Getting StartedConnect CI
CircleCI
Connect Gitar with your CircleCI account to monitor builds, analyze failures, and automatically create fixes when CI builds fail
Prerequisites
Before setting up the CircleCI integration, ensure you have:
- Access to your CircleCI account
- A CircleCI Personal API Token
- Admin permissions in your organization (recommended for service accounts)
Setting Up CircleCI Integration
For production environments, we strongly recommend creating a dedicated service account like circleci-integration@yourcompany.com. This prevents issues when team members leave and provides better audit trails.
To create a Personal API Token:
- Log into your CircleCI account
- Go to Personal API Tokens
- Click "Create New Token"
- Name it "Gitar Integration"
- Copy the token immediately (you won't be able to see it again)
- Navigate to your Gitar organization settings
- Go to the Integrations section
- Look for the CircleCI integration
- Click "Connect" to begin the setup process
When you click the CircleCI "Connect" button, enter your CircleCI Personal API Token. The token will be securely stored and encrypted.
- Fill in the required API token field
- Click "Connect CircleCI" to establish the connection
- If successful, the integration status will show as connected
- If the connection fails, verify your token is valid and has not expired
How It Works
Once connected, Gitar will:
- Monitor CI Status: Track build statuses for your repositories
- Analyze Failures: Automatically analyze failed builds and identify root causes
- Create Fixes: Generate pull requests with potential fixes for CI failures
- Provide Insights: Offer detailed reports on build performance and failure patterns
Features
Build Monitoring
- Real-time tracking of CircleCI build statuses
- Integration with GitHub status checks
- Automatic detection of failed builds
Failure Analysis
- Automated analysis of build logs
- Identification of common failure patterns
- Root cause analysis with suggested fixes
Fix Generation
- Automatic creation of fixes for common issues
- Intelligent suggestions based on failure analysis
- Integration with your existing development workflow
Troubleshooting
Security Notes
- API tokens are encrypted and securely stored using AWS Secrets Manager
- Tokens can be revoked at any time from your CircleCI account settings
- We recommend rotating tokens regularly for enhanced security
- Use service accounts for production environments to avoid disruption