How to get the workflow run ID? #26965
-
|
I would like to send a Telegram message containing the URL of a specific workflow run when it failed. I found how to send Telegram message (via appleboy/telegram-action), found the repository info using ${{ github.repository }} , but I still haven’t found how to get that specific workflow run ID. By ID, I mean the 12345 in https://github.com/foo/bar/actions/12345. How can I get the workflow run ID? |
Beta Was this translation helpful? Give feedback.
Replies: 5 comments · 5 replies
-
|
Do you mean the run id in https://github.com/foo/bar/actions/ runs /12345.? There is a run_id property of github context. You could use ${{ github.run_id }} to get the run ID. |
Beta Was this translation helpful? Give feedback.
-
|
In case you need to extract it from the command line, you can use this script in bash: RUNID=$(gh api repos/$OWNER/$REPO/commits/$COMMIT_SHA/check-runs | jq -r '.check_runs[] | select(.name == "NAME_OF_YOUR_GITHUB_ACTIONS_WORKFLOW") | .html_url | capture("/runs/(?<number>[0-9]+)/jobs") | .number' | sed 's/"//g' | head -n 1)Full explanation on StackOverflow: https://stackoverflow.com/a/76465815/4441211 |
Beta Was this translation helpful? Give feedback.
-
|
I've tried that one-liner to get the run ID of an older commit within https://github.com/godotengine/godot, but I can't get it to work (the variable is empty). This is what I tried:
Running this alone results in a lot of forks appearing in the list, which surprises me: |
Beta Was this translation helpful? Give feedback.
-
|
How we can obtain run id if we dispatch workflow using api in powershell script? |
Beta Was this translation helpful? Give feedback.
-
|
Doesn't this answer your question: https://github.com/orgs/community/discussions/26965#discussioncomment-6164539 |
Beta Was this translation helpful? Give feedback.
-
|
No. A GitHub workflow can be run directly with a dispatch event. In that case, there is no commit to build on. This is an incredibly large oversight, that a workflow system does not return anything about it's run. It's not a useful workflow system if you can't programmatically track the result. As seen in the API docs, a worfklow dispatch only ever returns: You expect any workflow/job/... based API to respond the ID of the thing it created. |
Beta Was this translation helpful? Give feedback.
-
|
totally agree, i would've expected a workflow dispatch to return |
Beta Was this translation helpful? Give feedback.
-
|
It's basic asynchronous API development. You submit a request, you get back the id. Any solution that requires filters on other values is simply a workaround. |
Beta Was this translation helpful? Give feedback.
-
|
A less hacky alternative to the above is to use the API endpoint for listing workflow runs and filtering by associated commit: gh api /repos/$OWNER/$REPO/actions/workflows/$WORKFLOW_FILE_OR_ID/runs \
--method GET -f head_sha=$COMMIT_SHA |
Beta Was this translation helpful? Give feedback.
-
|
List recent workflow runs of the current repository, with the ID present: Filter options are available, here is the manual. |
Beta Was this translation helpful? Give feedback.
@rffontenelle
Do you mean the run id in https://github.com/foo/bar/actions/ runs /12345.?
There is a run_id property of github context. You could use ${{ github.run_id }} to get the run ID.