Skip to main content

Comment Vibgrate Results on Pull Requests

Generate a Markdown drift report in CI and post it as a pull request comment so reviewers see the DriftScore inline. Learn the scan command and the posting pattern.

Vibgrate Docs

Vibgrate Help

This recipe produces a human-readable drift summary in CI and posts it as a pull request comment, putting the DriftScore in front of reviewers without making them open a build log. It is provider-agnostic.

The idea

Vibgrate can emit a Markdown report. CI captures that Markdown and posts it as a comment using your provider's PR comment API or CLI.

Producing the comment body

npx @vibgrate/cli scan --format markdown --out drift-report.md

Post-install:

vg scan --format markdown --out drift-report.md

This writes a Markdown report summarizing findings and the DriftScore, ready to paste into a comment.

Posting the comment

Feed drift-report.md to your provider's comment mechanism. For example, many platforms offer a CLI that posts a comment from a file. The Vibgrate side is only the report generation above; the posting step is provider-specific.

Keeping comments tidy

To avoid a wall of comments, update a single sticky comment per PR rather than adding a new one each run. Most provider tooling supports finding and editing an existing comment by a marker line you include in the Markdown.

Gating alongside the comment

The comment is informational. To also block merges, run a gating scan with --fail-on error or --drift-budget. See Required status checks for drift gates.

Related

  • Output Formats for the Markdown report shape.
  • Run scans on changed files only to keep PR scans fast.

Related Commands