Skip to content
GitHub Action which wraps calls to GitHub Checks API
TypeScript JavaScript
Use this GitHub Action with your project

Add this Action to an existing workflow or create a new one.

View on Marketplace
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/workflows
__tests__
dist
src
.eslintignore
.eslintrc.json
.gitignore
.prettierignore
.prettierrc.json
LICENSE
README.md
action.yml
jest.config.js
package-lock.json
package.json
tsconfig.eslint.json
tsconfig.json

README.md

GitHub Actions: checks-action build-test

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.

Usage

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 }}
        output:
          summary: ${{ steps.test.outputs.summary }}
          text_description: ${{ steps.test.outputs.description }}

See the examples workflow for more details and examples (and see the associated runs to see how it will look like).

Inputs

token

Required Your GITHUB_TOKEN

name

Required The name of your check

conclusion

Required 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

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 check
  • text_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

Issues

  • Action Required conclusion: button doesn't work
  • Action elements: button doesn't work
  • Non-completed status: too many arguments required
You can’t perform that action at this time.