feat: add support for `--ref` in `gh cache delete` #11592

luxass · 2025-08-26T18:17:31Z

resolves #11425

Copilot

Pull Request Overview

This PR adds support for a --ref flag to the gh cache delete command, allowing users to narrow down cache deletion to a specific Git reference (branch or PR). The enhancement enables more precise cache management by specifying refs like refs/heads/branch-name or refs/pull/123/merge.

Added --ref flag to cache delete command with validation logic
Updated API integration to include ref parameter in delete requests
Added comprehensive test coverage for the new functionality

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File	Description
pkg/cmd/cache/delete/delete.go	Implements --ref flag with validation and API parameter handling
pkg/cmd/cache/delete/delete_test.go	Adds test cases for --ref flag validation and API integration

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

pkg/cmd/cache/delete/delete.go

andyfeller

Thank you for this contribution, @luxass! 🫶

This looks pretty good with some minor suggestions to ensure users have clear guidance.

pkg/cmd/cache/delete/delete.go

- Introduced `--ref` flag to narrow down cache deletion to a specific branch or PR reference. - Updated command examples to include usage of `--ref`. - Added validation to ensure `--ref` cannot be used with `--all` and must accompany a cache key/ID.

* Implemented test cases for handling the `--ref` flag in cache deletion commands. * Added validation for using `--ref` with cache key and ID. * Ensured proper error messages are returned for invalid usage of `--ref`.

* Clarified the description of the `--ref` flag to specify its purpose more accurately. * Ensures users understand that it narrows down deletion by cache key and ref.

* Changed the error message from "--ref cannot be used without cache key/ID" to "must provide a cache key" for clarity. * Updated corresponding test case to reflect the new error message.

babakks

The PR looks very good, @luxass! 🎉

To finalise the changes, I think we need to cover scenarios below. When you're done I'll go through the testing part.

1. Use `--ref` with a cache ID

The --ref option only applies to cases where the argument is a cache key. Therefore we need to add another validation check to make sure --ref is not used with a cache ID, with an error message like this:

--ref cannot be used with a cache ID

For this we can extract a small function like below and use it in both cmd.RunE (for validation) and deleteCaches.

func parseCacheID(arg string) (int, bool) {
    id, err := strconv.Atoi(arg)
    return id, err == nil
}

2. Better error message when `--ref` not found

Currently, if the user runs cache delete <cache-key> --ref <ref> where ref is invalid (or doesn't exist) then they'll see an error like this:

X Could not find a cache matching <cache-key> in <repo>

Since the user has provided the --ref option I think we should hint at the ref value in the error message. Something like this makes sense to me:

X Could not find a cache matching <cache-key> (with ref <ref>) in <repo>

Note that this format should only be used when there's a non-empty --ref value.

* Replaced direct conversion of cache ID string to int with a dedicated `parseCacheID` function. * Improved readability and maintainability of the `deleteCaches` function.

* Added validation to ensure that the `--ref` flag cannot be used when a cache ID is provided. * Updated error message to include the reference when a cache is not found with the specified `--ref`.

* Ensure that the `--ref` flag cannot be used in conjunction with a cache ID. * Update error handling to provide clear feedback when this condition is violated. * Add tests to cover scenarios involving the `--ref` flag and cache ID.

Signed-off-by: Babak K. Shandiz <[email protected]>

Also note that the API never returns HTTP 422 for invalid refs. Signed-off-by: Babak K. Shandiz <[email protected]>

babakks

Thanks for the changes, @luxass! 🙏

I went through the manual testing and noticed a few things. I'll now push some commits to fix the comments I just made below. With those, I think the PR is ready to be merged, but I'll ask for a another review from @andyfeller since I have made some changes.

pkg/cmd/cache/delete/delete.go

pkg/cmd/cache/delete/delete_test.go

babakks · 2025-08-28T10:21:29Z

@andyfeller I just resolved the comments from my last review since they're all sorted in the commits I pushed. I think the PR is good to be merged, but will appreciate your eyes on it. 🙏

dismissing to move this forward

This MR contains the following updates: | Package | Update | Change | |---|---|---| | [cli/cli](https://github.com/cli/cli) | minor | `v2.78.0` -> `v2.79.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.79.0`](https://github.com/cli/cli/releases/tag/v2.79.0): GitHub CLI 2.79.0 [Compare Source](cli/cli@v2.78.0...v2.79.0) #### Advanced Issue Search Support The GitHub CLI now supports advanced issue search syntax using: - Searching issues: `gh search issues <advanced issue search query>` - Searching pull requests: `gh search prs <advanced issue search query>` - While listing issues: `gh issue list --search <advanced issue search query>` - While listing pull requests: `gh pr list --search <advanced issue search query>` For more information about advanced issue search syntax, see: "[Filtering and Searching Issues and Merge Requests](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/filtering-and-searching-issues-and-pull-requests#building-advanced-filters-for-issues)" #### Copy OAuth Code Automatically The GitHub CLI now supports writing the OAuth one-time pass code to the clipboard automatically during authentication: - While logging in: `gh auth login --clipboard` / `gh auth login -c` - While refreshing the token: `gh auth refresh --clipboard` / `gh auth refresh -c` #### What's Changed ##### ✨ Features - feat: `gh auth` Automatically copy one-time OAuth code to clipboard by [@ankddev](https://github.com/ankddev) in [#11518](cli/cli#11518) - feat: add support for `--ref` in `gh cache delete` by [@luxass](https://github.com/luxass) in [#11592](cli/cli#11592) - Use advanced issue search by [@babakks](https://github.com/babakks) in [#11638](cli/cli#11638) ##### 📚 Docs & Chores - docs(release create): difference `--generate-notes` and `--notes-from-tag` by [@ankddev](https://github.com/ankddev) in [#11534](cli/cli#11534) - refactor tests: use `slices.Equal` to simplify code by [@minxinyi](https://github.com/minxinyi) in [#11364](cli/cli#11364) - Remove mention of public preview in trustedroot.go by [@jkylekelly](https://github.com/jkylekelly) in [#11652](cli/cli#11652) #####

Dependencies - Bump sigstore/rekor to v1.4.1 by [@BagToad](https://github.com/BagToad) in [#11654](cli/cli#11654) - chore(deps): bump actions/stale from 9 to 10 by [@dependabot](https://github.com/dependabot)\[bot] in [#11663](cli/cli#11663) - chore(deps): bump actions/setup-go from 5 to 6 by [@dependabot](https://github.com/dependabot)\[bot] in [#11662](cli/cli#11662) #### New Contributors - [@minxinyi](https://github.com/minxinyi) made their first contribution in [#11364](cli/cli#11364) - [@jkylekelly](https://github.com/jkylekelly) made their first contribution in [#11652](cli/cli#11652) - [@luxass](https://github.com/luxass) made their first contribution in [#11592](cli/cli#11592) **Full Changelog**: <cli/cli@v2.78.0...v2.79.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).

luxass temporarily deployed to cli-automation August 26, 2025 18:17 — with GitHub Actions Inactive

luxass force-pushed the cache-delete-with-ref branch 2 times, most recently from daf902a to 0d1629a Compare August 26, 2025 18:28

luxass marked this pull request as ready for review August 26, 2025 18:29

Copilot AI review requested due to automatic review settings August 26, 2025 18:29

luxass requested a review from a team as a code owner August 26, 2025 18:29

luxass requested a review from andyfeller August 26, 2025 18:29

luxass temporarily deployed to cli-automation August 26, 2025 18:29 — with GitHub Actions Inactive

cliAutomation added the external pull request originating outside of the CLI core team label Aug 26, 2025

Copilot AI reviewed Aug 26, 2025

View reviewed changes

pkg/cmd/cache/delete/delete.go Outdated Show resolved Hide resolved

andyfeller previously requested changes Aug 26, 2025

View reviewed changes

pkg/cmd/cache/delete/delete.go Outdated Show resolved Hide resolved

pkg/cmd/cache/delete/delete.go Outdated Show resolved Hide resolved

pkg/cmd/cache/delete/delete.go Outdated Show resolved Hide resolved

luxass added 4 commits August 27, 2025 04:56

test(cache): add tests for --ref flag in cache deletion

bfb1354

* Implemented test cases for handling the `--ref` flag in cache deletion commands. * Added validation for using `--ref` with cache key and ID. * Ensured proper error messages are returned for invalid usage of `--ref`.

chore(cache): improve help text for --ref flag in cache deletion

3ba82b5

* Clarified the description of the `--ref` flag to specify its purpose more accurately. * Ensures users understand that it narrows down deletion by cache key and ref.

fix(cache): update error message for missing cache key with --ref flag

047326f

* Changed the error message from "--ref cannot be used without cache key/ID" to "must provide a cache key" for clarity. * Updated corresponding test case to reflect the new error message.

luxass force-pushed the cache-delete-with-ref branch from f2102ad to 047326f Compare August 27, 2025 02:57

babakks requested changes Aug 27, 2025

View reviewed changes

luxass added 3 commits August 27, 2025 19:37

refactor(cache): extract cache ID parsing logic

5c29228

* Replaced direct conversion of cache ID string to int with a dedicated `parseCacheID` function. * Improved readability and maintainability of the `deleteCaches` function.

fix(cache): prevent using --ref flag with cache ID

1a19918

* Added validation to ensure that the `--ref` flag cannot be used when a cache ID is provided. * Updated error message to include the reference when a cache is not found with the specified `--ref`.

fix(cache): validate --ref flag usage with cache ID

926327c

* Ensure that the `--ref` flag cannot be used in conjunction with a cache ID. * Update error handling to provide clear feedback when this condition is violated. * Add tests to cover scenarios involving the `--ref` flag and cache ID.

luxass requested a review from babakks August 27, 2025 18:02

babakks added 6 commits August 28, 2025 10:02

refactor(cache delete): simplify condition

842d344

Signed-off-by: Babak K. Shandiz <[email protected]>

refactor(cache delete): simplify error handling

2dd54ae

Signed-off-by: Babak K. Shandiz <[email protected]>

test(cache delete): add test case for key arg and --all

d457a1b

Signed-off-by: Babak K. Shandiz <[email protected]>

docs(cache delete): explain different API responses

02d5070

Signed-off-by: Babak K. Shandiz <[email protected]>

test(cache delete): replace HTTP 204 with 200 to match API behaviour

d1a404a

Signed-off-by: Babak K. Shandiz <[email protected]>

test(cache delete): combine test cases for invalid/non-existent refs

08e4aa8

Also note that the API never returns HTTP 422 for invalid refs. Signed-off-by: Babak K. Shandiz <[email protected]>

babakks reviewed Aug 28, 2025

View reviewed changes

pkg/cmd/cache/delete/delete.go Outdated Show resolved Hide resolved

pkg/cmd/cache/delete/delete_test.go Outdated Show resolved Hide resolved

pkg/cmd/cache/delete/delete_test.go Outdated Show resolved Hide resolved

pkg/cmd/cache/delete/delete_test.go Outdated Show resolved Hide resolved

babakks requested a review from andyfeller August 28, 2025 10:20

babakks approved these changes Aug 28, 2025

View reviewed changes

mxie merged commit 926e293 into cli:trunk Sep 3, 2025
12 of 14 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: add support for `--ref` in `gh cache delete` #11592

feat: add support for `--ref` in `gh cache delete` #11592

luxass commented Aug 26, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

andyfeller left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

babakks left a comment

Uh oh!

babakks left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

babakks commented Aug 28, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

feat: add support for --ref in gh cache delete #11592

feat: add support for --ref in gh cache delete #11592

Conversation

luxass commented Aug 26, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

andyfeller left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

babakks left a comment

Choose a reason for hiding this comment

1. Use --ref with a cache ID

2. Better error message when --ref not found

Uh oh!

babakks left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

babakks commented Aug 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

feat: add support for `--ref` in `gh cache delete` #11592

feat: add support for `--ref` in `gh cache delete` #11592

1. Use `--ref` with a cache ID

2. Better error message when `--ref` not found

babakks commented Aug 28, 2025 •

edited

Loading