louisbrunner/GitHub Checks
Wrapper around the GitHub Checks API
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| github_api_url | the base GitHub API URL (for GitHub Enterprise, e.g. https://github.example.com/api/v3) | no | — |
| repo | the target `owner/repo` to manage the check run on (defaults to the current repository) | no | — |
| sha | the target commit's SHA (defaults to the current commit) | no | — |
| token | your GITHUB_TOKEN | yes | — |
| name | the name of the check to create (incompatible with `check_id`) | no | — |
| check_id | ID of the check to update (incompatible with `name`) | no | — |
| conclusion | the conclusion of your check | no | — |
| status | the status of your check | no | completed |
| action_url | the url to call back to when using `action_required` as conclusion or with `actions` | no | — |
| details_url | a URL with more details about your check, will be overridden by `action_url` depending on context | no | — |
| output | the output of your check | no | — |
| output_text_description_file | path to a file containing text which should be set as the `text_description` of `output` | no | — |
| annotations | the annotations of your check | no | — |
| images | the images of your check | no | — |
| actions | the actions of your check | no | — |
Outputs
| name | description |
|---|---|
| check_id | the ID of the created check, useful to update it in another action |