GitHub Integration
Bi-directional synchronization between GitHub repositories and Gauzy projects/tasks.
Featuresโ
- Issue sync โ GitHub issues โ Gauzy tasks
- PR linking โ link pull requests to tasks
- Status sync โ issue status maps to task status
- Label sync โ GitHub labels map to task tags
- Webhook events โ real-time updates via webhooks
- Multi-repo โ connect multiple repositories
Setupโ
1. Install GitHub Appโ
Navigate to Settings โ Integrations โ GitHub and install the Gauzy GitHub App on your organization.
2. Configure Repository Mappingโ
Map GitHub repositories to Gauzy projects:
| GitHub Repo | โ | Gauzy Project |
|---|---|---|
org/frontend | โ | Frontend App |
org/backend | โ | Backend API |
3. Entity Sync Settingsโ
| Entity | Sync Direction | Default |
|---|---|---|
| Issues โ Tasks | โ Import | On |
| Tasks โ Issues | โ Export | Off |
| Labels โ Tags | โ Import | On |
| Milestones โ Sprints | โ Import | Off |
Configurationโ
GAUZY_GITHUB_APP_ID=123456
GAUZY_GITHUB_APP_NAME=ever-gauzy-dev
GAUZY_GITHUB_APP_PRIVATE_KEY=base64-encoded-private-key
GAUZY_GITHUB_WEBHOOK_SECRET=your-webhook-secret
GAUZY_GITHUB_CALLBACK_URL=https://api.yourdomain.com/api/integration/github/callback
GAUZY_GITHUB_POST_INSTALL_URL=https://app.yourdomain.com/pages/integrations/github/setup
Webhook Eventsโ
Handled webhook events:
| Event | Action |
|---|---|
issues.opened | Create task |
issues.edited | Update task |
issues.closed | Close task |
issues.reopened | Reopen task |
issues.labeled | Add tag |
issues.unlabeled | Remove tag |
pull_request.opened | Link PR to task |
pull_request.merged | Update task status |
installation.created | Activate integration |
Status Mappingโ
| GitHub Issue State | Gauzy Task Status |
|---|---|
open | Open |
closed | Done |