feat: Add support for deleting autolink references #10362

hoffm · 2025-02-03T02:30:04Z

Introduces the gh repo autolink delete <id> subcommand.

Deviation from Spec

The linked issue specifies deletion by key prefix, not ID, which is what I've implemented here.

Because the REST API does not support accessing autolinks by key prefix, we decided to build the CLI wrapper for viewing autolinks with ID, not key prefix, as the argument (see the bottom of this comment). For consistency's sake, I've extended that decision to the deletion case, as I proposed here.

We require a confirmation step for deletion, and our confirmation flow presents the user with a string to type in to confirm deletion. The key prefix of the autolink to be deleted is the natural fit for this string, and this is what the spec requires. To achieve this behavior, we fetch the autolink by ID to learn its key prefix, then use that value to prompt the user for confirmation.

We can—and I believe we should—follow up with an enhancement to allow viewing and deletion by either ID or key prefix.

Examples

Succesful Delete

Confirmation Step

$ ./bin/gh repo autolink delete 7196774 --repo nytimes/games-dsr
Autolink 7196774 has key prefix TEST-.
? Type TEST- to confirm deletion:

Confirmation Failure

$ ./bin/gh repo autolink delete 7196774 --repo nytimes/games-dsr
Autolink 7196774 has key prefix TEST-.
X Sorry, your reply was invalid: You entered foo
? Type TEST- to confirm deletion:

Confirmation Success

$ ./bin/gh repo autolink delete 7196774 --repo nytimes/games-dsr
Autolink 7196774 has key prefix TEST-.
X Sorry, your reply was invalid: You entered foo
✓ Autolink 7196774 deleted from nytimes/games-dsr

Delete, Skip Confirmation

$ ./bin/gh repo autolink delete 7204166 --yes  --repo nytimes/games-dsr
✓ Autolink 7204166 deleted from nytimes/games-dsr

404 (repo or autolink not found or no admin access)

./bin/gh repo autolink delete 123
error deleting autolink: HTTP 404: Perhaps you are missing admin rights to the repository? (https://api.github.com/repos/cli/cli/autolinks/123)

Missing Argument

$ ./bin/gh repo autolink delete
accepts 1 arg(s), received 0

Additional Changes

In addition to the work described above, I've included some small changes for the sake of consistency within the gh repo autolink subcommands, including:

Bold repo names.
Standardize 404 message to: "Perhaps you are missing admin rights to the repository?"
Use http constants for status codes in tests.
Fix var names where "autolink" is treated as two words, e.g. AutoLink -> "Auolink".

hoffm · 2025-02-03T02:36:06Z

pkg/cmd/repo/autolink/view/view_test.go

 			} else {
 				require.NoError(t, err)
 				assert.Equal(t, tt.wantExporter, gotOpts.Exporter != nil)
+				assert.Equal(t, tt.output.ID, gotOpts.ID)


This test should always have been checking that the opts including the correct ID.

hoffm · 2025-02-03T02:38:25Z

pkg/cmd/repo/autolink/list/list.go

-func listHeader(repoName string, count int) string {
-	return fmt.Sprintf("Showing %s in %s", text.Pluralize(count, "autolink reference"), repoName)
-}


I inlined this helper. It only had one caller and it's simple enough.

jtmcg

Man, is it refreshing to NOT see http stubs in the command set tests and only in the http tests 🥳 Nice work, there.

I think we're missing some non-TTY use-cases in this and have commented throughout the code where we may add its support. I could have missed some spots, though.

Also, I acknowledge that you deviated from the spec because the API uses the ID instead of the key prefix. It seems fine to break this up, as you suggested:

We can—and I believe we should—follow up with an enhancement to allow viewing and deletion by either ID or key prefix

I'm curious to hear about your thoughts on an approach to add key-prefix deletion.

jtmcg · 2025-02-06T22:06:10Z

pkg/cmd/repo/autolink/delete/delete_test.go

+var errTestAutolinkClientView = errors.New("autolink client view error")
+var errTestAutolinkClientDelete = errors.New("autolink client delete error")
+
+func TestDeleteRun(t *testing.T) {


These tests look solid 🫶 I read them before anything else, and not only do they suggest the separation between your logic layer and api layer is 👨‍🍳 💋, but they also do a great job documenting the logic demonstrating that you've implemented the AC 🎉

That said, I think we're missing one test for this AC:

Given I have the admin role on the repository
And Given I have a local repository cloned from GitHub
When I run gh repo autolink delete in non-interactive mode
Then I see an informational message stating --yes flag is required to delete autolink in non-interactive mode followed by the usage statement

We'll probably have to force the terminal to be non-tty for this use case. There's an example of how we usually do this in the alias/delete tests

Thanks—I'll definitely add the non-TTY behavior. Appreciate your catching that!

pkg/cmd/repo/autolink/delete/delete.go

jtmcg · 2025-02-06T22:15:06Z

pkg/cmd/repo/autolink/delete/delete.go

+	if !opts.Confirmed {
+		fmt.Fprintf(out, "Autolink %s has key prefix %s.\n", cs.Cyan(opts.ID), autolink.KeyPrefix)
+
+		err := opts.Prompter.ConfirmDeletion(autolink.KeyPrefix)
+
+		if err != nil {
+			return err
+		}
+	}


I think we need to handle the non-tty use-case, here. We should be exiting and not prompting for non-interactive terminals. I mentioned this as your missing test case in delete_test.go below as well

I updated the behavior as you suggested, though I followed an extant pattern of doing this in the command definition.

if !opts.IO.CanPrompt() && !opts.Confirmed { return cmdutil.FlagErrorf("--yes required when not running interactively") }

Also, fwiw, I noticed that the app is inconsistent about how it handles deletion for non-TTY use-cases. Some resources (e.g. issues) seem to just delete without confirming in non-interactive mode.

😅 That is concerning! We want to avoid those kind of foot-guns...

Can you open an issue with the inconsistencies you've found? Feel free to tag me on it

pkg/cmd/repo/autolink/delete/delete.go

pkg/cmd/repo/autolink/delete/http_test.go

jtmcg

Looks good to me! Thanks again!

This MR contains the following updates: | Package | Update | Change | |---|---|---| | [cli/cli](https://github.com/cli/cli) | minor | `v2.66.1` -> `v2.67.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.67.0`](https://github.com/cli/cli/releases/tag/v2.67.0): GitHub CLI 2.67.0 [Compare Source](cli/cli@v2.66.1...v2.67.0) #### `gh pr checkout` now supports interactively selecting a pull request Similar to commands like `gh workflow run` which prompts for a workflow to run, now `gh pr checkout` will prompt for a pull request to checkout. The list is currently limited to the most recent 10 pull requests in the repository. https://github.com/user-attachments/assets/0b2e3761-7318-4573-8a23-ae6f1a44b018 Big thank you to [@nilvng](https://github.com/nilvng) for implementing this 🙌 #### Contributing guidelines updated We've updated our [`CONTRIBUTING.md`](https://github.com/cli/cli/blob/trunk/.github/CONTRIBUTING.md) guidelines to give more clarity around old `help wanted` issues. *TLDR*: - Please directly mention `@cli/code-reviewers` when an issue you want to work on does not have clear Acceptance Criteria - Please only open pull requests for issues with *both* the help wanted label and clear Acceptance Criteria - Please avoid expanding pull request scope to include changes that are not described in the connected issue's Acceptance Criteria Note: Acceptance Criteria is posted as an issue comment by a core maintainer. See cli/cli#10381 and cli/cli#10395 for more information. ❓ Have feedback on anything? We'd love to hear from you in a discussion post ❤️ #### What's Changed ##### ✨ Features - feat: let user select pr to checkout by [@nilvng](https://github.com/nilvng) in cli/cli#9868 - feat: Add support for deleting autolink references by [@hoffm](https://github.com/hoffm) in cli/cli#10362 - \[gh extensions install] Improve help text and error message by [@iamazeem](https://github.com/iamazeem) in cli/cli#10333 - Error when `gh repo rename` is used with a new repo name that contains an owner by [@timrogers](https://github.com/timrogers) in cli/cli#10364 - Attestation bundle fetch improvements by [@malancas](https://github.com/malancas) in cli/cli#10233 - \[gh project item-list] Add `iterationId` field in ProjectV2ItemFieldIterationValue by [@iamazeem](https://github.com/iamazeem) in cli/cli#10329 ##### 🐛 Fixes - \[gh api] Fix mutual exclusion messages of `--slurp` flag by [@iamazeem](https://github.com/iamazeem) in cli/cli#10332 - Exit with error if no matching predicate type exists by [@kommendorkapten](https://github.com/kommendorkapten) in cli/cli#10421 - Do not try to parse bodies for HEAD requests by [@jsoref](https://github.com/jsoref) in cli/cli#10388 - \[gh project item-edit] Fix number type by [@iamazeem](https://github.com/iamazeem) in cli/cli#10374 - \[gh workflow run] Improve error handling for `--ref` flag by [@iamazeem](https://github.com/iamazeem) in cli/cli#10328 - \[gh config] Escape pipe symbol in Long desc for website manual by [@iamazeem](https://github.com/iamazeem) in cli/cli#10371 ##### 📚 Docs & Chores - Fix logic error in contributing docs by [@BagToad](https://github.com/BagToad) in cli/cli#10395 - Docs: Clarify guidelines for `help wanted` issues and pull requests by [@BagToad](https://github.com/BagToad) in cli/cli#10381 - \[gh pr status] Mention `gh pr checks` in the `Long` section by [@iamazeem](https://github.com/iamazeem) in cli/cli#10389 - \[docs/releasing.md] Add basic info for homebrew update flow by [@iamazeem](https://github.com/iamazeem) in cli/cli#10344 - \[gh issue/pr list] Improve help text by [@iamazeem](https://github.com/iamazeem) in cli/cli#10335 - Remove v1 project 'add to board' automation from prauto workflow by [@hoffm](https://github.com/hoffm) in cli/cli#10331 - Note: the following pair of MRs was reverted and never made into a release - \[gh repo edit] Allow setting commit message defaults by [@iamazeem](https://github.com/iamazeem) in cli/cli#10363 - Revert "\[gh repo edit] Allow setting commit message defaults" by [@BagToad](https://github.com/BagToad) in cli/cli#10372 #####

Dependencies - Bump google.golang.org/protobuf from 1.36.4 to 1.36.5 by [@dependabot](https://github.com/dependabot) in cli/cli#10379 **Full Changelog**: cli/cli@v2.66.1...v2.67.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).

hoffm added 11 commits February 1, 2025 11:09

Initial working implementation

908513f

Autolink delete tests

e226a79

Merge branch 'trunk' into delete-autolinks

031b45d

Revert change to deps

5fea94e

Autolink delete http tests

fc5a6d1

Merge branch 'trunk' into delete-autolinks

e14d7a4

clean up

dcc1efa

whitespace

0274999

More consistency

7325944

refac and some spacing in output

f907ad9

Use http constants

0b3efed

hoffm requested a review from a team as a code owner February 3, 2025 02:30

hoffm requested a review from williammartin February 3, 2025 02:30

cliAutomation added the external pull request originating outside of the CLI core team label Feb 3, 2025

AuoLink -> Autolink

0215579

hoffm commented Feb 3, 2025

View reviewed changes

Formatting

a1ae68b

hoffm commented Feb 3, 2025

View reviewed changes

hoffm added 4 commits February 2, 2025 21:46

Rename staggler

d5adafd

Merge branch 'trunk' into delete-autolinks

e195b24

Merge branch 'trunk' into delete-autolinks

f71ba0e

Merge branch 'trunk' into delete-autolinks

7a5b49a

jtmcg suggested changes Feb 6, 2025

View reviewed changes

hoffm added 3 commits February 7, 2025 15:49

Merge branch 'trunk' into delete-autolinks

8d0ec0a

Handle non-TTY behavior

9eaaf44

Improve http error test cases

8e2be73

hoffm requested a review from jtmcg February 7, 2025 21:57

jtmcg approved these changes Feb 7, 2025

View reviewed changes

jtmcg merged commit 5557958 into cli:trunk Feb 7, 2025
9 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

feat: Add support for deleting autolink references #10362

feat: Add support for deleting autolink references #10362

hoffm commented Feb 3, 2025 •

edited

Loading

Uh oh!

hoffm Feb 3, 2025

Uh oh!

hoffm Feb 3, 2025

Uh oh!

jtmcg left a comment

Uh oh!

jtmcg Feb 6, 2025

Uh oh!

hoffm Feb 7, 2025

Uh oh!

Uh oh!

jtmcg Feb 6, 2025

Uh oh!

hoffm Feb 7, 2025

Uh oh!

jtmcg Feb 7, 2025

Uh oh!

Uh oh!

Uh oh!

jtmcg left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

feat: Add support for deleting autolink references #10362

feat: Add support for deleting autolink references #10362

Conversation

hoffm commented Feb 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Deviation from Spec

Examples

Succesful Delete

Confirmation Step

Confirmation Failure

Confirmation Success

Delete, Skip Confirmation

404 (repo or autolink not found or no admin access)

Missing Argument

Additional Changes

Uh oh!

hoffm Feb 3, 2025

Choose a reason for hiding this comment

Uh oh!

hoffm Feb 3, 2025

Choose a reason for hiding this comment

Uh oh!

jtmcg left a comment

Choose a reason for hiding this comment

Uh oh!

jtmcg Feb 6, 2025

Choose a reason for hiding this comment

Uh oh!

hoffm Feb 7, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jtmcg Feb 6, 2025

Choose a reason for hiding this comment

Uh oh!

hoffm Feb 7, 2025

Choose a reason for hiding this comment

Uh oh!

jtmcg Feb 7, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

jtmcg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

hoffm commented Feb 3, 2025 •

edited

Loading