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(cli): adding gpg examples (#15690) #15844

Open
wants to merge 9 commits into
base: master
Choose a base branch
from

Conversation

gaurangkudale
Copy link
Contributor

adding logout examples for improvement #15690

Checklist:

  • Either (a) I've created an enhancement proposal and discussed it with the community, (b) this is a bug fix, or (c) this does not need to be in the release notes.
  • The title of the PR states what changed and the related issues number (used for the release note).
  • The title of the PR conforms to the Toolchain Guide
  • I've included "Closes [ISSUE #]" or "Fixes [ISSUE #]" in the description to automatically close the associated issue.
  • I've updated both the CLI and UI to expose my feature, or I plan to submit a second PR with them.
  • Does this PR require documentation updates?
  • I've updated documentation as required by this PR.
  • Optional. My organization is added to USERS.md.
  • I have signed off all my commits as required by DCO
  • I have written unit and/or e2e tests for my change. PRs without these are unlikely to be merged.
  • My build is green (troubleshooting builds).
  • My new feature complies with the feature status guidelines.
  • I have added a brief description of why this PR is necessary and/or what this PR solves.

@gaurangkudale gaurangkudale requested a review from a team as a code owner October 6, 2023 09:20
@gaurangkudale gaurangkudale changed the title adding gpg examples #15690 feat(cli): adding gpg examples #15690 Oct 6, 2023
@codecov
Copy link

codecov bot commented Oct 6, 2023

Codecov Report

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

Comparison is base (4f8c147) 49.56% compared to head (1446fc0) 49.54%.
Report is 3 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master   #15844      +/-   ##
==========================================
- Coverage   49.56%   49.54%   -0.02%     
==========================================
  Files         269      269              
  Lines       46668    46680      +12     
==========================================
- Hits        23131    23128       -3     
- Misses      21263    21277      +14     
- Partials     2274     2275       +1     
Files Coverage Δ
cmd/argocd/commands/gpg.go 0.00% <0.00%> (ø)

... and 2 files with indirect coverage changes

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

@gaurangkudale gaurangkudale requested a review from a team as a code owner October 6, 2023 10:50
@gaurangkudale
Copy link
Contributor Author

gaurangkudale commented Oct 6, 2023

I am not able to figure out why this check is failing https://github.com/argoproj/argo-cd/actions/runs/6430691978/job/17462132638?pr=15844
Can anyone please clear this for me?

@blakepettersson
Copy link
Member

Can anyone please clear this for me?

You should be able to either run make clidocsgen or alternatively you can modify docs/user-guide/commands/argocd_gpg_list.md, docs/user-guide/commands/argocd_gpg_rm.md etc to match the output in the failing task.

@gaurangkudale
Copy link
Contributor Author

Can anyone please clear this for me?

You should be able to either run make clidocsgen or alternatively you can modify docs/user-guide/commands/argocd_gpg_list.md, docs/user-guide/commands/argocd_gpg_rm.md etc to match the output in the failing task.

Thanks @blakepettersson For clearing this for me
I ran make clidocsgen cmd lets wait for check to pass

Comment on lines 14 to 16

# Add a GPG public key to the server's key
argocd gpg add --key <GPG_PUBLIC_KEY>
Copy link
Member

Choose a reason for hiding this comment

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

Could you either un-indent the string or use the templates.Examples function to correct indentation?

Copy link
Contributor Author

@gaurangkudale gaurangkudale Oct 6, 2023

Choose a reason for hiding this comment

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

Yes I have done the changes for all .md files

Copy link
Contributor Author

Choose a reason for hiding this comment

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

If I run make clidocsgen command then it is adding the un-indentation to the string
So is it necessary to run make clidocsgen in this case?

Copy link
Member

Choose a reason for hiding this comment

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

You have to remove the indentation in the .go files and then run make clidocsgen.

So,

		Example: `
# Remove a GPG public key from the server's key using its key ID 
argocd gpg rm <KEYID>
		`,

Looks weird, but it gets the job done :-)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Got it! Thanks for the suggestions
I hope all checks will pass now

@crenshaw-dev crenshaw-dev changed the title feat(cli): adding gpg examples #15690 feat(cli): adding gpg examples (#15690) Oct 6, 2023
Copy link
Member

@crenshaw-dev crenshaw-dev left a comment

Choose a reason for hiding this comment

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

Almost there! Can you un-indent the examples for all 4 commands?

@gaurangkudale
Copy link
Contributor Author

Almost there! Can you un-indent the examples for all 4 commands?

Is it okay if I do it manually because whenever I use make clidocsgen it is adding the spaces at the start of .md file
Screenshot 2023-10-07 at 11 19 03 AM

@gaurangkudale
Copy link
Contributor Author

@crenshaw-dev If I manually run maken clidocsgen cmd then Integration tests / Check changes to generated code (pull_request) check is failing
Trying to figure out the way to make it work

@gaurangkudale gaurangkudale force-pushed the app-example branch 4 times, most recently from 6b3e3d8 to 614a925 Compare October 19, 2023 17:50
@crenshaw-dev crenshaw-dev enabled auto-merge (squash) October 27, 2023 23:00
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.

@gaurangkudale please resolve the merge conflicts

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.

@gaurangkudale would you mind resolving conflicts?

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