[BUG?] the REST API that get workflow run returns wrong pull request info #24674

Laurenfrost · 2021-12-16T12:18:18Z

Laurenfrost
Dec 16, 2021

Apologize for adding that question mark. Actually I’m not really sure if it a bug, but when I tried to get the pull request info which triggered the workflow run, I found a different pull request.

In my repo Laurenfrost/ActionsTest, I closed the pull_request number 5, and that trigger a workflow run https://github.com/Laurenfrost/ActionsTest/actions/runs/1578145440.

However, when I GET the workflow run info with https://api.github.com/repos/Laurenfrost/ActionsTest/actions/runs/1578145440, the pull_requests showed it is number 6. That confused me a lot.

Does anyone know how does it happen?

{
  "id": 1578145440,
  "name": "Show Trigger Events",
  "node_id": "WFR_kwLOErVgq85eEJag",
  "head_branch": "next",
  "head_sha": "09e5238cadb749785f29da4c562857a90ac55dce",
  "run_number": 32,
  "event": "pull_request",
  "status": "completed",
  "conclusion": "success",
  "workflow_id": 16281477,
  "check_suite_id": 4652771218,
  "check_suite_node_id": "CS_kwDOErVgq88AAAABFVOnkg",
  "url": "https://api.github.com/repos/Laurenfrost/ActionsTest/actions/runs/1578145440",
  "html_url": "https://github.com/Laurenfrost/ActionsTest/actions/runs/1578145440",
  "pull_requests": [
    {
      "url": "https://api.github.com/repos/Laurenfrost/ActionsTest/pulls/6",
      "id": 804305832,
      "number": 6,
      "head": {
        "ref": "next",
        "sha": "64a34d649db20f60693909135135b3291f638f5b",
        "repo": {
          "id": 313876651,
          "url": "https://api.github.com/repos/Laurenfrost/ActionsTest",
          "name": "ActionsTest"
        }
      },
      "base": {
        "ref": "new",
        "sha": "462e752da3c5c29945b40cce9583875397565045",
        "repo": {
          "id": 313876651,
          "url": "https://api.github.com/repos/Laurenfrost/ActionsTest",
          "name": "ActionsTest"
        }
      }
    }
  ],
  "created_at": "2021-12-14T13:53:34Z",
  "updated_at": "2021-12-14T13:53:48Z",
  "run_attempt": 1,
  "run_started_at": "2021-12-14T13:53:34Z",
  "jobs_url": "https://api.github.com/repos/Laurenfrost/ActionsTest/actions/runs/1578145440/jobs",
  "logs_url": "https://api.github.com/repos/Laurenfrost/ActionsTest/actions/runs/1578145440/logs",
  "check_suite_url": "https://api.github.com/repos/Laurenfrost/ActionsTest/check-suites/4652771218",
  "artifacts_url": "https://api.github.com/repos/Laurenfrost/ActionsTest/actions/runs/1578145440/artifacts",
  "cancel_url": "https://api.github.com/repos/Laurenfrost/ActionsTest/actions/runs/1578145440/cancel",
  "rerun_url": "https://api.github.com/repos/Laurenfrost/ActionsTest/actions/runs/1578145440/rerun",
  "previous_attempt_url": null,
  "workflow_url": "https://api.github.com/repos/Laurenfrost/ActionsTest/actions/workflows/16281477",
  "head_commit": {
    "id": "09e5238cadb749785f29da4c562857a90ac55dce",
    "tree_id": "7f8ed692c1fb874e98ae16d6311279636c57d6aa",
    "message": "Delete TEST-com.bmwcarit.barefoot.analysis.DBCANTest.xml",
    "timestamp": "2021-12-14T13:37:17Z",
    "author": {
      "name": "Linwei Ye",
      "email": "bellfahle@outlook.com"
    },
    "committer": {
      "name": "GitHub",
      "email": "noreply@github.com"
    }
  }
...
}

Answered by jsoref

Dec 17, 2021

I’m pretty sure pull_requests is the list of open pull requests, it’s provided for convenience and not particularly related to the event.

View full answer

jsoref · 2021-12-17T02:33:59Z

jsoref
Dec 17, 2021

I’m pretty sure pull_requests is the list of open pull requests, it’s provided for convenience and not particularly related to the event.

0 replies

Laurenfrost · 2021-12-17T02:42:42Z

Laurenfrost
Dec 17, 2021
Author

Thank you! That makes sense.

It seems the document not mention the usage of pull_requests in the response. Could you please tell me where shoud I go to know about that.

0 replies

jsoref · 2021-12-17T02:54:17Z

jsoref
Dec 17, 2021

The “documentation” is here:

  <a href="https://docs.github.com/en/rest/reference/actions#get-a-workflow-run" target="_blank" rel="noopener nofollow ugc">GitHub Docs</a>

Actions - GitHub Docs

If you’re up for it, you could file a bug:

  <a href="https://github.com/github/docs/issues/" target="_blank" rel="noopener nofollow ugc">GitHub</a>

Issues · github/docs

The open-source repo for docs.github.com. Contribute to github/docs development by creating an account on GitHub.

Personally, I agree that the documentation is inadequate, it has a field, but in the example there are 0 entries, so it isn’t possible to divine what it is. (If it had 3, one a couple before the PR and one after, and one somewhere, that’d make it fairly clear that it isn’t related to the run…)

0 replies

Laurenfrost · 2021-12-17T02:59:46Z

Laurenfrost
Dec 17, 2021
Author

Couldn’t agree more. Maybe I should open an isssue.

Thank you every much!

0 replies

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GitHub Community

[BUG?] the REST API that get workflow run returns wrong pull request info #24674

{{title}}

Replies: 4 comments

{{title}}

{{title}}

{{title}}

{{title}}

Select a reply

GitHub Community

[BUG?] the REST API that get workflow run returns wrong pull request info #24674

Laurenfrost Dec 16, 2021

Replies: 4 comments

jsoref Dec 17, 2021

Laurenfrost Dec 17, 2021 Author

jsoref Dec 17, 2021

Actions - GitHub Docs

Issues · github/docs

Laurenfrost Dec 17, 2021 Author

Laurenfrost
Dec 16, 2021

jsoref
Dec 17, 2021

Laurenfrost
Dec 17, 2021
Author

jsoref
Dec 17, 2021

Laurenfrost
Dec 17, 2021
Author