Route gpg key requests through api.Client by williammartin · Pull Request #13997 · cli/cli

williammartin · 2026-07-28T14:27:25Z

Description

This PR migrates gpg-key add, gpg-key delete and gpg-key list to use the api.Client for API interactions. There should be no user visible change.

We add tests for three ordered sentinel errors:

404 -> errScopesMissing
422 mentioning a duplicate key_id -> errDuplicateKey
422 for an unarmored key -> errWrongFormat.

This might be an overspecification of the tests, but it is behaviour that might be depended upon by someone out there, so at least worth knowing if it changed.

Two test stubs changed from RESTPayload(200, "") to RESTPayload(200, "{}") because the api client expects to unmarshal json (where previously the body was just thrown away); The REST endpoints do return JSON. We also backfill tests for other error paths.

Acceptance Test

➜  williammartin-laughing-couscous git:(williammartin-route-gpg-key-api) ✗ GH_ACCEPTANCE_HOST=github.com \
GH_ACCEPTANCE_ORG=gh-acceptance-testing \
GH_ACCEPTANCE_TOKEN="$(gh auth token --hostname github.com)" \
GH_ACCEPTANCE_SCRIPT=gpg-key.txtar \
go test -tags=acceptance -count=1 -v -run '^TestGPGKeys$' ./acceptance
=== RUN   TestGPGKeys
=== RUN   TestGPGKeys/gpg-key
=== PAUSE TestGPGKeys/gpg-key
=== CONT  TestGPGKeys/gpg-key
    testscript.go:584: WORK=$WORK
        PATH=/var/folders/z7/869nt6ns29d77xln9h9bm8680000gn/T/testscript-main1374413527/bin:/Users/williammartin/go/pkg/mod/golang.org/[email protected]/bin:/Users/williammartin/.local/bin:/opt/homebrew/bin:/opt/homebrew/sbin:/usr/local/bin:/System/Cryptexes/App/usr/bin:/usr/bin:/bin:/usr/sbin:/sbin:/var/run/com.apple.security.cryptexd/codex.system/bootstrap/usr/local/bin:/var/run/com.apple.security.cryptexd/codex.system/bootstrap/usr/bin:/var/run/com.apple.security.cryptexd/codex.system/bootstrap/usr/appleinternal/bin:/pkg/env/global/bin:/Users/williammartin/.local/bin
        GOTRACEBACK=system
        HOME=$WORK
        TMPDIR=$WORK/.tmp
        devnull=/dev/null
        /=/
        :=:
        $=$
        exe=
        SCRIPT_NAME=gpg_key
        GH_CONFIG_DIR=$WORK
        GH_HOST=github.com
        ORG=gh-acceptance-testing
        GH_TOKEN=gho_************************************
        RANDOM_STRING=fVJVPWtXGk
        GH_TELEMETRY=false
        
        #skip 'it modifies the user''s personal GitHub account GPG keys'
        # This test requires the admin:gpg_key scope to add and delete GPG keys to and
        # from the user's personal GitHub account. 
        # This test uses a GPG key that generated for this test only. The private key
        # has been deleted
        # Add the gpg key to GH account (0.816s)
        > exec gh gpg-key add gpg-key.pub
        # Verify the gpg key was added to GH account (0.316s)
        > exec gh gpg-key list
        [stdout]
        [email protected]  24C30F9C9115E747        xjMEZxpWhhYJKwYBBAHaRw8BAQdAmYiobR2ai/lVWOBtlAPRG1ZEMG5Effavpt5wn+wQ//U=        2026-07-28T17:44:54+02:00       2024-10-25T16:15:34+02:00
        > stdout '24C30F9C9115E747'
        # Delete the gpg key from GH account (0.613s)
        > exec gh gpg-key delete --yes '24C30F9C9115E747'
        # Check the key is deleted (0.310s)
        > exec gh gpg-key list
        > ! stdout '24C30F9C9115E747'
        PASS
        
--- PASS: TestGPGKeys (0.00s)
    --- PASS: TestGPGKeys/gpg-key (2.06s)
PASS
ok      github.com/cli/cli/v2/acceptance        2.776s

Copilot

Pull request overview

Migrates the gh gpg-key subcommands’ REST interactions from direct http.Client request handling to the shared api.Client wrapper, aligning this command set with the ongoing effort to consolidate API behavior behind a common client.

Changes:

Refactored gpg-key add, gpg-key delete, and gpg-key list HTTP helpers to use api.NewClientFromHTTP(...).REST(...).
Added/expanded unit tests to validate error mapping (notably 404 -> insufficient scopes, and ordered handling of 422 cases for add).
Updated test stubs to return JSON bodies where the API client expects JSON unmarshalling.

Show a summary per file

File	Description
pkg/cmd/gpg-key/add/http.go	Switch upload request to `api.Client` REST call and preserve prior sentinel error mapping behavior.
pkg/cmd/gpg-key/add/add_test.go	Add coverage for sentinel error mapping/order and adjust REST payload stubs to return JSON.
pkg/cmd/gpg-key/delete/http.go	Switch delete/list helpers to `api.Client` REST calls.
pkg/cmd/gpg-key/delete/delete_test.go	Add coverage for HTTP error surfacing from API client and fix go-gh HTTPError typing in stubs.
pkg/cmd/gpg-key/list/http.go	Switch list helper to `api.Client` REST call and preserve 404 -> scopes error mapping.
pkg/cmd/gpg-key/list/list_test.go	Add coverage for 404 mapping, generic HTTP error propagation, and user-scoped listing.

Review details

Tip

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

Files reviewed: 6/6 changed files
Comments generated: 0
Review effort level: Low

tidy-dev

✨

Co-authored-by: Copilot App <[email protected]> Copilot-Session: 605ad5d5-43b6-4332-b94b-6ae9b69bb3ff

This MR contains the following updates: | Package | Update | Change | |---|---|---| | [cli/cli](https://github.com/cli/cli) | minor | `v2.97.0` → `v2.98.0` | 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.98.0`](https://github.com/cli/cli/releases/tag/v2.98.0): GitHub CLI 2.98.0 [Compare Source](cli/cli@v2.97.0...v2.98.0) #### Security A security vulnerability has been identified, and fixed, that binds the local forwarded port to all available network interfaces by default. Users of `gh codespace ports forward` are advised to update `gh` to version `v2.98.0` as soon as possible. For more information see: <GHSA-vfhh-p7hm-pxfh> #### Support worktrees in `pr checkout` Users can now checkout a pull request into a git worktree by using the new `--worktree PATH` flag in `gh pr checkout`: ```shell gh pr checkout 12 --worktree ../wt-feature ``` #### Add semantic search to `search issues` The `gh search issues` command now supports semantic search for issues. Users can select the search type by passing the `--search-type` flag: ```shell gh search issues --search-type semantic ... gh search issues --search-type hybrid ... ``` For more information about semantic search see: ["Improved Search for github issues is now generally available"](https://github.blog/changelog/2026-04-02-improved-search-for-github-issues-is-now-generally-available/). #### What's Changed ##### ✨ Features - Add --worktree flag to gh pr checkout by [@tidy-dev](https://github.com/tidy-dev) in [#13946](cli/cli#13946) - Set GH\_EXTENSION=1 when gh invokes an extension by [@williammartin](https://github.com/williammartin) in [#14072](cli/cli#14072) - Add --search-type flag for semantic and hybrid issue search by [@michaeljacholke](https://github.com/michaeljacholke) in [#14006](cli/cli#14006) ##### 🐛 Fixes - Fix `RESTWithNext` error type, repairing `gh status` and attestation retries by [@williammartin](https://github.com/williammartin) in [#13988](cli/cli#13988) - Trim spaces when parsing X-Oauth-Scopes in `gh release create` by [@williammartin](https://github.com/williammartin) in [#14065](cli/cli#14065) - Fix project item-add output for non-TTY by [@zwick](https://github.com/zwick) in [#14056](cli/cli#14056) ##### 📚 Docs & Chores - Slim down dependabot triage comments by [@williammartin](https://github.com/williammartin) in [#14019](cli/cli#14019) - Require explicit MR review ownership by [@williammartin](https://github.com/williammartin) in [#14028](cli/cli#14028) - Collapse spam triage into the agentic issue-triage workflow by [@williammartin](https://github.com/williammartin) in [#14027](cli/cli#14027) - Run Dependabot triage every hour by [@sergiou87](https://github.com/sergiou87) in [#14030](cli/cli#14030) - Route deploy key requests through api.Client by [@williammartin](https://github.com/williammartin) in [#13989](cli/cli#13989) - Route ssh key requests through api.Client by [@williammartin](https://github.com/williammartin) in [#13994](cli/cli#13994) - Route gpg key requests through api.Client by [@williammartin](https://github.com/williammartin) in [#13997](cli/cli#13997) - Route autolink requests through api.Client by [@williammartin](https://github.com/williammartin) in [#14013](cli/cli#14013) - Route extension requests through api.Client by [@williammartin](https://github.com/williammartin) in [#14059](cli/cli#14059) - Route release creation through api.Client by [@williammartin](https://github.com/williammartin) in [#14062](cli/cli#14062) - Tell agents to use the MR template in AGENTS.md by [@williammartin](https://github.com/williammartin) in [#14074](cli/cli#14074) - Make Dependabot triage cheaper and more decisive by [@williammartin](https://github.com/williammartin) in [#14079](cli/cli#14079) - Route release deletions through api.Client by [@williammartin](https://github.com/williammartin) in [#14077](cli/cli#14077) - Give Dependabot triage a real reachability check by [@williammartin](https://github.com/williammartin) in [#14087](cli/cli#14087) - Restore automatic spam issue closure by [@williammartin](https://github.com/williammartin) in [#14088](cli/cli#14088) - Add a scheduled tech debt burndown skill by [@williammartin](https://github.com/williammartin) in [#14095](cli/cli#14095) - Use reflect.Pointer instead of deprecated reflect.Ptr by [@williammartin](https://github.com/williammartin) in [#14098](cli/cli#14098) - Clarify what belongs in the MR template's testing section by [@williammartin](https://github.com/williammartin) in [#14103](cli/cli#14103) - Rename cli-code-reviewer skill to code-review by [@BagToad](https://github.com/BagToad) in [#14116](cli/cli#14116) - Add aw-actions group to dependabot configuration by [@babakks](https://github.com/babakks) in [#14123](cli/cli#14123) - Isolate tests from local machine's auth and git configuration by [@BagToad](https://github.com/BagToad) in [#14128](cli/cli#14128) - Don't ask for feature detection cleanup comments when not needed by [@babakks](https://github.com/babakks) in [#14139](cli/cli#14139) - Accept pre-release tags in deployment validation by [@BagToad](https://github.com/BagToad) in [#14193](cli/cli#14193) - ci: add temporary step to verify Linux repo signing keys by [@babakks](https://github.com/babakks) in [#14202](cli/cli#14202) - Revert "ci: add temporary step to verify Linux repo signing keys" by [@babakks](https://github.com/babakks) in [#14203](cli/cli#14203) - Fix issue triage action compatibility \[skip changelog] by [@tidy-dev](https://github.com/tidy-dev) in [#14207](cli/cli#14207) #####

Dependencies - chore(deps): bump github.com/sigstore/sigstore-go from 1.2.2 to 1.3.0 by [@dependabot](https://github.com/dependabot)\[bot] in [#14047](cli/cli#14047) - chore(deps): bump the codeql-actions group across 1 directory with 3 updates by [@dependabot](https://github.com/dependabot)\[bot] in [#14049](cli/cli#14049) - chore(deps): bump google.golang.org/grpc from 1.82.1 to 1.83.0 by [@dependabot](https://github.com/dependabot)\[bot] in [#14048](cli/cli#14048) - chore(deps): bump github.com/google/go-containerregistry from 0.21.7 to 0.21.8 by [@dependabot](https://github.com/dependabot)\[bot] in [#14066](cli/cli#14066) - chore(deps): bump actions/attest from 4.2.1 to 4.2.2 by [@dependabot](https://github.com/dependabot)\[bot] in [#14100](cli/cli#14100) - chore(deps): bump azure/login from 3.0.0 to 3.0.1 by [@dependabot](https://github.com/dependabot)\[bot] in [#14101](cli/cli#14101) - chore(deps): bump the codeql-actions group across 1 directory with 3 updates by [@dependabot](https://github.com/dependabot)\[bot] in [#14091](cli/cli#14091) - chore(deps): bump github/gh-aw-actions/setup-cli from 0.83.4 to 0.85.4 by [@dependabot](https://github.com/dependabot)\[bot] in [#14068](cli/cli#14068) - chore(deps): bump github.com/google/go-containerregistry from 0.21.8 to 0.21.9 by [@dependabot](https://github.com/dependabot)\[bot] in [#14119](cli/cli#14119) - chore(deps): bump github.com/klauspost/compress from 1.19.1 to 1.19.2 by [@dependabot](https://github.com/dependabot)\[bot] in [#14120](cli/cli#14120) - chore(deps): bump the aw-actions group with 2 updates by [@dependabot](https://github.com/dependabot)\[bot] in [#14147](cli/cli#14147) - chore: sign APT repository with both keys by [@babakks](https://github.com/babakks) in [#13271](cli/cli#13271) - chore(deps): bump github.com/yuin/goldmark from 1.8.4 to 1.8.5 by [@dependabot](https://github.com/dependabot)\[bot] in [#14029](cli/cli#14029) - chore(deps): bump actions/attest from 4.2.0 to 4.2.1 by [@dependabot](https://github.com/dependabot)\[bot] in [#14050](cli/cli#14050) - Bump golangci-lint in CI to v2.12.2 by [@williammartin](https://github.com/williammartin) in [#14102](cli/cli#14102) - chore(deps): bump the aw-actions group with 2 updates by [@dependabot](https://github.com/dependabot)\[bot] in [#14124](cli/cli#14124) - chore(deps): bump google.golang.org/protobuf from 1.36.11 to 1.36.12 by [@dependabot](https://github.com/dependabot)\[bot] in [#14140](cli/cli#14140) - Upgrade gh-aw workflows to v0.85.4 by [@tidy-dev](https://github.com/tidy-dev) in [#14141](cli/cli#14141) - Bump Go to 1.26.6 by [@github-actions](https://github.com/github-actions)\[bot] in [#14143](cli/cli#14143) - chore: bump go to 1.26.7 by [@babakks](https://github.com/babakks) in [#14205](cli/cli#14205) - chore(deps): bump github.com/stretchr/testify from 1.11.1 to 1.12.1 by [@dependabot](https://github.com/dependabot)\[bot] in [#14204](cli/cli#14204) - chore(deps): bump the codeql-actions group across 1 directory with 3 updates by [@dependabot](https://github.com/dependabot)\[bot] in [#14169](cli/cli#14169) - chore(deps): bump golang.org/x/crypto from 0.54.0 to 0.55.0 by [@dependabot](https://github.com/dependabot)\[bot] in [#14164](cli/cli#14164) - chore(deps): bump charm.land/lipgloss/v2 from 2.0.5 to 2.0.6 by [@dependabot](https://github.com/dependabot)\[bot] in [#14166](cli/cli#14166) - Bump gh-aw-actions to v0.87.1 and recompile agentic workflows by [@BagToad](https://github.com/BagToad) in [#14210](cli/cli#14210) #### New Contributors - [@sergiou87](https://github.com/sergiou87) made their first contribution in [#14030](cli/cli#14030) - [@michaeljacholke](https://github.com/michaeljacholke) made their first contribution in [#14006](cli/cli#14006) **Full Changelog**: <cli/cli@v2.97.0...v2.98.0> </details> --- ### Configuration 📅 **Schedule**: (UTC) - 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 [Mend Renovate](https://github.com/renovatebot/renovate).

williammartin marked this pull request as ready for review July 28, 2026 15:45

williammartin requested a review from a team as a code owner July 28, 2026 15:45

williammartin requested review from Copilot and tidy-dev and removed request for a team July 28, 2026 15:45

Copilot started reviewing on behalf of williammartin July 28, 2026 15:46 View session

Copilot AI reviewed Jul 28, 2026

View reviewed changes

tidy-dev approved these changes Jul 30, 2026

View reviewed changes

williammartin force-pushed the williammartin-route-gpg-key-api branch from d9f53ae to 958a4b2 Compare July 31, 2026 11:22

babakks approved these changes Jul 31, 2026

View reviewed changes

Comment thread pkg/cmd/gpg-key/delete/delete_test.go

Comment thread pkg/cmd/gpg-key/list/http.go Outdated

Comment thread pkg/cmd/gpg-key/add/http.go

williammartin force-pushed the williammartin-route-gpg-key-api branch from 958a4b2 to 2e94434 Compare August 1, 2026 07:52

williammartin force-pushed the williammartin-route-gpg-key-api branch from 2e94434 to d387926 Compare August 4, 2026 08:25

Base automatically changed from williammartin-route-ssh-key-api-client to trunk August 4, 2026 08:35

Route gpg key requests through api.Client

ba1ef6e

Co-authored-by: Copilot App <[email protected]> Copilot-Session: 605ad5d5-43b6-4332-b94b-6ae9b69bb3ff

williammartin force-pushed the williammartin-route-gpg-key-api branch from d387926 to ba1ef6e Compare August 4, 2026 08:35

williammartin mentioned this pull request Aug 4, 2026

Route autolink requests through api.Client #14013

Merged

Use errors.AsType for gpg key errors

1602af9

Co-authored-by: Copilot App <[email protected]> Copilot-Session: 605ad5d5-43b6-4332-b94b-6ae9b69bb3ff

williammartin merged commit a3ed50a into trunk Aug 4, 2026
11 checks passed

williammartin deleted the williammartin-route-gpg-key-api branch August 4, 2026 09:01

williammartin mentioned this pull request Aug 7, 2026

Allow configuring a custom API endpoint per host #13717

Open

BrewTestBot mentioned this pull request Aug 20, 2026

gh 2.98.0 Homebrew/homebrew-core#299922

Merged

scottames-github-bot Bot mentioned this pull request Aug 26, 2026

chore(deps): update ⬆️ mise-packages scottames/dots#1029

Merged

1 task

Navigation Menu

Uh oh!

Route gpg key requests through api.Client - #13997

Route gpg key requests through api.Client#13997
williammartin merged 2 commits into
trunkfrom
williammartin-route-gpg-key-api

williammartin commented Jul 28, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

tidy-dev left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

williammartin commented Jul 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Acceptance Test

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Review details

Uh oh!

tidy-dev left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

williammartin commented Jul 28, 2026 •

edited

Loading