docs: add Long description and examples to key subcommands#1351
Open
ogulcanaydogan wants to merge 1 commit into
Open
docs: add Long description and examples to key subcommands#1351ogulcanaydogan wants to merge 1 commit into
ogulcanaydogan 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.
Comment on lines
+92
to
+99
| 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:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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