-
Notifications
You must be signed in to change notification settings - Fork 192
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: improve formatted output for oras discover #1625
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1625 +/- ##
=======================================
Coverage 84.52% 84.52%
=======================================
Files 126 126
Lines 5681 5681
=======================================
Hits 4802 4802
Misses 625 625
Partials 254 254 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Based on the community discussion on Feb 18, @oras-project/oras-cli ORAS maintainers agreed on these things:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
PR Overview
This PR enhances the documentation for the formatted output of the oras discover command, aiming to clearly present both the subject image and its associated referrers' manifests in tree view and JSON output formats.
- Clarifies the description of the referrers' manifest output.
- Adds examples for recursive tree view and pretty JSON output.
- Updates field descriptions in the formatted output documentation.
Reviewed Changes
File | Description |
---|---|
docs/proposals/formatted-output.md | Updates and additions to improve clarity and formatting for oras discover output |
Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
PR Overview
This PR improves the formatted output for oras discover by updating field names and adding recursive output examples and a new depth flag.
- Renames the "manifests" field to "referrers" for consistency.
- Adds detailed examples for JSON, tree, and table outputs with recursive referrers.
- Introduces the --depth flag to control the recursion depth of referrers.
Reviewed Changes
File | Description |
---|---|
docs/proposals/formatted-output.md | Updates documentation to improve output format examples and details |
Copilot reviewed 1 out of 1 changed files in this pull request and generated no comments.
Based on the offline discussion on March 7, the following conclusions have been reached:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The current unresolved comments should be addressed, but generally looks good
748d717
to
bd0f04e
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM with nit
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/lgtm
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
e8be316
to
480ebd5
Compare
321d63d
to
f2e73e7
Compare
Signed-off-by: feynmanzhou <[email protected]>
Signed-off-by: feynmanzhou <[email protected]>
Signed-off-by: Feynman Zhou <[email protected]>
Signed-off-by: Feynman Zhou <[email protected]>
Signed-off-by: Feynman Zhou <[email protected]>
Signed-off-by: Feynman Zhou <[email protected]>
Signed-off-by: Feynman Zhou <[email protected]>
Signed-off-by: Feynman Zhou <[email protected]>
Signed-off-by: Feynman Zhou <[email protected]>
Signed-off-by: Feynman Zhou <[email protected]>
Signed-off-by: Feynman Zhou <[email protected]>
Signed-off-by: Feynman Zhou <[email protected]>
f2e73e7
to
b9b6679
Compare
Hi @oras-project/oras-cli , I've rebased the branch. Now it should be ready to merge. Thanks. |
Signed-off-by: Feynman Zhou <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
What this PR does / why we need it:
This PR improves formatted output for
oras discover
. For example, if the referrers have associated referrers, ORAS should enable users to show the manifest content of the subject image and all referrers in multiple formats.Which issue(s) this PR fixes (optional, in
fixes #<issue number>(, fixes #<issue_number>, ...)
format, will close the issue(s) when PR gets merged):Fixes #1403
Please check the following list: