check-run-action

Action to add check runs to gitHub workflows.

🚀 Getting started

Here is a simple example of how to use this action in a job:

jobs:
  minimalist:
    name: Minimalist Example
    runs-on: ubuntu-latest

    permissions:
      contents: read
      checks: write

    steps:
      - name: Add check run
        uses: marcelocarlos/check-run-action@main
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          name: My Check Results
          conclusion: success
          status: completed
          output_title: My Check Results
          output_summary: Summary of my **check results** (*Markdown supported*)
          output_text: Details of my **check results** (*Markdown supported*)

In addition to the basic usage above, you can also make use of more advanced outputs, such as annotations and images. To use those, you need to pass a list in JSON format (see format specification here). Here is an example:

      - name: Add check run with annotations
        uses: marcelocarlos/check-run-action@main
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          name: My Check Results with annotations
          conclusion: success
          status: completed
          output_title: My Check Results with annotations
          output_summary: Summary of my **check results** (*Markdown supported*)
          output_text: Details of my **check results** (*Markdown supported*)
          output_annotations: |
            [
              { "path":"README.md", "annotation_level":"warning", "title":"Title of my warning check", "message":"Message abc.", "start_line":1,"end_line":2 },
              { "path":"README.md", "annotation_level":"failure", "title":"Title of failure check", "message":"Message xyz.", "start_line":3,"end_line":5 },
              { "path":"README.md", "annotation_level":"notice", "title":"Title of notice check", "message":"Message notice test.", "start_line":16,"end_line":18, "raw_details":"Raw notice details here" }
            ]
          output_images: |
            [
              { "alt":"My image", "caption":"Image description", "image_url": "https://fastly.picsum.photos/id/43/200/200.jpg?hmac=gMoEYpdjrHoRnKoyIdtTknuqyCQDTC8exwLaKHpMv6E" }
            ]

You can also use multiple steps to update the status of the check:

      - name: Queue check run multi-step
        id: queued
        uses: marcelocarlos/check-run-action@main
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          name: My Check Results multi-step
          conclusion: success
          status: queued
          output_title: My Check queued
          output_summary: '*queued*'

      - name: Wait for in_progress
        run: sleep 15

      - name: In progress check run multi-step
        uses: marcelocarlos/check-run-action@main
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          name: My Check Results multi-step
          check_run_id: ${{ steps.queued.outputs.check_run_id }}
          conclusion: success
          status: in_progress
          output_title: My Check in_progress multi-step
          output_summary: '*in_progress*'

      - name: Wait for completed
        run: sleep 15

      - name: In progress check run multi-step
        uses: marcelocarlos/check-run-action@main
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          name: My Check Results multi-step
          check_run_id: ${{ steps.queued.outputs.check_run_id }}
          conclusion: success
          status: completed
          output_title: My Check completed
          output_summary: '*completed*'
          output_text: Details of my **check results** (*Markdown supported*)

🧑‍💻 Making changes to this action

When making changes to this action, run npm install followed by npm run build to recompile the distribution files before pushing the changes.