GitHub Integration
GitHub integration enables powerful features like repository cloning, pull request creation, and issue-triggered automations.
Integration Types
Section titled “Integration Types”Cheffed uses two GitHub integration methods:
| Type | Purpose | Required For |
|---|---|---|
| OAuth | User authentication, personal repos | Basic repo access |
| GitHub App | Organization repos, webhooks | Automations, org access |
GitHub OAuth
Section titled “GitHub OAuth”OAuth connects your GitHub account to Cheffed.
Connecting OAuth
Section titled “Connecting OAuth”- Go to Settings in the sidebar
- Find the GitHub section
- Click Connect GitHub
- Authorize Cheffed in the GitHub popup
- Return to Cheffed - your account is now connected
OAuth Permissions
Section titled “OAuth Permissions”Cheffed requests these OAuth scopes:
| Scope | Purpose |
|---|---|
repo | Read/write access to repositories |
read:user | Read your GitHub profile |
user:email | Access your email address |
What OAuth Enables
Section titled “What OAuth Enables”With OAuth connected, you can:
- Clone personal repositories into sessions
- Create branches and commits
- Push changes to your repos
- Create pull requests
GitHub App
Section titled “GitHub App”The GitHub App provides webhook integration for automations and access to organization repositories.
Installing the GitHub App
Section titled “Installing the GitHub App”- Go to Settings in the sidebar
- Find GitHub App section
- Click Install GitHub App
- Select your organization or personal account
- Choose which repositories to grant access
- Complete the installation
App Permissions
Section titled “App Permissions”The Cheffed GitHub App requests:
| Permission | Access | Purpose |
|---|---|---|
| Repository contents | Read & Write | Clone, read files, push commits |
| Issues | Read & Write | Read issues, post comments |
| Pull requests | Read & Write | Create PRs, read PR data |
| Webhooks | Write | Receive events for automations |
What the App Enables
Section titled “What the App Enables”With the GitHub App installed:
- Access organization repositories
- Receive webhooks for automations
- Post comments on issues and PRs
- Create pull requests from sessions
Repository Access
Section titled “Repository Access”Selecting Repositories
Section titled “Selecting Repositories”During sessions, you can select from:
- Personal repositories (via OAuth)
- Organization repositories (via GitHub App)
Only repositories you have access to will appear.
Repository Cloning
Section titled “Repository Cloning”When you connect a repository to a session:
- Repository is cloned into the session container
- Full git history is available
- Agent can read, modify, and commit files
- Default branch is checked out
Working with Branches
Section titled “Working with Branches”Agents can:
- Create new branches
- Switch between branches
- Commit changes
- Push to remote (with your permissions)
Pull Request Creation
Section titled “Pull Request Creation”Agents can create pull requests from session work:
Automatic PR Creation
Section titled “Automatic PR Creation”Configure your agent to create PRs automatically:
After making changes, create a pull request with:- Clear title describing the change- Description explaining what was done- Reference to related issuesPR Details
Section titled “PR Details”Created PRs include:
- Title - Descriptive summary
- Body - Explanation of changes
- Base branch - Target branch (usually
main) - Head branch - Branch with changes
- Reviewers - Optional reviewer assignment
Issue Integration
Section titled “Issue Integration”Reading Issues
Section titled “Reading Issues”Agents can access issue data:
- Issue title and body
- Labels and assignees
- Comments and reactions
- Related PRs
Posting Comments
Section titled “Posting Comments”Agents can comment on issues:
- Analysis findings
- Status updates
- Questions for clarification
- Resolution summaries
Automations with GitHub
Section titled “Automations with GitHub”GitHub events can trigger automations:
Issue Triggers
Section titled “Issue Triggers”Automate on issue events:
- New issue created
- Issue labeled
- Issue edited
PR Triggers
Section titled “PR Triggers”Automate on PR events:
- PR opened
- New commits pushed
- PR merged
See Event Triggers for configuration details.
Troubleshooting
Section titled “Troubleshooting”OAuth Not Working
Section titled “OAuth Not Working”| Problem | Solution |
|---|---|
| Can’t connect | Clear browser cache, try again |
| Missing repos | Check repo visibility and permissions |
| Token expired | Reconnect GitHub in Settings |
GitHub App Issues
Section titled “GitHub App Issues”| Problem | Solution |
|---|---|
| App not installed | Complete installation in GitHub |
| Missing org repos | Install app on the organization |
| Webhooks not firing | Check app installation permissions |
Permission Errors
Section titled “Permission Errors”If you see “Permission denied” errors:
- Verify OAuth is connected
- Check GitHub App is installed on the repo
- Confirm you have write access to the repository
- Try reconnecting OAuth
Security Considerations
Section titled “Security Considerations”Token Storage
Section titled “Token Storage”- OAuth tokens are encrypted at rest
- Tokens are only used for authorized actions
- Tokens can be revoked at any time
Revoking Access
Section titled “Revoking Access”To disconnect GitHub:
- Go to Settings
- Click Disconnect next to GitHub
- Optionally revoke access in GitHub settings
Audit Trail
Section titled “Audit Trail”All GitHub actions are logged:
- Repository clones
- Commits and pushes
- PR creation
- Comments posted
Next Steps
Section titled “Next Steps”- Set up AI Providers for your sessions
- Create Automations with GitHub triggers
- Learn about Cloud Providers for deployments