Overview
Most teams adopt Vibgrate in two steps:
- One-off scan to establish a baseline and identify immediate priorities
- CI integration to continuously detect drift regression on every PR/build
| Mode | Benefits | Typical Command |
|---|---|---|
| One-off scan | Fast snapshot of current upgrade debt | npx @vibgrate/cli scan . |
| CI-integrated | Continuous governance with failure thresholds | npx @vibgrate/cli scan . --format sarif --fail-on error |
Step 1: Establish a Baseline
# Run on your main branch
npx @vibgrate/cli baseline .
git add .vibgrate/baseline.json
git commit -m 'chore: initial drift baseline'
Step 2: Choose Your CI Platform
name: Vibgrate
on: [pull_request, push]
jobs:
drift:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 22
- run: npx @vibgrate/cli scan . --baseline .vibgrate/baseline.json --drift-budget 40 --fail-on errorGeneric (any CI)
npx @vibgrate/cli scan . --baseline .vibgrate/baseline.json --drift-budget 40 --fail-on error
Step 3: Optional Dashboard Push
Add a DSN secret to your CI environment and push results:
- run: npx @vibgrate/cli push --strict
env:
VIBGRATE_DSN: ${{ secrets.VIBGRATE_DSN }}What Happens Next
- PRs that introduce drift beyond your budget will fail the check
- The dashboard (if enabled) shows historical trends
- Refresh your baseline periodically after planned upgrade sprints