Skip to content
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: add examples for --format #1497

Merged
merged 3 commits into from
Sep 10, 2024

Conversation

wangxiaoxuan273
Copy link
Contributor

What this PR does / why we need it:

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 #1422

Please check the following list:

  • Does the affected code have corresponding tests, e.g. unit test, E2E test?
  • Does this change require a documentation update?
  • Does this introduce breaking changes that would require an announcement or bumping the major version?
  • Do all new files have an appropriate license header?

@wangxiaoxuan273 wangxiaoxuan273 changed the title doc: add examples for --format docs: add examples for --format Sep 9, 2024
Copy link

codecov bot commented Sep 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.78%. Comparing base (70ac79b) to head (f1d3060).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1497      +/-   ##
==========================================
+ Coverage   85.73%   85.78%   +0.05%     
==========================================
  Files         116      116              
  Lines        4044     4059      +15     
==========================================
+ Hits         3467     3482      +15     
  Misses        345      345              
  Partials      232      232              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Xiaoxuan Wang added 2 commits September 9, 2024 15:30
Signed-off-by: Xiaoxuan Wang <xiaoxuanwang@microsoft.com>
Signed-off-by: Xiaoxuan Wang <xiaoxuanwang@microsoft.com>
Copy link
Member

@FeynmanZhou FeynmanZhou left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM to add examples for --format to multiple oras commands. Thanks @wangxiaoxuan273

cmd/oras/root/attach.go Outdated Show resolved Hide resolved
cmd/oras/root/discover.go Outdated Show resolved Hide resolved
cmd/oras/root/manifest/fetch.go Outdated Show resolved Hide resolved
cmd/oras/root/pull.go Outdated Show resolved Hide resolved
Signed-off-by: Xiaoxuan Wang <xiaoxuanwang@microsoft.com>
Copy link
Contributor

@shizhMSFT shizhMSFT left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@shizhMSFT shizhMSFT merged commit d1fe4d0 into oras-project:main Sep 10, 2024
8 checks passed
@wangxiaoxuan273 wangxiaoxuan273 deleted the format-examples branch September 10, 2024 08:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add examples for the flag "--format"
3 participants