fix(agent-task/capi): use a fixed CAPI API version by babakks · Pull Request #12731 · cli/cli

babakks · 2026-02-20T18:06:32Z

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

Copilot

Pull request overview

This pull request attempts to fix an issue with API versioning in the CAPI (Copilot API) client by setting a fixed API version header when making requests to the Copilot API. The change modifies the capiTransport.RoundTrip method to set the X-GitHub-Api-Version header to "2026-01-09" when requests are directed to api.githubcopilot.com.

Changes:

Added logic to set X-GitHub-Api-Version header to "2026-01-09" for requests to the Copilot API host

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

Copilot · 2026-02-20T18:09:21Z

pkg/cmd/agent-task/capi/client.go

 	if req.URL.Host == capiHost {
 		req.Header.Add("Copilot-Integration-Id", "copilot-4-cli")
+
+		// This is quick fix to ensure that we are not using GitHub API versions while targeting CAPI.


Missing article 'a' in the comment. The phrase should be "This is a quick fix" rather than "This is quick fix".

Suggested change

// This is quick fix to ensure that we are not using GitHub API versions while targeting CAPI.

// This is a quick fix to ensure that we are not using GitHub API versions while targeting CAPI.

pkg/cmd/agent-task/capi/client.go

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).

The workflow has been reporting failures since Feb 26 when the GitHub Actions runner image updated from gh CLI 2.86.0 to 2.87.3. gh CLI v2.87.0 introduced API version pinning (X-GitHub-Api-Version: 2022-11-28) which broke the Copilot API (CAPI) log streaming endpoint (cli/cli#12729, cli/cli#12730). The fix in cli/cli#12731 corrected the API version for CAPI requests, but the --follow flag still exits non-zero with 'not found' when streaming session logs. Crucially, the agent task itself succeeds — every 'failing' run since Feb 26 actually created a PR: Feb 26 06:20 → #38614 Feb 26 08:18 → #38615 Feb 27 06:16 → #38710 Feb 27 08:17 → #38723 Feb 28 08:09 → #38828 But because of 'set -euo pipefail', the non-zero --follow exit code killed the script before the PR labeling code could run. Fix: tolerate --follow failures with '|| echo warning', allowing the script to continue to extract the PR number and apply labels.

fix(agent-task/capi): fix capi API version

4681b40

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

Copilot AI review requested due to automatic review settings February 20, 2026 18:06

babakks requested a review from a team as a code owner February 20, 2026 18:06

babakks requested a review from williammartin February 20, 2026 18:06

Copilot started reviewing on behalf of babakks February 20, 2026 18:07 View session

babakks requested a review from BagToad February 20, 2026 18:07

BagToad approved these changes Feb 20, 2026

View reviewed changes

babakks enabled auto-merge February 20, 2026 18:09

Copilot AI reviewed Feb 20, 2026

View reviewed changes

babakks merged commit 9e82fc2 into trunk Feb 20, 2026
29 checks passed

babakks deleted the babakks/fix-agent-task-api-version branch February 20, 2026 18:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(agent-task/capi): use a fixed CAPI API version#12731

fix(agent-task/capi): use a fixed CAPI API version#12731
babakks merged 1 commit intotrunkfrom
babakks/fix-agent-task-api-version

babakks commented Feb 20, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Feb 20, 2026

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	// This is quick fix to ensure that we are not using GitHub API versions while targeting CAPI.
	// This is a quick fix to ensure that we are not using GitHub API versions while targeting CAPI.

Conversation

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

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Feb 20, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

babakks commented Feb 20, 2026 •

edited

Loading