docs: add Long description and examples to key subcommands#1351
docs: add Long description and examples to key subcommands#1351ogulcanaydogan wants to merge 1 commit into
Conversation
The four key subcommands (add, update, list, delete) had only a Short: description. Add Long: with usage examples to each, matching the style of other notation commands (backtick string, Example - <action>: prefix). Signed-off-by: Ogulcan Aydogan <ogulcanaydogan@hotmail.com>
ogulcanaydogan
requested review from
NiazFK,
gokarnm,
priteshbandi,
rgnote,
shizhMSFT,
toddysm,
vaninrao10 and
yizha1
as code owners
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Adds richer CLI help text for notation key subcommands by providing Long descriptions with concrete usage examples.
Changes:
- Add multi-line
Longhelp text forkey add - Add multi-line
Longhelp text forkey update,key list, andkey delete
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| Long: `Add a key to Notation signing key list. The key must be managed by a signing plugin. | ||
|
|
||
| Example - Add a key with a signing plugin: | ||
| notation key add --plugin <plugin_name> --id <key_id> <key_name> | ||
|
|
||
| Example - Add a key and set it as the default signing key: | ||
| notation key add --plugin <plugin_name> --id <key_id> --default <key_name> | ||
| `, |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1351 +/- ##
==========================================
+ Coverage 79.09% 79.24% +0.14%
==========================================
Files 68 68
Lines 3076 3098 +22
==========================================
+ Hits 2433 2455 +22
Misses 436 436
Partials 207 207 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
kunalworldwide
left a comment
kunalworldwide
left a comment
There was a problem hiding this comment.
Adding Long descriptions with usage examples to the key subcommands is a nice improvement — notation key add --help now shows concrete invocations instead of just the one-line Short.
One consistency note: key delete shows notation key delete <key_name> in the example, but the Use field accepts variadic args (<key_name>...). Might be worth showing a multi-key example too:
notation key delete <key_name_1> <key_name_2>
Otherwise LGTM — matches the pattern used in other notation subcommands.
The four
keysubcommands (add,update,list,delete) had only aShort:description. AddLong:with usage examples to each, following the style used by other notation commands.Files changed:
cmd/notation/key.go: addLong:tokeyAddCommand,keyUpdateCommand,keyListCommand,keyDeleteCommand