Poliage

GitHub Integration

The Poliage GitHub App notifies your team of visual changes by commenting on Pull Requests with a visual diff summary.

How It Works

  1. PR Comment: When poliage publish runs in CI, it posts a comment summarizing visual changes
  2. Visual Diff: The comment links directly to the review dashboard with side-by-side diffs
  3. Non-Blocking: Merges are not blocked—your team stays informed without slowing down
  4. 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.

GitHub Integration Settings
The GitHub integration settings page

2. Install GitHub App

Click "Install Poliage 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:

PermissionAccessPurpose
MetadataReadRepository information
Pull requestsRead & WritePost PR comments with visual diffs
Commit statusesWrite(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

  1. Developer makes UI changes
  2. Runs poliage run locally
  3. Pushes code and opens PR
  4. CI runs poliage publish
  5. Poliage comments on PR with visual changes summary

Review

  1. Team member clicks link in PR comment
  2. Reviews visual changes in dashboard
  3. Approves or rejects changes
  4. CDN URLs update immediately

Strict Governance (Optional)

For teams that require approval before merging:

  1. Go to GitHub Settings > Branches
  2. Edit your branch protection rule
  3. Enable "Require status checks"
  4. Add poliage/visual-check as required

This ensures no PR can merge with pending visual reviews.