Setup in 30 Seconds
.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 # or 'warning', 'info', 'none'That's it. Open a PR and watch the magic happen.
What You'll See
🤖
buoy-bot commented just now
## 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 full report](#) | ⚓ Powered by Buoy
Why Teams Love It
One-File Setup
Add one YAML file to your repo. That's it. No server, no dashboard, no signup.
PR Comments
Automatic drift reports posted as comments on every pull request.
Check Status
Pass or fail based on drift severity. Block merges on critical drift.
Diff-Aware
Only reports drift in changed files, not the entire codebase.
Fast Execution
Typically completes in under 30 seconds, even on large codebases.
Free Forever
Open source action. No usage limits, no API keys needed.
Configuration Options
Full configuration example
- uses: buoy-dev/buoy-action@v1
with:
# When to fail the check
fail-on: critical # critical | warning | info | none
# Post a PR comment with results
comment: true
# Compare against this branch
base: main
# Path to buoy config
config: ./buoy.config.mjs
# Only check changed files (faster)
diff-only: true