This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Create Check | |
| # To trigger the check | |
| on: | |
| pull_request: | |
| branches: [ "main" ] | |
| jobs: | |
| start-check: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| checks: write # Permission to create a Check Run | |
| contents: write # Permission to write a repository_dispatch requests | |
| steps: | |
| - name: Create Check | |
| id: checkrun # An ID to allow the step to be referenced | |
| env: | |
| GH_TOKEN: ${{ github.token }} # Expose the token for GH CLI | |
| run: | | |
| ########################################################## | |
| # Create a Check Run and indicate that it is being queued | |
| # Use --jq to return the ID | |
| ########################################################## | |
| CHECKID=$(gh api -X POST -H "Accept: application/vnd.github+json" \ | |
| -H "X-GitHub-Api-Version: 2022-11-28" \ | |
| -f name='Super Check' \ | |
| -f head_sha='${{ github.event.pull_request.head.sha }}' \ | |
| -f status='queued' \ | |
| -f 'output[title]=My Check Run Title' \ | |
| -f 'output[summary]=A *fancy* summary' \ | |
| -f 'output[text]=More detailed Markdown **text**' \ | |
| --jq '.id' \ | |
| /repos/${{ github.repository }}/check-runs) | |
| #################################################### | |
| # Put the ID into a step variable | |
| #################################################### | |
| echo "checkId=$CHECKID" >> $GITHUB_OUTPUT | |
| - name: Repository Dispatch | |
| env: | |
| GH_TOKEN: ${{ github.token }} | |
| run: | | |
| ########################################################## | |
| # Create a repository_dispatch event of type my-check | |
| # Send the SHA and the Check Run ID in the client_payload | |
| ########################################################## | |
| gh api -X POST -H "Accept: application/vnd.github+json" \ | |
| -H "X-GitHub-Api-Version: 2022-11-28" \ | |
| -f 'event_type=my-check' \ | |
| -f 'client_payload[checkRunId]=${{ steps.checkrun.outputs.checkId }}' \ | |
| -f 'client_payload[sha]=${{ github.sha }}' \ | |
| /repos/${{ github.repository }}/dispatches |