commit | 9f02872da71b6f558c6a6f190f925dde5e4d8798 | [log] [tgz] |
---|---|---|
author | MichaĆ Sawicz <michal@sawicz.net> | Mon Sep 28 16:21:00 2020 +0200 |
committer | GitHub <noreply@github.com> | Mon Sep 28 15:21:00 2020 +0100 |
tree | 298fa75a963ad097f5c222f77266fa0a9375d06b | |
parent | 88ce8c595fcf9e7e3829dca9b6b59a972a98133e [diff] |
Add remote repository support (Fixes #9) (#10) * Add logging of owner/repo and SHA * Add support for `repo` and `sha` inputs (Fixes #9) * Add missing comment. * Revert to defaults being assigned on declaration * Add missing `required: false` To keep consistent, even if it's the default: https://docs.github.com/en/free-pro-team@latest/actions/creating-actions/metadata-syntax-for-github-actions#inputsinput_idrequired * Add check for invalid `repo` format
checks-action
This GitHub Action allows you to create Check Runs directly from your GitHub Action workflow. While each job of a workflow already creates a Check Run, this Action allows to include annotations
, images
, actions
or any other parameters supported by the Check Runs API.
The following shows how to publish a Check Run which will have the same status as your job and contains the output of another action. This will be shown predominantly in a Pull Request or on the workflow run.
name: "build-test" on: [push] jobs: test_something: runs-on: ubuntu-latest steps: - uses: actions/checkout@v1 - uses: actions/create-outputs@v0.0.0-fake id: test - uses: LouisBrunner/checks-action@v0.1.0 if: always() with: token: ${{ secrets.GITHUB_TOKEN }} name: Test XYZ conclusion: ${{ job.status }} output: | {"summary":${{ steps.test.outputs.summary }}}
See the examples workflow for more details and examples (and see the associated runs to see how it will look like).
repo
Optional The target repository (owner/repo
) on which to manage the check run. Defaults to the current repository.
sha
Optional The SHA of the target commit. Defaults to the current commit.
token
Required Your GITHUB_TOKEN
name
Required for creation, the name of the check to create (mutually exclusive with check_id
)
check_id
Required for update, ID of the check to update (mutually exclusive with name
)
conclusion
Optional (Required if status
is completed
, the default) The conclusion of your check, can be either success
, failure
, neutral
, cancelled
, timed_out
or action_required
status
Optional The status of your check, defaults to completed
, can be either queued
, in_progress
, completed
action_url
Optional The URL to call back to when using action_required
as a conclusion
of your check or when including actions
See Check Runs API (action_required
) or Check Runs API (actions
) for more information
Note that this will override details_url
(see next) when conclusion
is action_required
or when actions
is provided (the two inputs set the same check attribute, details_url
)
details_url
Optional A URL with more details about your check, can be an third-party website, a preview of the changes to your Github Pages, etc
Note that this will be overridden by action_url
(see previous) when conclusion
is action_required
or when actions
is provided (the two inputs set the same check attribute, details_url
)
output
Optional A JSON object (as a string) containing the output of your check, required when using annotations
or images
.
Supports the following properties:
summary
: Required, summary of your checktext_description
: Optional, a text description of your annotation (if any)See Check Runs API for more information
annotations
Optional A JSON array (as a string) containing the annotations of your check, requires output
to be included.
Supports the same properties with the same types and names as the Check Runs API
images
Optional A JSON array (as a string) containing the images of your check, requires output
to be included.
Supports the same properties with the same types and names as the Check Runs API
actions
Optional A JSON array (as a string) containing the actions of your check.
Supports the same properties with the same types and names as the Check Runs API
Note that this will override details_url
as it relies on action_url
(the two inputs set the same check attribute, details_url
)
check_id
The ID of the created check, useful to update it in another action (e.g. non-completed
status
)