dev-herald/PR Comments - Dev Herald
Post automated PR comments with sticky updates and pre-built templates for deployments, tests, and more. By Dev Herald
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Activelast commit Jul 7, 2026
- License
- None
Pinned Snippet
uses: dev-herald/comment@117655fc25da739560300418bd91732035b15a77 # v1.5.0tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| api-key | Dev Herald API key for authentication (required) | yes | — |
| pr-number | Pull request number to comment on (required, e.g., 123) | yes | — |
| comment | Markdown comment text (for simple comments). Use this OR template, not both. Example: "## Build Complete\n✅ All checks passed!" | no | — |
| template | Template type for rich comments (use with template-data). Options: DEPLOYMENT, MIGRATION, CUSTOM_TABLE | no | — |
| template-data | JSON string with template-specific data (required when using template, unless result-location is provided). See README for schema examples. | no | — |
| test-results | YAML list of named test result files. When provided with signal: TEST_RESULTS, the action reads and parses these files automatically — no template-data needed. Each entry requires a display name and a path to a JSON reporter output file. Optional per entry: link or url (HTTPS) — used as the suite name link in the table. Supported formats: Playwright JSON reporter, Vitest JSON reporter. Example (use workflow expressions for link in your workflow YAML, not here): test-results: | - name: Unit Tests path: vitest-results/unit.json link: https://github.com/owner/repo/actions/runs/12345678 - name: E2E Tests path: playwright-results/results.json | no | — |
| signal | Signal type to run. Supported: DEPENDENCY_DIFF, TEST_RESULTS, NEW_DEPENDENCY, BUNDLE_ANALYSIS. When set, the action computes the signal output and posts it automatically — no template or template-data required. Cannot be used together with "template". | no | — |
| bundle-report-path | Path to PR bundle analysis JSON directory (required for BUNDLE_ANALYSIS). Example: .next/analyze/ | no | — |
| bundle-baseline-path | Path to baseline bundle JSON directory after download (required for BUNDLE_ANALYSIS). Example: baseline/ | no | — |
| bundle-baseline-branch | Target branch name for "baseline missing" log message (BUNDLE_ANALYSIS only). Default: main | no | — |
| max-changes | Maximum bundle diff rows to show (BUNDLE_ANALYSIS only). Default: 25 | no | — |
| show-gzip | Include gzip size delta in bundle diff (BUNDLE_ANALYSIS only). Default: false | no | — |
| include | Comma-separated list of dependency fields to scan for DEPENDENCY_DIFF. Default: dependencies,devDependencies,optionalDependencies (only used when signal is set) | no | — |
| enable-cve | Set to "true" to query the OSV database for CVE counts per dependency version (DEPENDENCY_DIFF only). Default: false (only used when signal is set) | no | — |
| max-deps | Maximum number of dependency changes to show in the DEPENDENCY_DIFF table. Default: 25 (only used when signal is set) | no | — |
| sticky-id | Optional identifier for updateable comments. Comments with the same sticky-id will update instead of creating new ones. Example: "deployment-status" | no | — |
| api-url | Dev Herald API base URL (optional, defaults to production URL) | no | https://dev-herald.com/api/v1/github |
Outputs
| name | description |
|---|---|
| comment-id | Internal Dev Herald comment ID |
| github-comment-id | GitHub comment ID |
| github-comment-url | Direct URL to the GitHub comment |
| status | Status of the comment (e.g., pending, posted) |
| response | Full JSON response from the API |