1. Configure GitHub API Connection

To integrate with GitHub, you need to create a Personal Access Token:

• Go to GitHub Settings > Developer settings > Personal access tokens
• Generate a new token with appropriate permissions (repo, user, org)
• Copy the token and keep it secure

In Odoo, go to GitHub Integration > Configuration and create a new configuration:

• Enter a configuration name
• Paste your GitHub access token
• Set your GitHub username or organization
• Configure sync settings and limits

2. Synchronize GitHub Data

After configuration, you can start synchronizing GitHub data:

• Click "Test Connection" to verify your GitHub API access
• Use "Sync All Data" to start the synchronization process
• Monitor progress through the dashboard view
• Configure automatic sync via cron jobs

The module will automatically sync:

• Repositories and their metadata
• Branches and commit information
• Issues and their status
• Collaborators and permissions

3. Manage GitHub Repositories and Issues

Access your synced GitHub data through the module menus:

• View all repositories with their statistics
• Browse issues by status, author, or repository
• Track commit history and branch information
• Manage collaborator permissions

Each repository shows:

• Repository metadata (name, description, language)
• Statistics (stars, forks, open issues)
• Sync status and last update time
• Linked project integration

4. Create Project Tasks from GitHub Issues

Seamlessly integrate GitHub issues with Odoo project management:

• View GitHub issues in Odoo with full details
• Create project tasks directly from GitHub issues
• Automatic project creation if none exists
• Link tasks back to GitHub for tracking

Features include:

• Issue status tracking (open/closed)
• Author and assignee information
• Labels and milestone support
• Direct GitHub URL access

5. Monitor and Manage Sync Operations

Track synchronization progress and manage operations:

• Real-time sync progress tracking
• Multi-threaded operation monitoring
• Error handling and retry mechanisms
• Sync history and statistics

Advanced features include:

• Automatic sync settings adjustment based on repository size
• Rate limiting and timeout management
• Comprehensive logging and error reporting
• Dashboard with real-time metrics

6. Advanced Configuration and Customization

Customize the integration to match your workflow:

• Configure sync limits and timeouts
• Set up repository filtering (public/private/specific)
• Enable/disable specific sync features
• Configure multi-threading settings

Integration options:

• Link repositories to Odoo projects
• Automated sync scheduling
• Custom field mapping
• Webhook support for real-time updates

7. Performance and Reliability Features

Built for enterprise-grade reliability:

• Database concurrency handling with retry mechanisms
• Exponential backoff for API rate limiting
• Transaction isolation and safe database operations
• Comprehensive error handling and recovery

Performance optimizations:

• Smart caching and data persistence
• Efficient bulk operations
• Background job processing
• Memory and resource management

8. Webhook Support for Real-Time Updates

Configure a webhook on your GitHub repository:

• Go to GitHub -> Repository -> Settings -> Webhooks
• Payload URL: https://your-odoo.com/github/webhook
• Content type: application/json
• Secret: your shared secret (see Security below)
• Events: choose “Send me everything” or select from the list below

Security:

• Route: /github/webhook
• Signature headers supported: X-Hub-Signature-256 (sha256), X-Hub-Signature (sha1)
• System parameter for secret: ta_github_integration.webhook_secret (leave empty in dev to skip verification)
• Ping events are accepted without signature for connectivity checks

Supported Events:

• ping: connectivity check
• push: updates branches and commits
• issues: creates/updates issues; optionally creates project tasks
• pull_request: logs PR activities (extensible)
• issue_comment: updates issue comment counters
• pull_request_review and pull_request_review_comment: logs review activities
• create/delete (branch): creates or removes branches
• repository: updates repository metadata
• member: manages collaborators
• installation / installation_repositories: basic handling for GitHub App installations

Notes:

• Repository is matched by repository.full_name. Unknown repositories are ignored.
• All processing is logged; unexpected events are safely acknowledged.