GitHub Integration
The Reshot GitHub App notifies your team of visual changes by commenting on Pull Requests with a visual diff summary.
How It Works
- PR Comment: When
reshot publishruns in CI, it posts a comment summarizing visual changes - Visual Diff: The comment links directly to the review dashboard with side-by-side diffs
- Non-Blocking: Merges are not blocked—your team stays informed without slowing down
- Approval: Team members can approve changes in the dashboard at their convenience
Blocking Mode: If you need strict governance, you can enable blocking mode in your project settings. See CI/CD Integration for configuration.
Installation
1. Go to Project Settings
Navigate to Settings > Integrations in your project dashboard.
2. Install GitHub App
Click "Install Reshot GitHub App" and authorize for your repository.
3. Configure Repository
Select which repositories should receive visual change notifications.
Permissions
The GitHub App requests these permissions:
| Permission | Access | Purpose |
|---|---|---|
| Metadata | Read | Repository information |
| Pull requests | Read & Write | Post PR comments with visual diffs |
| Commit statuses | Write | (Optional) Set status checks in blocking mode |
We do not read or store your source code. We only process the visual assets you explicitly publish.
Workflow
On Feature Branch
- Developer makes UI changes
- Runs
reshot runlocally - Pushes code and opens PR
- CI runs
reshot publish - Reshot comments on PR with visual changes summary
Review
- Team member clicks link in PR comment
- Reviews visual changes in dashboard
- Approves or rejects changes
- CDN URLs update immediately
Strict Governance (Optional)
For teams that require approval before merging:
- Go to GitHub Settings > Branches
- Edit your branch protection rule
- Enable "Require status checks"
- Add
reshot/visual-checkas required
This ensures no PR can merge with pending visual reviews.