balvajs/PR Beacon
Posts and updates a sticky PR comment with CI information, warnings, and failures.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| token | GitHub token (GITHUB_TOKEN) used to post PR comments. | yes | — |
| json-file | Path to a JSON file that defines the full beacon payload. Use this when you need multiple rows or markdown sections. Schema: { "fails": [ string | { message, icon?, id? } ], "warnings": [ string | { message, icon?, id? } ], "messages": [ string | { message, icon?, id? } ], "markdowns": [ string | { message, id? } ], "options": { "contentIdsToUpdate"?: string[], "replaceMode"?: "in-place" | "append" } } | no | "" |
| fail | A single failure message to add to the Fails table. | no | "" |
| fail-icon | Icon for the fail entry (e.g. "💥"). Only used when `fail` is set. | no | "" |
| fail-id | ID for the fail entry, used for upsert. Only used when `fail` is set. | no | "" |
| warn | A single warning message to add to the Warnings table. | no | "" |
| warn-icon | Icon for the warn entry. Only used when `warn` is set. | no | "" |
| warn-id | ID for the warn entry, used for upsert. Only used when `warn` is set. | no | "" |
| message | A single message to add to the Messages table. | no | "" |
| message-icon | Icon for the message entry. Only used when `message` is set. | no | "" |
| message-id | ID for the message entry, used for upsert. Only used when `message` is set. | no | "" |
| markdown | A single markdown block to add to the comment. | no | "" |
| markdown-id | ID for the markdown entry, used for upsert. Only used when `markdown` is set. | no | "" |
| content-ids-to-update | Comma-separated list of content IDs that should be removed before new content is added. Useful in subsequent jobs that own specific named sections. | no | "" |
| replace-mode | Controls how updated table rows are positioned relative to existing rows. 'in-place' (default): rows replace at the position of the first old row with the same ID. 'append': old rows are removed and new rows are appended at the end of the table. | no | "" |
| fail-on-fail-message | If true, the action will fail (exit with non-zero code) if there is a fail message in the beacon. | no | false |
Outputs
no outputs