Add option to remove file from gist #7560

kousikmitra · 2023-06-10T10:55:09Z

Add --remove flag in gist edit
- to keep it consistent with add file flag
will throw error if combined with add or filename flag
does not support multiple file delete

williammartin

Hi @kousikmitra, thanks a lot for taking on this work. Generally it looks pretty good and achieves the goal of non-interactive deletion of gist files.

Firstly, I have requested some changes which I hope make sense to you.

Secondly, in #7517 we also said this should work interactively. Is there a reason you left this out? I'd be happy to merge this PR and follow up with the interactive behaviour in another PR but I also want to give you the opportunity to implement it.

pkg/cmd/gist/edit/edit_test.go

pkg/cmd/gist/edit/edit.go

kousikmitra · 2023-06-22T17:19:32Z

Hi @kousikmitra, thanks a lot for taking on this work. Generally it looks pretty good and achieves the goal of non-interactive deletion of gist files.

Firstly, I have requested some changes which I hope make sense to you.

Secondly, in #7517 we also said this should work interactively. Is there a reason you left this out? I'd be happy to merge this PR and follow up with the interactive behaviour in another PR but I also want to give you the opportunity to implement it.

Hey @williammartin , I was trying to do the interactive bit. But the problem is I could not find a feature in cobra which supports a flag with optional argument.

if a flag is defined as StringVarP to support edit --remove filename the same flag can't be used without a value like edit --remove.
There are some workaround.

Make the flag boolean and take the filename as positional argument
Set NoOptDefVal for the flag, to use this we have to enter the command like this edit --remove=filename cause when this field is set it will interpret the filename in command edit --remove filename as positional argument

1st option is a bit hacky but won't change how user is interacting with cli, I don't like the 2nd option as it changes the how the flag has to be used.

Let me know if there's an better alternative. I will make the change in this PR only.

williammartin · 2023-06-22T17:50:25Z

Thanks for that information @kousikmitra, I think I got confused with gh gist edit offering interactivity with a file picker but it's not a flag, as you call out.

I don't really like either of the options you presented, and I'm not aware of another option but if we discover one later we can always make that change in a non-breaking manner. I'm inclined to say that we leave this feature as non-interactive. It's not ideal but the user is able to find filenames using gh gist view --files so it is possible to find the filenames through the CLI and go from there.

pkg/cmd/gist/edit/edit_test.go

williammartin

LGTM thank you for your continued contribution! ✨

Please squash + merge this when you are ready.

kousikmitra · 2023-06-23T12:07:35Z

LGTM thank you for your continued contribution! ✨

Please squash + merge this when you are ready.

Thanks @williammartin Ready from my side.

I don't have write access, someone with write access need to merge. I am hoping manual squash is not needed, let me know if you want me to do that.

williammartin · 2023-06-23T12:08:44Z

Sorry @kousikmitra, I'm new to the team and didn't realise contributors couldn't merge their own PRs after approval. Cheers!

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Update | Change | |---|---|---| | [aquaproj/aqua-registry](https://togithub.com/aquaproj/aqua-registry) | minor | `v4.25.0` -> `v4.26.0` | | [cli/cli](https://togithub.com/cli/cli) | minor | `v2.31.0` -> `v2.32.0` | | [fluxcd/flux2](https://togithub.com/fluxcd/flux2) | patch | `v2.0.0` -> `v2.0.1` | --- ### Release Notes <details> <summary>aquaproj/aqua-registry (aquaproj/aqua-registry)</summary> ### [`v4.26.0`](https://togithub.com/aquaproj/aqua-registry/releases/tag/v4.26.0) [Compare Source](https://togithub.com/aquaproj/aqua-registry/compare/v4.25.0...v4.26.0) [Issues](https://togithub.com/aquaproj/aqua-registry/issues?q=is%3Aissue+milestone%3Av4.26.0) | [Pull Requests](https://togithub.com/aquaproj/aqua-registry/pulls?q=is%3Apr+milestone%3Av4.26.0) | aquaproj/aqua-registry@v4.25.0...v4.26.0 #### 🎉 New Packages [#13656](https://togithub.com/aquaproj/aqua-registry/issues/13656) [cilium/cilium-cli](https://togithub.com/cilium/cilium-cli): CLI to install, manage & troubleshoot Kubernetes clusters running Cilium [@honahuku](https://togithub.com/honahuku) [#13657](https://togithub.com/aquaproj/aqua-registry/issues/13657) [ponkio-o/ec2x](https://togithub.com/ponkio-o/ec2x): A cli tool of connect to ec2 instance [@ponkio-o](https://togithub.com/ponkio-o) #### 🎉 New Contributor [@honahuku](https://togithub.com/honahuku) [#13656](https://togithub.com/aquaproj/aqua-registry/issues/13656) </details> <details> <summary>cli/cli (cli/cli)</summary> ### [`v2.32.0`](https://togithub.com/cli/cli/releases/tag/v2.32.0): GitHub CLI 2.32.0 [Compare Source](https://togithub.com/cli/cli/compare/v2.31.0...v2.32.0) hello terminal fans, it's me [@vilmibm](https://togithub.com/vilmibm) . We are pleased to bring you a new release of the GitHub CLI on this Confusion 46, 3189 YOLD. We've got features. we've got bugfixes. This release has a real zest for life; can you feel it? First though, a sad note. [@mislav](https://togithub.com/mislav) has moved on from GitHub. He was instrumental to this project and without him I don't think it would have ever happened. BIG THANKS MUCH LOVE to this wonderful person! Happily, we have a new core team member though who is, truly, a delight. Please welcome [@williammartin](https://togithub.com/williammartin) , whom you'll see a lot more on issues and pull requests moving forward. Now, let's talk ***BUSINESS***. #### gh ruleset [Repository Rulesets](https://github.blog/changelog/2023-04-17-introducing-repository-rules-public-beta/) are in beta on git hub dot com and they are now also in beta on git hub sea ell eye. You can list, view, and check branches against rulesets set at the repository or organization level. Major shoutouts to [@vaindil](https://togithub.com/vaindil) for this [big contribution](https://togithub.com/cli/cli/pull/7650). My favorite command in here in `gh rs check <branch>` which will tell you what rules would apply to a hypothetical branch name. To learn more, run `gh help ruleset`. #### gh cache `gh cache` is a new top level command in our suite of support for Actions. It lets you list and delete caches saved in Actions. It's [neat](https://togithub.com/cli/cli/pull/7403) and I like it. Thanks, [@joshkraft](https://togithub.com/joshkraft) ! To learn more, run `gh help cache`. #### Other new stuff - Add option to remove file from gist by [@kousikmitra](https://togithub.com/kousikmitra) in [https://github.com/cli/cli/pull/7560](https://togithub.com/cli/cli/pull/7560) - Add remove/reset to auth refresh by [@n1lesh](https://togithub.com/n1lesh) in [https://github.com/cli/cli/pull/7597](https://togithub.com/cli/cli/pull/7597) - Small tweaks to auth refresh remove-scopes and reset-scopes flags by [@samcoe](https://togithub.com/samcoe) in [https://github.com/cli/cli/pull/7631](https://togithub.com/cli/cli/pull/7631) - make `gh pr create` behavior like `gh repo fork` by [@leavesster](https://togithub.com/leavesster) in [https://github.com/cli/cli/pull/7330](https://togithub.com/cli/cli/pull/7330) - chore: add title to iteration and milestone fields by [@kamaz](https://togithub.com/kamaz) in [https://github.com/cli/cli/pull/7621](https://togithub.com/cli/cli/pull/7621) - AutoFetch new branch created with gh issue develop by [@shion1305](https://togithub.com/shion1305) in [https://github.com/cli/cli/pull/7589](https://togithub.com/cli/cli/pull/7589) - feat: add statuscheck description to pr checks output by [@jgrumboe](https://togithub.com/jgrumboe) in [https://github.com/cli/cli/pull/7451](https://togithub.com/cli/cli/pull/7451) - Always show created gist privacy status. by [@seanbright](https://togithub.com/seanbright) in [https://github.com/cli/cli/pull/7645](https://togithub.com/cli/cli/pull/7645) - \[Codespaces] Support random `--server-port=0` and printing connection details by [@josebalius](https://togithub.com/josebalius) in [https://github.com/cli/cli/pull/7655](https://togithub.com/cli/cli/pull/7655) - gh release edit: support --verify-tag like gh release create by [@rajhawaldar](https://togithub.com/rajhawaldar) in [https://github.com/cli/cli/pull/7646](https://togithub.com/cli/cli/pull/7646) - Feature: Add `fill-first` flag to `pr create` command by [@kousikmitra](https://togithub.com/kousikmitra) in [https://github.com/cli/cli/pull/7398](https://togithub.com/cli/cli/pull/7398) - Return error on no-browser option if repo don't exists by [@kousikmitra](https://togithub.com/kousikmitra) in [https://github.com/cli/cli/pull/7314](https://togithub.com/cli/cli/pull/7314) #### Bugfixes - Early exit repo sync if merge-upstream requires workflow scope by [@williammartin](https://togithub.com/williammartin) in [https://github.com/cli/cli/pull/7612](https://togithub.com/cli/cli/pull/7612) - Don't deduplicate checks that stem from different events by [@samcoe](https://togithub.com/samcoe) in [https://github.com/cli/cli/pull/7618](https://togithub.com/cli/cli/pull/7618) - gh run cancel needs input validation by [@rajhawaldar](https://togithub.com/rajhawaldar) in [https://github.com/cli/cli/pull/7647](https://togithub.com/cli/cli/pull/7647) - Ensure gist edit request body matches desired schema by [@williammartin](https://togithub.com/williammartin) in [https://github.com/cli/cli/pull/7635](https://togithub.com/cli/cli/pull/7635) - fix(api): do not interpret "branch" placeholder when `GH_REPO` is set by [@alex-petrov-vt](https://togithub.com/alex-petrov-vt) in [https://github.com/cli/cli/pull/7626](https://togithub.com/cli/cli/pull/7626) - fix pr create crash on interactive milestone selection by [@vilmibm](https://togithub.com/vilmibm) in [https://github.com/cli/cli/pull/7666](https://togithub.com/cli/cli/pull/7666) - Fix issue develop command by [@samcoe](https://togithub.com/samcoe) in [https://github.com/cli/cli/pull/7656](https://togithub.com/cli/cli/pull/7656) #### Docs & Dev - docs: example of setting multiple vars using stdin by [@iloveitaly](https://togithub.com/iloveitaly) in [https://github.com/cli/cli/pull/7683](https://togithub.com/cli/cli/pull/7683) - Remove old code paths and improve code comments for `repo sync` by [@samcoe](https://togithub.com/samcoe) in [https://github.com/cli/cli/pull/7610](https://togithub.com/cli/cli/pull/7610) - Add tenancy support by [@samcoe](https://togithub.com/samcoe) in [https://github.com/cli/cli/pull/7636](https://togithub.com/cli/cli/pull/7636) - Update httpretty to released version by [@josebalius](https://togithub.com/josebalius) in [https://github.com/cli/cli/pull/7654](https://togithub.com/cli/cli/pull/7654) - build(deps): bump github.com/henvic/httpretty from 0.1.1 to 0.1.2 by [@dependabot](https://togithub.com/dependabot) in [https://github.com/cli/cli/pull/7657](https://togithub.com/cli/cli/pull/7657) - build(deps): bump google.golang.org/grpc from 1.49.0 to 1.53.0 by [@dependabot](https://togithub.com/dependabot) in [https://github.com/cli/cli/pull/7665](https://togithub.com/cli/cli/pull/7665) - Use SmartBaseRepoFunc for api command by [@whi-tw](https://togithub.com/whi-tw) in [https://github.com/cli/cli/pull/7594](https://togithub.com/cli/cli/pull/7594) - Clean up style nits and simplify some logic by [@samcoe](https://togithub.com/samcoe) in [https://github.com/cli/cli/pull/7687](https://togithub.com/cli/cli/pull/7687) - add gh cache to Actions explainer by [@vilmibm](https://togithub.com/vilmibm) in [https://github.com/cli/cli/pull/7689](https://togithub.com/cli/cli/pull/7689) #### New Contributors - [@leavesster](https://togithub.com/leavesster) made their first contribution in [https://github.com/cli/cli/pull/7330](https://togithub.com/cli/cli/pull/7330) - [@kamaz](https://togithub.com/kamaz) made their first contribution in [https://github.com/cli/cli/pull/7621](https://togithub.com/cli/cli/pull/7621) - [@shion1305](https://togithub.com/shion1305) made their first contribution in [https://github.com/cli/cli/pull/7589](https://togithub.com/cli/cli/pull/7589) - [@jgrumboe](https://togithub.com/jgrumboe) made their first contribution in [https://github.com/cli/cli/pull/7451](https://togithub.com/cli/cli/pull/7451) - [@whi-tw](https://togithub.com/whi-tw) made their first contribution in [https://github.com/cli/cli/pull/7594](https://togithub.com/cli/cli/pull/7594) - [@seanbright](https://togithub.com/seanbright) made their first contribution in [https://github.com/cli/cli/pull/7645](https://togithub.com/cli/cli/pull/7645) - [@iloveitaly](https://togithub.com/iloveitaly) made their first contribution in [https://github.com/cli/cli/pull/7683](https://togithub.com/cli/cli/pull/7683) **Full Changelog**: cli/cli@v2.31.0...v2.32.0 </details> <details> <summary>fluxcd/flux2 (fluxcd/flux2)</summary> ### [`v2.0.1`](https://togithub.com/fluxcd/flux2/releases/tag/v2.0.1) [Compare Source](https://togithub.com/fluxcd/flux2/compare/v2.0.0...v2.0.1) #### Highlights Flux `v2.0.1` is a patch release which comes with various fixes. Users are encouraged to upgrade for the best experience. :bulb: For upgrading from Flux `v0.x`, please see [the procedure documented in 2.0.0](https://togithub.com/fluxcd/flux2/releases/tag/v2.0.0). ##### Fixes - Fix AWS auth for cross-region ECR repositories (`source-controller`, `image-reflector-controller`). - Prevent spurious alerts for skipped resources (`kustomize-controller`). - List removed resources for `flux diff ks --kustomization-file` (`flux` CLI). - Fix SLSA provenance generation for the Flux CLI binaries. #### Components changelog - source-controller [v1.0.1](https://togithub.com/fluxcd/source-controller/blob/v1.0.1/CHANGELOG.md) - kustomize-controller [v1.0.1](https://togithub.com/fluxcd/kustomize-controller/blob/v1.0.1/CHANGELOG.md) - image-reflector-controller [v0.29.1](https://togithub.com/fluxcd/image-reflector-controller/blob/v0.29.1/CHANGELOG.md) #### CLI Changelog - PR [#4068](https://togithub.com/fluxcd/flux2/issues/4068) - [@stefanprodan](https://togithub.com/stefanprodan) - Update dependencies - PR [#4065](https://togithub.com/fluxcd/flux2/issues/4065) - [@hiddeco](https://togithub.com/hiddeco) - action: support `openssl` and `sha256sum` - PR [#4062](https://togithub.com/fluxcd/flux2/issues/4062) - [@souleb](https://togithub.com/souleb) - diff: Take into account the server-side inventory for local Flux Kustomizations - PR [#4061](https://togithub.com/fluxcd/flux2/issues/4061) - [@hiddeco](https://togithub.com/hiddeco) - action: re-allow configuration of non-default token - PR [#4057](https://togithub.com/fluxcd/flux2/issues/4057) - [@fluxcdbot](https://togithub.com/fluxcdbot) - Update toolkit components - PR [#4052](https://togithub.com/fluxcd/flux2/issues/4052) - [@stefanprodan](https://togithub.com/stefanprodan) - docs: Link to the Flux GitHub Action documentation - PR [#4051](https://togithub.com/fluxcd/flux2/issues/4051) - [@hiddeco](https://togithub.com/hiddeco) - action: use `$RUNNER_TOOL_CACHE`, support MacOS and Windows, validate checksum - PR [#4046](https://togithub.com/fluxcd/flux2/issues/4046) - [@stefanprodan](https://togithub.com/stefanprodan) - ci: backport: set write permissions - PR [#4043](https://togithub.com/fluxcd/flux2/issues/4043) - [@stefanprodan](https://togithub.com/stefanprodan) - ci: release: extract the image tag from GITHUB_REF - PR [#4041](https://togithub.com/fluxcd/flux2/issues/4041) - [@hiddeco](https://togithub.com/hiddeco) - ci: release: disable interpretation backslash esc #### New Documentation - [Flux GitHub Action](https://fluxcd.io/flux/flux-gh-action/) - [SLSA provenance verification](https://fluxcd.io/flux/security/slsa-assessment/#provenance-verification) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 👻 **Immortal**: This PR will be recreated if closed unmerged. Get [config help](https://togithub.com/renovatebot/renovate/discussions) if that's undesired. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/scottames/dots).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

Donrebictips · 2023-07-12T07:14:28Z

TAP TO JOIN THE CHANNEL NOW #7620 Clink to join the channel

@probablycorey @cliAutomation @williammartin

kousikmitra requested a review from a team as a code owner June 10, 2023 10:55

kousikmitra requested review from vilmibm and removed request for a team June 10, 2023 10:55

cliAutomation added the external pull request originating outside of the CLI core team label Jun 10, 2023

williammartin requested changes Jun 22, 2023

View reviewed changes

pkg/cmd/gist/edit/edit_test.go Show resolved Hide resolved

pkg/cmd/gist/edit/edit.go Outdated Show resolved Hide resolved

pkg/cmd/gist/edit/edit.go Outdated Show resolved Hide resolved

pkg/cmd/gist/edit/edit.go Outdated Show resolved Hide resolved

williammartin reviewed Jun 22, 2023

View reviewed changes

pkg/cmd/gist/edit/edit_test.go Outdated Show resolved Hide resolved

kousikmitra force-pushed the feature/gist-file-remove branch 2 times, most recently from d796887 to 87c9800 Compare June 22, 2023 18:33

williammartin approved these changes Jun 23, 2023

View reviewed changes

kousikmitra added 5 commits June 23, 2023 17:21

Add option to remove file from gist

6dfc04d

Throw error if remove-file option is combined with other options

8fac2d1

Rename remove-file to remove

f5ca026

Refactor remove file function

f195f6c

Add testcases for checking mutual exclusive flags

6a52418

kousikmitra force-pushed the feature/gist-file-remove branch from 87c9800 to 6a52418 Compare June 23, 2023 11:51

williammartin merged commit baba894 into cli:trunk Jun 23, 2023

kousikmitra deleted the feature/gist-file-remove branch June 23, 2023 12:08

williammartin mentioned this pull request Jun 23, 2023

Delete files in gists #7517

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add option to remove file from gist #7560

Add option to remove file from gist #7560

Uh oh!

kousikmitra commented Jun 10, 2023

Uh oh!

williammartin left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kousikmitra commented Jun 22, 2023

Uh oh!

williammartin commented Jun 22, 2023

Uh oh!

Uh oh!

williammartin left a comment •

edited

Loading

Uh oh!

kousikmitra commented Jun 23, 2023 •

edited

Loading

Uh oh!

williammartin commented Jun 23, 2023

Uh oh!

Donrebictips commented Jul 12, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Add option to remove file from gist #7560

Add option to remove file from gist #7560

Uh oh!

Conversation

kousikmitra commented Jun 10, 2023

Uh oh!

williammartin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kousikmitra commented Jun 22, 2023

Uh oh!

williammartin commented Jun 22, 2023

Uh oh!

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

Uh oh!

kousikmitra commented Jun 23, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

williammartin commented Jun 23, 2023

Uh oh!

Donrebictips commented Jul 12, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

williammartin left a comment •

edited

Loading

kousikmitra commented Jun 23, 2023 •

edited

Loading