PR Comments
Dev Herald posts automated, structured comments on GitHub pull requests from your CI pipeline. Instead of digging through workflow logs, reviewers see the signals that matter — right in the PR thread.
How it works
- Your CI workflow runs (tests, deploy, dependency scan, etc.)
- A step calls the
dev-herald/commentGitHub Action - Dev Herald formats the data and posts (or updates) a comment on the PR
All formatting happens in your CI environment. Dev Herald receives only the structured data you explicitly send — never your source code. See Data & Privacy for details.
Three ways to comment
| Approach | Best for | Docs |
|---|---|---|
| Signals | Built-in handlers that parse CI output for you | Use cases |
| Templates | Structured formats with schema validation | Templates |
| Markdown | Freeform messages with full control | Custom PR Comments |
Sticky comments
By default, every CI run creates a new comment. Add a sticky-id to update the same comment in place on every push — keeping your PR thread clean.
Use cases
- Vercel Preview Comments — Post preview URLs and deployment status
- Test Results — Surface Vitest and Playwright results
- Dependency Comments — Track package changes and new dependencies
- Bundle Change Comments — Show bundle size diffs in a table
- Custom PR Comments — Post freeform markdown
Getting started
If you haven’t set up Dev Herald yet, start with the Quick Start guide.
Last updated on