jedischools/Update/Create a Rich Check
Rich checks from GitHub Mastery Book
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
- Runtime
- Deprecated runtime
Inputs
| name | description | required | default |
|---|---|---|---|
| name | The name of the check | yes | — |
| status | The status of the check `queued`, `in_progress` or `completed` | yes | — |
| title | The title to put on the check panel | yes | — |
| summary | The summary of the check runs current result | yes | — |
| details | The details for the check | no | — |
| conclusion | The conclusion of the check as a value of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, and `timed_out` | no | — |
| check-run-id | If set, this check run will be updated with the conclusion and details provided | no | — |
| github-token | Github token used by the api requests for the repository (automatically created by Github) | no | ${{ github.token }} |
| annotations | the annotations of your check(JSON Object) | no | — |
| images | add images to your check(JSON Object) | no | — |
| fail-on-error | step will fail if specified `conclusion` is not `success` or `neutral` | no | — |
| fail-on-neutral | step will fail if specified `conclusion` is `neutral` | no | — |
Outputs
| name | description |
|---|---|
| check-run-id | contains the check run id of the check created or updated |