Route autolink requests through api.Client by williammartin · Pull Request #14013 · cli/cli

williammartin · 2026-07-30T09:31:07Z

Description

This PR migrates repo autolink create, repo autolink delete, repo autolink list and repo autolink view to use the api.Client for API interactions. There should be no user visible change.

Paths are now built with safeurl.JoinPath rather than safeurl.JoinPathWithHostPrefix, because api.Client prepends the REST prefix itself.

The 404 messages for delete, list and view previously interpolated a locally built URL. They now use httpErr.RequestURL, which is the URL actually requested. The rendered message is unchanged, and the existing assertions pass untouched.

Two status handling details changed. Both are inert against the real API, but are worth recording:

create previously treated only 201 as success (case http.StatusCreated), so any other 2xx fell through to api.HandleHTTPError and surfaced as, for example, HTTP 200 (https://api.github.com/repos/OWNER/REPO/autolinks). api.Client.REST returns nil for every 2xx, so such a response now decodes normally. GitHub returns 201.
delete previously never read the response body, so any 2xx succeeded. api.Client.REST returns early only for 204 and 205, so another 2xx with an empty body would now fail with unexpected end of JSON input. GitHub returns 204.

list and view used if resp.StatusCode > 299, which is already a range check, so they migrate without any change in accepted statuses.

We also backfill assertions for the 404 and 500 error paths.

Acceptance Test

There was no acceptance test for gh repo autolink, so this PR adds one. It needs no third party service: the urlTemplate is an opaque string that GitHub stores and returns, and is never resolved by either GitHub or gh.

➜  williammartin-psychic-potato git:(williammartin-migrate-repo-autolink) GH_ACCEPTANCE_HOST=github.com \
GH_ACCEPTANCE_ORG=gh-acceptance-testing \
GH_ACCEPTANCE_TOKEN="$(gh auth token --hostname github.com)" \
GH_ACCEPTANCE_SCRIPT=repo-autolink.txtar \
go test -tags=acceptance -count=1 -v -run '^TestRepo$' ./acceptance
=== RUN   TestRepo
=== RUN   TestRepo/repo-autolink
=== PAUSE TestRepo/repo-autolink
=== CONT  TestRepo/repo-autolink
    testscript.go:584: WORK=$WORK
        PATH=/var/folders/z7/869nt6ns29d77xln9h9bm8680000gn/T/testscript-main4109657185/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=repo_autolink
        GH_CONFIG_DIR=$WORK
        GH_HOST=github.com
        ORG=gh-acceptance-testing
        GH_TOKEN=gho_************************************
        RANDOM_STRING=fKzzanQvOQ
        GH_TELEMETRY=false
        
        # Create a repository to hold the autolink references (3.149s)
        > exec gh repo create $ORG/$SCRIPT_NAME-$RANDOM_STRING --add-readme --private
        [stdout]
        https://github.com/gh-acceptance-testing/repo_autolink-fKzzanQvOQ
        # Defer repo cleanup (0.000s)
        > defer gh repo delete --yes $ORG/$SCRIPT_NAME-$RANDOM_STRING
        # List the autolinks. There should be none (0.271s)
        > exec gh repo autolink list --repo $ORG/$SCRIPT_NAME-$RANDOM_STRING --json=keyPrefix
        > ! stdout keyPrefix
        # Create an alphanumeric autolink (0.317s)
        > exec gh repo autolink create --repo $ORG/$SCRIPT_NAME-$RANDOM_STRING TICKET- 'https://example.com/TICKET?query=<num>'
        [stdout]
        ✓ Created repository autolink 16207488 on gh-acceptance-testing/repo_autolink-fKzzanQvOQ
        # Ensure the autolink was created (0.274s)
        > exec gh repo autolink list --repo $ORG/$SCRIPT_NAME-$RANDOM_STRING --json=keyPrefix --jq='.[].keyPrefix'
        [stdout]
        TICKET-
        > stdout 'TICKET-'
        # Get the autolink id (0.258s)
        > exec gh repo autolink list --repo $ORG/$SCRIPT_NAME-$RANDOM_STRING --json=keyPrefix,id --jq='.[] | select(.keyPrefix == "TICKET-") | .id'
        [stdout]
        16207488
        > stdout2env AUTOLINK_ID
        # View the autolink and ensure the url template round tripped (0.326s)
        > exec gh repo autolink view --repo $ORG/$SCRIPT_NAME-$RANDOM_STRING $AUTOLINK_ID --json=urlTemplate --jq='.urlTemplate'
        [stdout]
        https://example.com/TICKET?query=<num>
        > stdout 'https://example\.com/TICKET\?query=<num>'
        # Delete the autolink (0.515s)
        > exec gh repo autolink delete --repo $ORG/$SCRIPT_NAME-$RANDOM_STRING $AUTOLINK_ID --yes
        # Ensure the autolink was deleted (0.279s)
        > exec gh repo autolink list --repo $ORG/$SCRIPT_NAME-$RANDOM_STRING --json=id --jq='.[].id'
        > ! stdout $AUTOLINK_ID
        PASS
        
--- PASS: TestRepo (0.00s)
    --- PASS: TestRepo/repo-autolink (6.01s)
PASS
ok  	github.com/cli/cli/v2/acceptance	6.541s

Notes

This is a stacked PR. It targets #13997.

…at (#46) * review: mark a blocking verdict on the PR, not only in firstmate's chat PR #44 merged carrying seven confirmed defects while its crew was still fixing them. The review had found all seven and firstmate had said not to merge, but that verdict existed only in the firstmate session's chat, so whoever clicked merge never saw it. AGENTS.md section 6 step 3 now requires the verdict to land on the PR when one is already open: draft a firstmate-authored PR with `gh pr ready --undo`, which blocks the merge button mechanically instead of merely advising, plus a comment carrying the reason; never draft a bot's PR, where a comment and a `do-not-merge` label are used instead. docs/pr-block-signal.md owns the commands, the per-repo label setup, and the verification record - including the check that drafting does NOT suppress this repo's PR CI, which is what makes the draft path safe for the fix loop. * docs(pr-block-signal): replace inferred draft-CI reasoning with live evidence The event reference does not document whether workflows run on draft PRs, so the claim now rests on a live draft PR in a public repo whose workflow has the same bare `pull_request:` trigger shape as ours (cli/cli#14013, 15 completed check runs while isDraft). Also records that GitHub's current stage-change docs carry no plan or visibility restriction on drafts at all, which makes gh's "If supported by your plan" caveat conservative rather than a live constraint. * docs(pr-block-signal): record the bot-versus-firstmate discriminator check Verified on live PRs of both kinds that .author.is_bot separates the two mechanisms, and stated the two commands that close the one gap left in the record - the live draft conversion - on any open firstmate PR.

Copilot

Pull request overview

Routes the repo autolink REST call sites through api.Client.REST instead of direct httpClient.Do, consolidating GitHub API URL derivation and unblocking per-host API routing work.

Changes:

Migrate create, delete, list, and view autolink HTTP helpers to use api.NewClientFromHTTP(...).REST(...).
Reconstruct the existing custom 404 error branches via errors.As on api.HTTPError, keeping legacy messages intact.
Expand unit/acceptance coverage for autolink operations (including new acceptance flow).

Show a summary per file

File	Description
pkg/cmd/repo/autolink/view/http.go	Switch view request to `api.Client.REST` and preserve the custom 404 message via `errors.As`.
pkg/cmd/repo/autolink/view/http_test.go	Update stubs/assertions to reflect `api.Client` behavior and add coverage for unexpected errors.
pkg/cmd/repo/autolink/list/http.go	Switch list request to `api.Client.REST` and preserve the custom 404 message via `errors.As`.
pkg/cmd/repo/autolink/list/http_test.go	Update list tests to assert on `api.HTTPError` details for non-404 failures.
pkg/cmd/repo/autolink/delete/http.go	Switch delete request to `api.Client.REST` and preserve the custom 404 message via `errors.As`.
pkg/cmd/repo/autolink/delete/http_test.go	Update delete tests to assert on `api.HTTPError` details for unexpected errors.
pkg/cmd/repo/autolink/create/http.go	Switch create request to `api.Client.REST` and preserve the custom 404 behavior while accepting any 2xx as success.
pkg/cmd/repo/autolink/create/http_test.go	Update create tests to assert on `api.HTTPError` status codes for failure responses.
acceptance/testdata/repo/repo-autolink.txtar	Add an end-to-end acceptance script covering autolink create/list/view/delete.

Review details

Tip

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

Suppressed comments (1)

pkg/cmd/repo/autolink/create/http_test.go:35

Create now succeeds for any 2xx response (per the PR description, HTTP 200 is now treated as success). The tests only cover a 201 response, so the new success behavior isn’t locked in and could regress back to an error for 200.

Add a table entry that stubs an HTTP 200 response and asserts it decodes successfully.

		{
			name: "201 successful creation",
			req: AutolinkCreateRequest{
				IsAlphanumeric: true,
				KeyPrefix:      "TICKET-",

Files reviewed: 9/9 changed files
Comments generated: 0
Review effort level: Lite

Co-authored-by: Copilot App <[email protected]> Copilot-Session: 598c3576-22dc-4d7f-a72d-4f84922174a1

Co-authored-by: Copilot App <[email protected]> Copilot-Session: d5151527-3286-43fd-a420-38f496a076fa

Co-authored-by: Copilot App <[email protected]> Copilot-Session: 598c3576-22dc-4d7f-a72d-4f84922174a1

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 force-pushed the williammartin-migrate-repo-autolink branch from 8606f36 to 6d4e36a Compare July 31, 2026 11:24

williammartin force-pushed the williammartin-migrate-repo-autolink branch from 6d4e36a to 540985a Compare August 1, 2026 07:52

williammartin force-pushed the williammartin-migrate-repo-autolink branch from 540985a to a6548bc Compare August 4, 2026 08:25

williammartin force-pushed the williammartin-migrate-repo-autolink branch from a6548bc to d30ab8d Compare August 4, 2026 08:35

Copilot AI lite review requested due to automatic review settings August 4, 2026 08:48

Copilot started reviewing on behalf of williammartin August 4, 2026 08:48 View session

Copilot AI reviewed Aug 4, 2026

View reviewed changes

williammartin marked this pull request as ready for review August 4, 2026 08:58

williammartin requested a review from a team as a code owner August 4, 2026 08:58

williammartin requested a review from tidy-dev August 4, 2026 08:58

Base automatically changed from williammartin-route-gpg-key-api to trunk August 4, 2026 09:01

williammartin mentioned this pull request Aug 4, 2026

Route extension requests through api.Client #14059

Merged

williammartin and others added 3 commits August 4, 2026 11:08

Route autolink requests through api.Client

e87b87c

Co-authored-by: Copilot App <[email protected]> Copilot-Session: 598c3576-22dc-4d7f-a72d-4f84922174a1

Add repo autolink acceptance test

b311747

Co-authored-by: Copilot App <[email protected]> Copilot-Session: d5151527-3286-43fd-a420-38f496a076fa

Remove redundant HTTP error assertions

c47bc92

Co-authored-by: Copilot App <[email protected]> Copilot-Session: 598c3576-22dc-4d7f-a72d-4f84922174a1

williammartin force-pushed the williammartin-migrate-repo-autolink branch from fed5df9 to c47bc92 Compare August 4, 2026 09:09

tidy-dev approved these changes Aug 4, 2026

View reviewed changes

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

williammartin deleted the williammartin-migrate-repo-autolink branch August 4, 2026 16:55

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 autolink requests through api.Client - #14013

Route autolink requests through api.Client#14013
williammartin merged 3 commits into
trunkfrom
williammartin-migrate-repo-autolink

williammartin commented Jul 30, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

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

Uh oh!

Description

Acceptance Test

Notes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Review details

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

williammartin commented Jul 30, 2026 •

edited

Loading