Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add examples to --help output for admin.go file #16030

Merged
merged 3 commits into from
Nov 2, 2023

Conversation

akagami-harsh
Copy link
Contributor

Signed-off-by: Harshvir Potpose <hpotpose62@gmail.com>
@akagami-harsh akagami-harsh requested review from a team as code owners October 19, 2023 07:47
@codecov
Copy link

codecov bot commented Oct 19, 2023

Codecov Report

Attention: 1 lines in your changes are missing coverage. Please review.

Comparison is base (51b4b20) 49.55% compared to head (a5bd7ec) 49.55%.
Report is 4 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master   #16030   +/-   ##
=======================================
  Coverage   49.55%   49.55%           
=======================================
  Files         269      269           
  Lines       46892    46892           
=======================================
  Hits        23237    23237           
  Misses      21374    21374           
  Partials     2281     2281           
Files Coverage Δ
cmd/argocd/commands/admin/admin.go 15.33% <ø> (ø)
cmd/argocd/commands/project.go 0.00% <0.00%> (ø)

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Signed-off-by: Harshvir Potpose <122517264+akagami-harsh@users.noreply.github.com>
@akagami-harsh akagami-harsh changed the title feat: add examples for --help in admin.go feat: add examples to --help output for admin.go file Oct 19, 2023
Copy link
Member

@ishitasequeira ishitasequeira left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@ishitasequeira ishitasequeira enabled auto-merge (squash) November 2, 2023 00:58
@ishitasequeira ishitasequeira merged commit 481cf81 into argoproj:master Nov 2, 2023
22 checks passed
jmilic1 pushed a commit to jmilic1/argo-cd that referenced this pull request Nov 13, 2023
* add examples to admin.go

Signed-off-by: Harshvir Potpose <hpotpose62@gmail.com>

* Update argocd_admin.md

Signed-off-by: Harshvir Potpose <122517264+akagami-harsh@users.noreply.github.com>

---------

Signed-off-by: Harshvir Potpose <hpotpose62@gmail.com>
Signed-off-by: Harshvir Potpose <122517264+akagami-harsh@users.noreply.github.com>
Signed-off-by: jmilic1 <70441727+jmilic1@users.noreply.github.com>
vladfr pushed a commit to vladfr/argo-cd that referenced this pull request Dec 13, 2023
* add examples to admin.go

Signed-off-by: Harshvir Potpose <hpotpose62@gmail.com>

* Update argocd_admin.md

Signed-off-by: Harshvir Potpose <122517264+akagami-harsh@users.noreply.github.com>

---------

Signed-off-by: Harshvir Potpose <hpotpose62@gmail.com>
Signed-off-by: Harshvir Potpose <122517264+akagami-harsh@users.noreply.github.com>
tesla59 pushed a commit to tesla59/argo-cd that referenced this pull request Dec 16, 2023
* add examples to admin.go

Signed-off-by: Harshvir Potpose <hpotpose62@gmail.com>

* Update argocd_admin.md

Signed-off-by: Harshvir Potpose <122517264+akagami-harsh@users.noreply.github.com>

---------

Signed-off-by: Harshvir Potpose <hpotpose62@gmail.com>
Signed-off-by: Harshvir Potpose <122517264+akagami-harsh@users.noreply.github.com>
lyda pushed a commit to lyda/argo-cd that referenced this pull request Mar 28, 2024
* add examples to admin.go

Signed-off-by: Harshvir Potpose <hpotpose62@gmail.com>

* Update argocd_admin.md

Signed-off-by: Harshvir Potpose <122517264+akagami-harsh@users.noreply.github.com>

---------

Signed-off-by: Harshvir Potpose <hpotpose62@gmail.com>
Signed-off-by: Harshvir Potpose <122517264+akagami-harsh@users.noreply.github.com>
Signed-off-by: Kevin Lyda <kevin@lyda.ie>
@ChristianCiach
Copy link
Contributor

ChristianCiach commented Apr 22, 2024

I am so confused by this PR... The examples advertise a bunch of commands that just don't exist.

For example:

argocd admin cluster list

The command argocd admin cluster has no subcommand list.

Similarly, there is no argocd admin cluster add, argocd admin cluster remove and so on. There isn't even a argocd admin project to call argocd admin project list on.

The same is true for many, many other examples added to argocd admin.

I also cannot find any references to the mentioned commands inside the source code.

I am using this version of the CLI, but as far as I can see, the commands mentioned in the examples of argocd admin didn't exist for a very long time (possibly ever):

$ argocd version
argocd: v2.10.7+b060053.dirty
  BuildDate: 2024-04-15T12:31:44Z
  GitCommit: b060053b099b4c81c1e635839a309c9c8c1863e9
  GitTreeState: dirty
  GoVersion: go1.22.2
  Compiler: gc
  Platform: linux/amd64
argocd-server: v2.10.7+b060053
  BuildDate: 2024-04-15T08:45:08Z
  GitCommit: b060053b099b4c81c1e635839a309c9c8c1863e9
  GitTreeState: clean
  GoVersion: go1.21.3
  Compiler: gc
  Platform: linux/amd64
  Kustomize Version: v5.2.1 2023-10-19T20:13:51Z
  Helm Version: v3.14.3+gf03cc04
  Kubectl Version: v0.26.11
  Jsonnet Version: v0.20.0

Really, I would probably suggest to completely revert the whole PR. At least 90% of the added examples are bogus. I am new to ArgoCD and the example make it hard for me to learn the CLI.

@akagami-harsh akagami-harsh deleted the add-examples branch April 22, 2024 09:21
@crenshaw-dev
Copy link
Member

@ChristianCiach I'm guessing this was just ChatGPT garbage then. I'll clean it up.

@crenshaw-dev
Copy link
Member

@akagami-harsh lmk if I'm wrong, but otherwise... yikes.

@crenshaw-dev
Copy link
Member

#17924

@akagami-harsh
Copy link
Contributor Author

@crenshaw-dev, omg i am so sorry 😔, i should have tested it before making a PR, deeply regret it now 😔. again i am so sowwy for the trouble i caused @ChristianCiach. I'm working on fixing the problem and will submit a follow-up PR as soon as possible. In the meantime, please let me know if there's anything I can do to help minimize any disruption this may have caused.

@crenshaw-dev
Copy link
Member

@akagami-harsh no worries, we cleaned it up. If you'd like to submit a PR adding docs for argocd admin commands that exist, I'd happily review.

Hariharasuthan99 pushed a commit to AmadeusITGroup/argo-cd that referenced this pull request Jun 16, 2024
* add examples to admin.go

Signed-off-by: Harshvir Potpose <hpotpose62@gmail.com>

* Update argocd_admin.md

Signed-off-by: Harshvir Potpose <122517264+akagami-harsh@users.noreply.github.com>

---------

Signed-off-by: Harshvir Potpose <hpotpose62@gmail.com>
Signed-off-by: Harshvir Potpose <122517264+akagami-harsh@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants