How to query commit status using REST API?

[Artalus]

Select Topic Area

Question

Body

I have created a trivial Github Actions workflow:

name: CI
on:
  push:
    branches: [ "main", "stage" ]
  pull_request:
    branches: [ "main" ]
  workflow_dispatch:
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - run: echo Hello, world!

I have committed it, and it successfully passed on said commit:

I have also triggered the workflow manually and ensured that this case works too.

Now, I am trying to get the summary status of said commit using REST API in Python, but cannot understand how to achieve that.

• If I try to use /repos/{owner}/{repo}/commits/{ref}/statuses, it simply returns an empty array.
• If I use /repos/{owner}/{repo}/commits/{ref}/status (singular status, not statusES), it surprisingly returns an object with these fields:

 'state': 'pending',
 'statuses': [],
 'total_count': 0,

, which is totally untrue - as we can see from screenshot, the checks have finished.

• If, however, I use /repos/{owner}/{repo}/commits/{ref}/check-suites or /repos/{owner}/{repo}/commits/{ref}/check-runs, they return multiple results:

 'conclusion': 'success',
 'created_at': '2023-05-07T13:08:41Z',
 'head_branch': 'main',
                 'id': '49799e3d8a00fae6d9895b927dce953cca5597b4',
                 'message': 'Create blank.yml',
 'id': 12729264080,
...
 'conclusion': 'success',
 'created_at': '2023-05-07T13:11:13Z',
 'head_branch': 'main',
                 'id': '49799e3d8a00fae6d9895b927dce953cca5597b4',
                 'message': 'Create blank.yml',
 'id': 12729264131,
...
 'conclusion': 'success',
 'created_at': '2023-05-14T11:33:22Z',
 'head_branch': 'main',
                 'id': '49799e3d8a00fae6d9895b927dce953cca5597b4',
                 'message': 'Create blank.yml',

, with additional entries for workflow runs triggered manually on that commit.

Looking at this SO question, I am not tne only one who can't wrap their hand around /status and /statuses endpoitns.

Why doesn't it work? Is there any robust way to query commit whether it's "green" or "red", regardless of what exactly was used to "color" it - GHA or third-party CI system like Circle or Jenkins?

[github-actions[bot]]

🕒 Discussion Activity Reminder 🕒

This Discussion has been labeled as dormant by an automated system for having no activity in the last 60 days. Please consider one the following actions:

1️⃣ Close as Out of Date: If the topic is no longer relevant, close the Discussion as out of date at the bottom of the page.

2️⃣ Provide More Information: Share additional details or context — or let the community know if you've found a solution on your own.

3️⃣ Mark a Reply as Answer: If your question has been answered by a reply, mark the most helpful reply as the solution.

Note: This dormant notification will only apply to Discussions with the Question label. To learn more, see our recent announcement.

Thank you for helping bring this Discussion to a resolution! 💬

[Artalus]

(wonder if replying to this would remove the "inactive" label...)