GitHub Integration
Link repositories, sync issues, and document pull requests with BlockForge's GitHub integration.
Overview
The GitHub integration enables:
- Repository Linking - Connect GitHub repos to BlockForge
- Issue Syncing - Sync GitHub issues as BlockForge pages
- PR Documentation - Document pull requests automatically
- Project Dashboards - Generate project overview pages
Setup
Prerequisites
- GitHub account
- BlockForge workspace
- Repository access permissions
Enable GitHub OAuth
- In BlockForge, go to Settings → Integrations
- Click GitHub integration
- Authorize BlockForge to access your GitHub account
- Grant necessary permissions:
- Read repository access
- Read issues and pull requests
Linking a Repository
From BlockForge
- Go to Integrations → GitHub
- Click Link Repository
- Search for repository
- Click Link to connect
From Cursor Extension
- Open repository folder in Cursor
- Command Palette → "BlockForge: Link GitHub Repository"
- Extension auto-detects repo from git remote
- Confirm linking
Syncing Issues
Sync All Issues
- Open linked repository in BlockForge
- Click Sync Issues
- Choose issue status:
- Open Issues - Only open issues
- Closed Issues - Only closed issues
- All Issues - Both open and closed
- Issues sync as pages in BlockForge
Issue Page Format
Synced issues appear as pages with:
- Issue title and number
- Link to GitHub issue
- Repository information
- Issue body content (formatted)
- Labels and assignees
- Comments (optional)
Automatic Updates
- Issues update when manually synced
- Or enable auto-sync for continuous updates
- Changes appear in BlockForge pages
Documenting Pull Requests
Document a PR
- In repository page, click Document PR
- Enter PR number
- PR documentation is created with:
- PR title and number
- Link to GitHub PR
- Repository and branch info
- PR state (open/closed/merged)
- PR body content
- Files changed (summary)
From Cursor Extension
- Command Palette → "BlockForge: Document Pull Request"
- Enter PR number
- PR page is created automatically
Project Dashboards
Generate comprehensive project dashboards:
- Click Generate Dashboard on repository page
- Dashboard includes:
- Repository overview
- Recent issues
- Recent pull requests
- Activity summary
- Links to GitHub
Use Cases
Project Documentation
- Document all project issues
- Track PR progress
- Maintain project overview
Team Collaboration
- Share issue discussions
- Document decision-making
- Track project status
Knowledge Base
- Create project knowledge base
- Link code and documentation
- Maintain project history
Best Practices
- Regular syncing - Sync issues regularly for up-to-date info
- Organize by repo - Use collections to organize by repository
- Link related content - Link issues to related pages
- Use dashboards - Create dashboards for key projects
Troubleshooting
Authentication Issues
- Re-authorize GitHub in Settings
- Check GitHub permissions
- Verify token hasn't expired
Sync Failures
- Check repository accessibility
- Verify GitHub API limits
- Review error messages
Missing Issues
- Ensure repository is linked
- Check issue visibility permissions
- Verify sync status in BlockForge