Ga naar hoofdinhoud

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​

EntitySync DirectionDefault
Issues β†’ Tasksβœ… ImportOn
Tasks β†’ Issuesβœ… ExportOff
Labels β†’ Tagsβœ… ImportOn
Milestones β†’ Sprintsβœ… ImportOff

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:

EventAction
issues.openedCreate task
issues.editedUpdate task
issues.closedClose task
issues.reopenedReopen task
issues.labeledAdd tag
issues.unlabeledRemove tag
pull_request.openedLink PR to task
pull_request.mergedUpdate task status
installation.createdActivate integration

Status Mapping​

GitHub Issue StateGauzy Task Status
openOpen
closedDone