[gh cache delete --all] Add `--succeed-on-no-caches` flag to return exit code 0 #10327

iamazeem · 2025-01-29T09:56:03Z

…xit code 0

jtmcg

Thanks for the contribution, @iamazeem! I've left a few comments throughout the code that I think we'll need to address before we ship this.

Additionally, I'd like to see some tests added to TestDeleteRun to cover these new code paths.

pkg/cmd/cache/delete/delete.go

jtmcg

Almost there 👍

I still think we're missing unit tests for TestDeleteRun. The tests you've added for NewCmdDelete don't actually test the internals of the command, as they are intercepted by the runF function.

I've gone ahead and opened a PR against your branch to demonstrate what I'm looking for. Notably, one of the tests I wrote is failing, which I think actually caught a case I hadn't considered before trying to write the tests 🥳 (Note: I did not fix the failure, yet, and figured that should be addressed here once that PR merges).

Let me know if you have any questions! And thanks again for all the work you've been putting into the cli lately 🙌

pkg/cmd/cache/delete/delete.go

iamazeem · 2025-02-11T11:51:43Z

@jtmcg: Updated. Ready for review. Thanks!

williammartin

Current Behaviour

➜  test-repo git:(feature) gh cache delete --all
X No caches to delete
➜  test-repo git:(feature) echo $?
1

Acceptance Criteria

Given I have no caches
When I run gh cache delete --all --succeed-on-no-caches
Then it exits 0

➜  test-repo git:(feature) ~/workspace/cli/bin/gh cache delete --all --succeed-on-no-caches
✓ No caches to delete
➜  test-repo git:(feature) echo $?
0

When I run gh cache delete <cache-id> --succeed-on-no-caches
Then I get an error that --succeed-on-no-caches can only be used in conjunction with --all

➜  test-repo git:(feature) ~/workspace/cli/bin/gh cache delete --succeed-on-no-caches
--succeed-on-no-caches must be used in conjunction with --all

Usage:  gh cache delete [<cache-id> | <cache-key> | --all] [flags]

Flags:
  -a, --all                          Delete all caches
      --succeed-on-no-caches --all   Return exit code 0 if no caches found. Must be used in conjunction with --all

LGTM thanks!

williammartin · 2025-02-18T14:35:57Z

@jtmcg please re-review your requested changes.

pkg/cmd/cache/delete/delete_test.go

pkg/cmd/cache/delete/delete.go

jtmcg · 2025-02-18T19:24:39Z

@jtmcg please re-review your requested changes.

Damn, I had reviewed and had forgotten to push "submit review", so I had 2 comments in pending... It's a pretty straight-forward change, then we'll be good to go!

…cli into 9897-gh-cache-delete-exit-code

iamazeem · 2025-02-19T05:33:08Z

@jtmcg: Updated PR for the non-TTY case also. Please review. Thanks!

Tests

$ go clean -testcache && go test ./pkg/cmd/cache/delete/...
ok  	github.com/cli/cli/v2/pkg/cmd/cache/delete	0.005s


# TTY
$ bin/gh cache delete --repo iamazeem/test --succeed-on-no-caches --all
✓ No caches to delete
$ echo $?
0


# non-TTY
$ bin/gh cache delete --repo iamazeem/test --succeed-on-no-caches --all | cat

jtmcg

🚀

This MR contains the following updates: | Package | Update | Change | |---|---|---| | [cli/cli](https://github.com/cli/cli) | minor | `v2.67.0` -> `v2.68.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.68.0`](https://github.com/cli/cli/releases/tag/v2.68.0): GitHub CLI 2.68.0 [Compare Source](cli/cli@v2.67.0...v2.68.0) #### What's Changed ##### ✨ Features - \[gh repo view] Improve error message for forked repo by [@iamazeem](https://github.com/iamazeem) in cli/cli#10334 - Add signer-digest, source-ref, and source-digest options for `gh attestation verify` by [@malancas](https://github.com/malancas) in cli/cli#10308 - \[gh pr checkout] Add --no-tags option to git fetch commands in checkout by [@latzskim](https://github.com/latzskim) in cli/cli#10479 - \[`gh issue/pr comment`] Add `--create-if-none` and prompts to create a comment if no comment already exists by [@latzskim](https://github.com/latzskim) in cli/cli#10427 - \[gh cache delete --all] Add `--succeed-on-no-caches` flag to return exit code 0 by [@iamazeem](https://github.com/iamazeem) in cli/cli#10327 - \[gh release create] Fail when there are no new commits since the last release by [@iamazeem](https://github.com/iamazeem) in cli/cli#10398 - update default upstream when forking repo during MR creation by [@daviddl9](https://github.com/daviddl9) in cli/cli#10458 ##### 🐛 Fixes - Refactor `GetLocalAttestations` and clean up custom registry transport by [@malancas](https://github.com/malancas) in cli/cli#10382 - Check `GH_REPO` too in addition to `--repo` for disambiguation by [@williammartin](https://github.com/williammartin) in cli/cli#10539 - (Fixes `gh secret` subcommands not working outside of a repository) - Fix unhandled panic in FindWorkflow and add tests by [@jtmcg](https://github.com/jtmcg) in cli/cli#10521 - Fix checkout when URL arg is from fork and cwd is upstream by [@williammartin](https://github.com/williammartin) in cli/cli#10512 - \[gh api] Escape package name (URL encoding) for packages endpoint by [@iamazeem](https://github.com/iamazeem) in cli/cli#10384 - Fix `remoteResolver` caching issue by [@iamazeem](https://github.com/iamazeem) in cli/cli#10456 - Fix gh project item-edit to allow --number 0 as a valid value by [@aryanbhosale](https://github.com/aryanbhosale) in cli/cli#10417 - Add mutex to fix race in attestation test client by [@codysoyland](https://github.com/codysoyland) in cli/cli#10439 - Base64 decode GPG passphrase in deployment workflow by [@BagToad](https://github.com/BagToad) in cli/cli#10546 ##### 📚 Docs & Chores - Deep Dive Document Release Process by [@williammartin](https://github.com/williammartin) in cli/cli#10503 - Inconsistent format of examples in help text by [@iamazeem](https://github.com/iamazeem) in cli/cli#10508 - Inconsistent format of description of flags (starting with lowercase letter) by [@iamazeem](https://github.com/iamazeem) in cli/cli#10507 - Update Go version to 1.23 in CONTRIBUTING.md by [@williammartin](https://github.com/williammartin) in cli/cli#10504 - Fix minor auth login help typo by [@williammartin](https://github.com/williammartin) in cli/cli#10501 - docs: document how to revoke `gh` OAuth tokens in `auth logout`'s help by [@BagToad](https://github.com/BagToad) in cli/cli#10490 - chore: update codespaces Go version by [@BagToad](https://github.com/BagToad) in cli/cli#10491 - Allow injection of TUFMetadataDir in tests by [@williammartin](https://github.com/williammartin) in cli/cli#10478 - refactor: use a more straightforward return value by [@beforetech](https://github.com/beforetech) in cli/cli#10489 - Use subtests in attestation verification integration tests by [@williammartin](https://github.com/williammartin) in cli/cli#10463 - Fix typo in README by [@iamazeem](https://github.com/iamazeem) in cli/cli#10445 - Update usage to lower-kebab-case by [@iamazeem](https://github.com/iamazeem) in cli/cli#10447 - Standardize URLs by [@iamazeem](https://github.com/iamazeem) in cli/cli#10429 - Remove trailing whitespace by [@iamazeem](https://github.com/iamazeem) in cli/cli#10430 #####

Dependencies - Bump actions/attest-build-provenance from 2.2.0 to 2.2.2 by [@dependabot](https://github.com/dependabot) in cli/cli#10518 - Bump github.com/go-jose/go-jose/v4 from 4.0.2 to 4.0.5 by [@dependabot](https://github.com/dependabot) in cli/cli#10499 - Bump github.com/spf13/pflag from 1.0.5 to 1.0.6 by [@dependabot](https://github.com/dependabot) in cli/cli#10338 </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).

[gh cache delete --all] Add --succeed-on-no-caches flag to return e…

82ee9a2

…xit code 0

iamazeem requested a review from a team as a code owner January 29, 2025 09:56

iamazeem requested a review from williammartin January 29, 2025 09:56

cliAutomation added the external pull request originating outside of the CLI core team label Jan 29, 2025

Merge branch 'trunk' into 9897-gh-cache-delete-exit-code

b8d32e5

jtmcg suggested changes Jan 30, 2025

View reviewed changes

Address PR review comments

d6be498

iamazeem requested a review from jtmcg January 31, 2025 07:39

jtmcg mentioned this pull request Feb 5, 2025

Add test cases for succeed on no cache and api errors for --all iamazeem/cli#1

Merged

jtmcg reviewed Feb 5, 2025

View reviewed changes

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

Remove short (abbreviated) flag support

9e13890

iamazeem requested a review from jtmcg February 6, 2025 07:43

jtmcg and others added 5 commits February 6, 2025 22:47

Add test cases for succeed on no cache and api errors for --all (#1)

2f0f387

Update tests

09ec38e

Merge branch 'trunk' into 9897-gh-cache-delete-exit-code

db8d548

Update tests

a29e744

Use API without shorthand flag

17e7b57

williammartin approved these changes Feb 18, 2025

View reviewed changes

jtmcg reviewed Feb 18, 2025

View reviewed changes

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

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

iamazeem added 2 commits February 19, 2025 10:22

Fix non-TTY case

76efb5a

Merge branch '9897-gh-cache-delete-exit-code' of github.com:iamazeem/…

db8e810

…cli into 9897-gh-cache-delete-exit-code

iamazeem requested a review from jtmcg February 19, 2025 05:25

Update tests

9389628

iamazeem mentioned this pull request Feb 19, 2025

[gh release create] Fail when there are no new commits since the last release #10398

Merged

jtmcg approved these changes Feb 19, 2025

View reviewed changes

jtmcg merged commit 5aa36de into cli:trunk Feb 19, 2025
9 checks passed

iamazeem deleted the 9897-gh-cache-delete-exit-code branch February 19, 2025 18:35

Uh oh!

[gh cache delete --all] Add --succeed-on-no-caches flag to return exit code 0 #10327

[gh cache delete --all] Add --succeed-on-no-caches flag to return exit code 0 #10327

Uh oh!

Conversation

iamazeem commented Jan 29, 2025

Uh oh!

jtmcg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jtmcg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

iamazeem commented Feb 11, 2025

Uh oh!

williammartin left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Current Behaviour

Acceptance Criteria

Uh oh!

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

Uh oh!

Uh oh!

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

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

Uh oh!

Tests

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

[gh cache delete --all] Add `--succeed-on-no-caches` flag to return exit code 0 #10327

[gh cache delete --all] Add `--succeed-on-no-caches` flag to return exit code 0 #10327

williammartin left a comment •

edited

Loading

williammartin commented Feb 18, 2025 •

edited

Loading

jtmcg commented Feb 18, 2025 •

edited

Loading

iamazeem commented Feb 19, 2025 •

edited

Loading