feat(workflow run): retrieve workflow dispatch run details by babakks · Pull Request #12695 · cli/cli

babakks · 2026-02-16T13:00:45Z

This PR adds a new feature detection method, ActionsFeatures that checks the API server's support for returning dispatched workflow run details.

Since it's a temporary situation, I've added // TODO workflowDispatchRunDetailsCleanup markers. They indicate the places (including test cases) that we should remove once the workflow run details are retrievable from supported host versions.

Also, those test cases that has nothing to do with the feature detection phase (e.g. checking for wrong inputs), are now set up with an enabled mock since that would be the default/common scenario, and this way we don't need to change them during the future cleanup.

Verification

In the screenshot, the first invocation is non-interactive and the second is interactive.

1. With run details on `github.com`

This will soon be the default behaviour for all github.com repos:

Before this, gh would only exit with zero (see below images), but now we print out the created workflow run URL. This is backward compatible (since users would only rely on the exit code as that was the only indicator), and consistent with pr create or issue create experience.

2. Without run details on `github.com`

This is what users see if they run the updated gh workflow run now (i.e. the new API changes not published), and it's how the experience originally was.

In this case, although the return_run_details field is set in the request (because the host is github.com), but the API server has ignored it and didn't return the run details. Here, gh works fine because regardless of the request fields, it'll still able to handle bot 200 or 204 responses.

3. Without run details on GHES `v3.19` (i.e. <= `v3.20`)

This is what GHES users see, as GHES does not support the new API changes. This is unchanged, too.

In this case, due feature detection results, gh don't even set the return_run_details field.

…tch features Signed-off-by: Babak K. Shandiz <babakks@github.com>

Signed-off-by: Babak K. Shandiz <babakks@github.com>

Copilot

Pull request overview

Adds feature detection and conditional behavior to gh workflow run so it can request and output workflow dispatch run details (URL/ID) on hosts that support it, while remaining compatible with older GHES versions that still return 204 No Content.

Changes:

Introduces ActionsFeatures feature detection to determine support for return_run_details on workflow dispatches.
Updates workflow run to include return_run_details: true when supported and to handle 200 responses with run details (printing URL/ID appropriately).
Expands/adjusts tests to cover both legacy (204) and new (200 + body) dispatch behaviors.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
pkg/cmd/workflow/run/run.go	Adds detector plumbing, conditionally requests run details, and prints run URL/ID when returned.
pkg/cmd/workflow/run/run_test.go	Adds stub variants and test cases for both `204` and `200` dispatch responses; updates expected output.
internal/featuredetection/feature_detection.go	Adds `ActionsFeatures` and enterprise version gating for dispatch run details support.
internal/featuredetection/feature_detection_test.go	Adds unit tests for `ActionsFeatures` across github.com, ghe.com, and GHES versions.
internal/featuredetection/detector_mock.go	Extends detector mocks to implement `ActionsFeatures`.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

internal/featuredetection/feature_detection.go

internal/featuredetection/feature_detection_test.go

Signed-off-by: Babak K. Shandiz <babakks@github.com>

pkg/cmd/workflow/run/run.go

Signed-off-by: Babak K. Shandiz <babakks@github.com>

…nges Signed-off-by: Babak K. Shandiz <babakks@github.com>

Co-authored-by: Kynan Ware <47394200+BagToad@users.noreply.github.com>

internal/featuredetection/feature_detection.go

pkg/cmd/workflow/run/run.go

williammartin · 2026-02-17T11:36:06Z

internal/featuredetection/feature_detection.go

+			return ActionsFeatures{}, err
+		}
+
+		hostVersion, err := resolveEnterpriseVersion(d.httpClient, d.host)


Food For Thought

Out of scope for this but it feels like something we should be caching for a reasonable amount of time.

The HTTP client comes from the caller (e.g. the command) and we usually make them 24h-cached.

Oh, right, yeah I forgot about all these things everywhere:

cachedClient := api.NewCachedHTTPClient(httpClient, time.Hour*24)

I wonder if this should just be baked into the feature detector. It's also idempotent.

Signed-off-by: Babak K. Shandiz <babakks@github.com>

…pefully) upgrade with cli/cli#12695

This MR contains the following updates: | Package | Update | Change | |---|---|---| | [cli/cli](https://github.com/cli/cli) | minor | `v2.86.0` → `v2.87.3` | MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot). **Proposed changes to behavior should be submitted there as MRs.** --- ### Release Notes <details> <summary>cli/cli (cli/cli)</summary> ### [`v2.87.3`](https://github.com/cli/cli/releases/tag/v2.87.3): GitHub CLI 2.87.3 [Compare Source](cli/cli@v2.87.2...v2.87.3) #### What's Changed - Fix project mutation query variable usage by [@williammartin](https://github.com/williammartin) in [#12757](cli/cli#12757) **Full Changelog**: <cli/cli@v2.87.2...v2.87.3> ### [`v2.87.2`](https://github.com/cli/cli/releases/tag/v2.87.2): GitHub CLI 2.87.2 [Compare Source](cli/cli@v2.87.1...v2.87.2) #### ℹ️ Note This release was cut primarily to resolve a publishing issue. We recommend reviewing [the v2.87.1 release notes](https://github.com/cli/cli/releases/tag/v2.87.1) for the complete set of latest features and fixes. #### What's Changed - chore(deps): bump golang.org/x/crypto from 0.47.0 to 0.48.0 by [@dependabot](https://github.com/dependabot)\[bot] in [#12659](cli/cli#12659) **Full Changelog**: <cli/cli@v2.87.1...v2.87.2> ### [`v2.87.1`](https://github.com/cli/cli/releases/tag/v2.87.1): GitHub CLI 2.87.1 [Compare Source](cli/cli@v2.87.0...v2.87.1) #### ⚠️ Incomplete Release The v2.87.1 release experienced a failure in our workflow and is not fully published to the designated package managers/repositories. This is resolved in [v2.87.2](https://github.com/cli/cli/releases/tag/v2.87.2), so we recommend using that release instead. #### What's Changed - Remove license bundling debris by [@williammartin](https://github.com/williammartin) in [#12716](cli/cli#12716) - fix(agent-task/capi): use a fixed CAPI API version by [@babakks](https://github.com/babakks) in [#12731](cli/cli#12731) **Full Changelog**: <cli/cli@v2.87.0...v2.87.1> ### [`v2.87.0`](https://github.com/cli/cli/releases/tag/v2.87.0): GitHub CLI 2.87.0 [Compare Source](cli/cli@v2.86.0...v2.87.0) #### `gh workflow run` immediately returns workflow run URL One of our most requested features - with the latest changes in GitHub API, `gh workflow run` will immediately print the created workflow run URL. #### Improved `gh auth login` experience in VM/WSL environments We have observed rare cases of time drift between the wall and monotonic clocks, mostly in WSL or VM environments, causing failures during polling for the OAuth token. This new release implements measures to account for such situations. If you continue to experience `gh auth login` issues in WSL, please comment in [#9370](cli/cli#9370) ####

Request Copilot Code Review from `gh` + performance improvements `gh pr edit` now supports [Copilot Code Review](https://docs.github.com/en/copilot/using-github-copilot/code-review/using-copilot-code-review) as a reviewer. You can request a review from Copilot using the `--add-reviewer @copilot` flag or interactively by selecting reviewers in the prompts. This release also introduces a new search experience for selecting reviewers and assignees in `gh pr edit`. Instead of loading all collaborators and teams upfront, results are now fetched based on inputs to a new search option. Initial options are suggestions based on those involved with the pull request already. ``` ? Reviewers [Use arrows to move, space to select, <right> to all, <left> to none, type to filter] [ ] Search (7472 more) [x] BagToad (Kynan Ware) > [x] Copilot (AI) ``` This experience will follow in `gh pr create` and `gh issue` for assignees in a later release. #### What's Changed ##### ✨ Features - Bundle licenses at release time by [@williammartin](https://github.com/williammartin) in [#12625](cli/cli#12625) - Add `--query` flag to `project item-list` by [@williammartin](https://github.com/williammartin) in [#12696](cli/cli#12696) - feat(workflow run): retrieve workflow dispatch run details by [@babakks](https://github.com/babakks) in [#12695](cli/cli#12695) - Pin REST API version to 2022-11-28 by [@williammartin](https://github.com/williammartin) in [#12680](cli/cli#12680) - Respect `--exit-status` with `--log` and `--log-failed` in `run view` by [@williammartin](https://github.com/williammartin) in [#12679](cli/cli#12679) - Fork with default branch only during pr create by [@williammartin](https://github.com/williammartin) in [#12673](cli/cli#12673) - `gh pr edit`: Add support for Copilot as reviewer with search capability, performance and accessibility improvements by [@BagToad](https://github.com/BagToad) in [#12567](cli/cli#12567) - `gh pr edit`: new interactive prompt for assignee selection, performance and accessibility improvements by [@BagToad](https://github.com/BagToad) in [#12526](cli/cli#12526) ##### 📚 Docs & Chores - Clean up project item-list query addition changes by [@williammartin](https://github.com/williammartin) in [#12714](cli/cli#12714) - `gh release upload`: Clarify `--clobber` flag deletes assets before re-uploading by [@BagToad](https://github.com/BagToad) in [#12711](cli/cli#12711) - Add usage examples to `gh gist edit` command by [@BagToad](https://github.com/BagToad) in [#12710](cli/cli#12710) - Remove feedback issue template by [@BagToad](https://github.com/BagToad) in [#12708](cli/cli#12708) - Migrate issue triage workflows to shared workflows by [@BagToad](https://github.com/BagToad) in [#12677](cli/cli#12677) - Migrate MR triage workflows to shared workflows by [@BagToad](https://github.com/BagToad) in [#12707](cli/cli#12707) - Add missing TODO comments for featuredetection if-statements by [@BagToad](https://github.com/BagToad) in [#12701](cli/cli#12701) - Add manual dispatch to bump-go workflow by [@BagToad](https://github.com/BagToad) in [#12631](cli/cli#12631) - typo: dont to don't by [@cuiweixie](https://github.com/cuiweixie) in [#12554](cli/cli#12554) - Fix fmt.Errorf format argument in ParseFullReference by [@mikelolasagasti](https://github.com/mikelolasagasti) in [#12516](cli/cli#12516) - Lint source.md by [@Sethispr](https://github.com/Sethispr) in [#12521](cli/cli#12521) #####

Dependencies - chore(deps): bump golang.org/x/text from 0.32.0 to 0.33.0 by [@dependabot](https://github.com/dependabot)\[bot] in [#12468](cli/cli#12468) - chore(deps): bump golang.org/x/term from 0.38.0 to 0.39.0 by [@dependabot](https://github.com/dependabot)\[bot] in [#12616](cli/cli#12616) - Bump go to 1.25.7 by [@BagToad](https://github.com/BagToad) in [#12630](cli/cli#12630) - chore(deps): bump golang.org/x/crypto from 0.46.0 to 0.47.0 by [@dependabot](https://github.com/dependabot)\[bot] in [#12629](cli/cli#12629) - chore: bump `cli/oauth` to `v1.2.2` by [@babakks](https://github.com/babakks) in [#12573](cli/cli#12573) - update Go to 1.25.6 by [@BagToad](https://github.com/BagToad) in [#12580](cli/cli#12580) - chore(deps): bump actions/attest-build-provenance from 3.1.0 to 3.2.0 by [@dependabot](https://github.com/dependabot)\[bot] in [#12558](cli/cli#12558) - chore(deps): bump github.com/sigstore/rekor from 1.4.3 to 1.5.0 by [@dependabot](https://github.com/dependabot)\[bot] in [#12524](cli/cli#12524) - chore(deps): bump github.com/theupdateframework/go-tuf/v2 from 2.3.1 to 2.4.1 by [@dependabot](https://github.com/dependabot)\[bot] in [#12555](cli/cli#12555) - chore(deps): bump github.com/gdamore/tcell/v2 from 2.13.4 to 2.13.7 by [@dependabot](https://github.com/dependabot)\[bot] in [#12469](cli/cli#12469) - chore(deps): bump github.com/sigstore/sigstore from 1.10.0 to 1.10.4 by [@dependabot](https://github.com/dependabot)\[bot] in [#12525](cli/cli#12525) - chore(deps): bump github.com/theupdateframework/go-tuf/v2 from 2.3.0 to 2.3.1 by [@dependabot](https://github.com/dependabot)\[bot] in [#12515](cli/cli#12515) - chore(deps): bump actions/download-artifact from 6 to 7 by [@dependabot](https://github.com/dependabot)\[bot] in [#12314](cli/cli#12314) - chore(deps): bump actions/upload-artifact from 5 to 6 by [@dependabot](https://github.com/dependabot)\[bot] in [#12315](cli/cli#12315) - chore(deps): bump goreleaser/goreleaser-action from 6.0.0 to 6.4.0 by [@dependabot](https://github.com/dependabot)\[bot] in [#12354](cli/cli#12354) #### New Contributors - [@Sethispr](https://github.com/Sethispr) made their first contribution in [#12521](cli/cli#12521) - [@cuiweixie](https://github.com/cuiweixie) made their first contribution in [#12554](cli/cli#12554) **Full Changelog**: <cli/cli@v2.86.0...v2.87.0> </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this MR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

babakks added 4 commits February 16, 2026 11:53

fix(featuredetection): add ActionsFeatures to detect workflow dispa…

a0dea00

…tch features Signed-off-by: Babak K. Shandiz <babakks@github.com>

test(featuredetection): add tests for ActionsFeatures

3382547

Signed-off-by: Babak K. Shandiz <babakks@github.com>

feat(workflow run): retrieve workflow run if supported by the API

e73bf11

Signed-off-by: Babak K. Shandiz <babakks@github.com>

test(workflow run): verify retrieval of workflow run details

bf2ff7c

Signed-off-by: Babak K. Shandiz <babakks@github.com>

Copilot AI review requested due to automatic review settings February 16, 2026 13:00

babakks requested a review from a team as a code owner February 16, 2026 13:00

babakks requested a review from williammartin February 16, 2026 13:00

babakks temporarily deployed to cli-automation February 16, 2026 13:00 — with GitHub Actions Inactive

cliAutomation assigned babakks Feb 16, 2026

Copilot started reviewing on behalf of babakks February 16, 2026 13:01 View session

babakks marked this pull request as draft February 16, 2026 13:02

Copilot AI reviewed Feb 16, 2026

View reviewed changes

internal/featuredetection/feature_detection.go Outdated Show resolved Hide resolved

internal/featuredetection/feature_detection_test.go Show resolved Hide resolved

babakks added 2 commits February 16, 2026 13:06

test(featuredetection): fix test case name

b64dd58

Signed-off-by: Babak K. Shandiz <babakks@github.com>

docs(featuredetection): fix typo in comment

61ab5e0

Signed-off-by: Babak K. Shandiz <babakks@github.com>

babakks changed the title ~~Babakks/retrieve workflow dispatch run~~ feat(workflow run): retrieve workflow dispatch run details Feb 16, 2026

babakks marked this pull request as ready for review February 16, 2026 19:53

babakks temporarily deployed to cli-automation February 16, 2026 19:53 — with GitHub Actions Inactive

BagToad reviewed Feb 16, 2026

View reviewed changes

pkg/cmd/workflow/run/run.go Outdated Show resolved Hide resolved

pkg/cmd/workflow/run/run.go Outdated Show resolved Hide resolved

pkg/cmd/workflow/run/run.go Show resolved Hide resolved

babakks and others added 4 commits February 16, 2026 21:53

refactor(workflow run): remove temp out

3e9fbbb

Signed-off-by: Babak K. Shandiz <babakks@github.com>

fix(workflow run): apply url.PathEscape when compiling URL

36a85fd

Signed-off-by: Babak K. Shandiz <babakks@github.com>

docs(workflow run): add cleanup marker with explanation on future cha…

c47a10e

…nges Signed-off-by: Babak K. Shandiz <babakks@github.com>

docs(workflow run): improve help docs

ce01621

Co-authored-by: Kynan Ware <47394200+BagToad@users.noreply.github.com>

williammartin reviewed Feb 17, 2026

View reviewed changes

babakks added 2 commits February 17, 2026 11:46

refactor(featuredetection): remove temp in favour of early returns

52eca96

Signed-off-by: Babak K. Shandiz <babakks@github.com>

fix(workflow run): bail out on feature detection error

31f3756

Signed-off-by: Babak K. Shandiz <babakks@github.com>

babakks requested review from BagToad and williammartin February 17, 2026 11:49

williammartin approved these changes Feb 17, 2026

View reviewed changes

BagToad approved these changes Feb 17, 2026

View reviewed changes

babakks merged commit 027adc7 into trunk Feb 17, 2026
11 checks passed

babakks deleted the babakks/retrieve-workflow-dispatch-run-id branch February 17, 2026 20:37

joXemMx added a commit to sirius-ms/sirius-client-openAPI that referenced this pull request Feb 18, 2026

2min sleep for now as GitHub just seems to be very slow, can soon (ho…

a5bce0b

…pefully) upgrade with cli/cli#12695

jglick mentioned this pull request Feb 18, 2026

Add option to watch workflow run progress #3559

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(workflow run): retrieve workflow dispatch run details#12695

feat(workflow run): retrieve workflow dispatch run details#12695
babakks merged 12 commits intotrunkfrom
babakks/retrieve-workflow-dispatch-run-id

babakks commented Feb 16, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

williammartin Feb 17, 2026

Uh oh!

babakks Feb 17, 2026

Uh oh!

williammartin Feb 17, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

babakks commented Feb 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Verification

1. With run details on github.com

2. Without run details on github.com

3. Without run details on GHES v3.19 (i.e. <= v3.20)

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

williammartin Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

babakks Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

williammartin Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

babakks commented Feb 16, 2026 •

edited

Loading

1. With run details on `github.com`

2. Without run details on `github.com`

3. Without run details on GHES `v3.19` (i.e. <= `v3.20`)