chore(login): improve --password flag description with security guidance#855
chore(login): improve --password flag description with security guidance#855gcharpe1604 wants to merge 1 commit into
Conversation
qcserestipy
left a comment
There was a problem hiding this comment.
Thanks for the contribution! Adding the docs is nice. However, this PR also introduces changes to the short flag of the cli login context-name. Please update the PR description to also cover this point.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #855 +/- ##
=========================================
- Coverage 10.99% 8.80% -2.19%
=========================================
Files 173 280 +107
Lines 8671 13965 +5294
=========================================
+ Hits 953 1230 +277
- Misses 7612 12618 +5006
- Partials 106 117 +11 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
ec97a1f to
191a17e
Compare
|
Hi @qcserestipy, thanks for the review! |
51045f0 to
ae8ccd2
Compare
qcserestipy
left a comment
There was a problem hiding this comment.
LGTM, however cmd.MarkFlagsMutuallyExclusive("password", "password-stdin") is there now twice.
Signed-off-by: Govind Charpe <govind.charpe16@gmail.com>
ae8ccd2 to
94031ed
Compare
|
@qcserestipy Thank you for the review! Let me know if there's anything else needed or if this is good to go! |
qcserestipy
left a comment
There was a problem hiding this comment.
LGTM, thank you for your contribution!
|
@qcserestipy Thank you for reviewing and approving the PR!! |
Description
The
--password/-pflag inharbor loginhad a minimal description (Password) that gave users no indication of the shell history security risk. Updated the description to guide users toward the safer--password-stdinalternative, following the same convention used bydocker login.Type of Change
Changes
--passwordflag description incmd/harbor/root/login.goto warn about shell history exposure and recommend--password-stdin-nshort flag for--context-nameinharbor logincommanddoc/cli-docs/harbor-login.mdto reflect the new flag description and the new-nshort flagdoc/man-docs/man1/harbor-login.1to reflect the new flag description and the new-nshort flagTesting
$ harbor login --help