Get status of the check-runs for a Git reference

Get-status-of-the-check-runs-for-Git-reference.md

1. Get HEAD reference of main branch

gh api repos/hidakatsuya/shopping_list/branches/main

{
  "name": "main",
  "commit": {
    "sha": "fbc7644c880c0517504e6de6be96e4c3b5c3dda4",
  ...
...

References

• https://docs.github.com/ja/rest/branches/branches?apiVersion=2022-11-28#get-a-branch

2. Get status of the job

gh api repos/hidakatsuya/shopping_list/commits/fbc7644c880c0517504e6de6be96e4c3b5c3dda4/check-runs

{
  "total_count": 1,
  "check_runs": [
    {
      "id": 123,
      "name": "Test",
      (snip)
      "status": "completed",
      "conclusion": "success",
      "started_at": "2022-12-15T11:44:49Z",
      "completed_at": "2022-12-15T11:46:30Z",
  ...

$ gh api repos/hidakatsuya/shopping_list/commits/fbc7644c880c0517504e6de6be96e4c3b5c3dda4/check-runs | jq ".check_runs[0].status"
"completed"

References

• https://docs.github.com/en/rest/checks/runs?apiVersion=2022-11-28#list-check-runs-for-a-git-reference
• https://docs.github.com/ja/rest/checks/suites?apiVersion=2022-11-28#get-a-check-suite