includable/Script Comment
Runs a script and posts its output as a sticky PR comment; the exit code decides whether the action passes or fails.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| script | Bash script to run. Its stdout becomes the PR comment body (markdown); a non-zero exit code fails the action. | yes | — |
| token | GitHub token with `pull-requests: write` permission. | no | ${{ github.token }} |
| comment-id | Identifier for the sticky comment, so multiple instances of this action can keep separate comments. | no | script-comment |
| comment-header | Optional heading shown at the top of the PR comment. | no | "" |
| working-directory | Directory to run the script in. | no | "" |
Outputs
| name | description |
|---|---|
| exit-code | Exit code of the script. |