doc: add examples in CLI help doc for notation sign and verify #384
Merged
shizhMSFT merged 15 commits intonotaryproject:mainfrom Oct 14, 2022
Merged
doc: add examples in CLI help doc for notation sign and verify #384shizhMSFT merged 15 commits intonotaryproject:mainfrom
shizhMSFT merged 15 commits intonotaryproject:mainfrom
Conversation
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
FeynmanZhou
requested review from
SteveLasker,
dtzar,
gokarnm,
iamsamirzon,
priteshbandi,
shizhMSFT and
yizha1
iamsamirzon
reviewed
Oct 12, 2022
dtzar
approved these changes
Oct 12, 2022
yizha1
reviewed
Oct 13, 2022
yizha1
reviewed
Oct 13, 2022
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
shizhMSFT
reviewed
Oct 13, 2022
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
FeynmanZhou
added
documentation
dtzar
approved these changes
Oct 13, 2022
priteshbandi
approved these changes
Oct 14, 2022
Contributor
priteshbandi
left a comment
priteshbandi
left a comment
There was a problem hiding this comment.
LGTM, we will update this command again in RC1
shizhMSFT
requested changes
Oct 14, 2022
cmd/notation/sign.go
Outdated
Comment on lines
+38
to
+39
| Long: ` | ||
| Prerequiste: a signing key needs to be configured using the command "notation key". |
Contributor
There was a problem hiding this comment.
Could you add a title for the help command? Otherwise, it will show
$ ./notation sign --help
Prerequiste: a signing key needs to be configured using the command "notation key".
Example - Sign a container image using the default signing key, with the default JWS envelope:
notation sign <registry>/<repository>:<tag>
...
Member
Author
There was a problem hiding this comment.
@shizhMSFT Good catch. Fixed.
Just be aware of the value in the Short field will be omitted when defines a Long field.
The current CLI help UX for notation sign:
./notation sign --help
Sign OCI artifacts
Prerequisite: a signing key needs to be configured using the command "notation key".
Example - Sign a container image using the default signing key, with the default JWS envelope:
notation sign <registry>/<repository>:<tag>
Example - Sign a container image using the default signing key, with the COSE envelope:
notation sign --envelope-type cose <registry>/<repository>:<tag>
Example - Sign a container image using the specified key name
notation sign --key <key_name> <registry>/<repository>:<tag>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Codecov Report
@@ Coverage Diff @@
## main #384 +/- ##
==========================================
+ Coverage 30.70% 32.03% +1.32%
==========================================
Files 26 26
Lines 1638 1670 +32
==========================================
+ Hits 503 535 +32
Misses 1122 1122
Partials 13 13
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
7h3-3mp7y-m4n
pushed a commit
to 7h3-3mp7y-m4n/notation
that referenced
this pull request
Mar 29, 2025
…yproject#384) fix notaryproject#383 Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
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
7 participants
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.
fix #383