GitHub Integration for Design Drift

GitHub Integration Features

PR Comments

Automatic drift reports posted as comments on every pull request.

Check Runs

GitHub Check that passes or fails based on drift severity thresholds.

Status Badges

Add drift status badges to your README showing current health.

Multi-Repo

Track drift across multiple repositories from a single dashboard.

Branch Protection

Block merges when critical drift is detected in the PR.

Trend Tracking

See drift trends over time across branches and releases.

Quick Setup

.github/workflows/buoy.yml Copy this file

# .github/workflows/buoy.yml
name: Design Drift Check
on: [pull_request]

jobs:
  drift:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: buoy-dev/buoy-action@v1
        with:
          # Fail on critical drift
          fail-on: critical

          # Post PR comment
          comment: true

          # Compare against main
          base: main

PR Comment Preview

🤖

buoy-bot commented 2 minutes ago

## Buoy Drift Report

| Severity | Count |
|----------|-------|
| 🔴 Critical | 0 |
| 🟡 Warning | 3 |
| 🟢 Info | 7 |

### Warnings
- `Card.tsx:12` Hardcoded color #ffffff
- `Badge.tsx:8` Hardcoded spacing 8px
- `Header.tsx:3` Using deprecated NavHeader

---
📊 View trends over time → (requires Buoy Cloud)

Action Configuration

Inputs

fail-on critical | warning | info | none
comment true | false
base Branch to compare against
config Path to buoy.config.mjs

Outputs

critical-count Number of critical issues
warning-count Number of warnings
info-count Number of info items
report-url Link to full report

GitHub Integration