spec: add CLI specs for notation list/login/logout/plugin#362
spec: add CLI specs for notation list/login/logout/plugin#362shizhMSFT merged 17 commits intonotaryproject:mainfrom
Conversation
Signed-off-by: Yi Zha <zhayi@outlook.com>
Signed-off-by: Yi Zha <zhayi@outlook.com>
Signed-off-by: Yi Zha <zhayi@outlook.com>
Signed-off-by: Yi Zha <zhayi@outlook.com>
yizha1
added
cli
yizha1
requested review from
FeynmanZhou,
binbin-li,
dtzar,
gokarnm,
patrickzheng200,
priteshbandi and
shizhMSFT
Codecov Report
@@ Coverage Diff @@
## main #362 +/- ##
==========================================
+ Coverage 30.54% 32.28% +1.74%
==========================================
Files 25 26 +1
Lines 1614 1623 +9
==========================================
+ Hits 493 524 +31
+ Misses 1108 1086 -22
Partials 13 13
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
Signed-off-by: Yi Zha <zhayi@outlook.com>
…into cli-other-specs
Signed-off-by: Yi Zha <zhayi@outlook.com>
specs/commandline/list.md
Outdated
| List all the signatures of signed artifacts | ||
|
|
||
| Usage: | ||
| notation list <reference> [flags] |
There was a problem hiding this comment.
This looks good, in review @priteshbandi brought up code use case of it handling an artifact which has a large number of signatures (i.e. via oras pagination). No change in spec per-se.
There was a problem hiding this comment.
IMO default behavior should be paginated as ORAS referrers API is paginated.
Not having pagination will result in an unnecessary load on servers when 1st returned item in the list is what the user wanted. Also, it's usually good practice to have a paginated list API.
There was a problem hiding this comment.
In Linux/Unix, less can be used for pagination (e.g. notation list $ref | less). Details of less can be found in man less.
Generally speaking, less will block the write pipeline and thus force notation stopping query the next link returned by the referrer API.
There was a problem hiding this comment.
IMO default behavior should be paginated as ORAS referrers API is paginated. Not having pagination will result in an unnecessary load on servers when 1st returned item in the list is what the user wanted. Also, it's usually good practice to have a paginated list API.
Maybe we can create another issue to address your comments. The implementation depends on the behavior of oras-go library. IMO, the current spec is good enough for rc.1 release.
|
Reviewed this as a group during community call today. Once this feedback is addressed, we can merge. |
specs/commandline/list.md
Outdated
| List all the signatures of signed artifacts | ||
|
|
||
| Usage: | ||
| notation list <reference> [flags] |
There was a problem hiding this comment.
IMO default behavior should be paginated as ORAS referrers API is paginated.
Not having pagination will result in an unnecessary load on servers when 1st returned item in the list is what the user wanted. Also, it's usually good practice to have a paginated list API.
Signed-off-by: Yi Zha <zhayi@outlook.com>
Signed-off-by: Yi Zha <zhayi@outlook.com>
Signed-off-by: Yi Zha <zhayi@outlook.com>
priteshbandi
left a comment
priteshbandi
left a comment
There was a problem hiding this comment.
LGTM with one feedback
vaninrao10
left a comment
vaninrao10
left a comment
There was a problem hiding this comment.
For notation login and logout, do we also outline how to login into multiple registries and logout from multiple registries. We discussed in one of the community call.
Yes, I have added support for multiple login |
Signed-off-by: Yi Zha <zhayi@outlook.com>
…ect#362) Signed-off-by: Yi Zha <zhayi@outlook.com>
…ect#362) Signed-off-by: Yi Zha <zhayi@outlook.com>
8 participants
No description provided.