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

chore: update help doc with OCI layout support #997

Merged
merged 5 commits into from
Jul 3, 2023

Conversation

qweeah
Copy link
Contributor

@qweeah qweeah commented Jun 29, 2023

What this PR does / why we need it:
This PR mentioned OCI layout support in related command help doc.

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

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?

Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
Copy link
Contributor Author

qweeah commented Jun 29, 2023

@FeynmanZhou Can you help review the wording in the updated help doc, thanks

@codecov-commenter
Copy link

codecov-commenter commented Jun 29, 2023

Codecov Report

Merging #997 (04f8eb2) into main (f9aec91) will not change coverage.
The diff coverage is 100.00%.

❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

@@           Coverage Diff           @@
##             main     #997   +/-   ##
=======================================
  Coverage   81.08%   81.08%           
=======================================
  Files          53       53           
  Lines        2792     2792           
=======================================
  Hits         2264     2264           
  Misses        358      358           
  Partials      170      170           
Impacted Files Coverage Δ
cmd/oras/root/attach.go 82.50% <100.00%> (ø)
cmd/oras/root/blob/fetch.go 68.26% <100.00%> (ø)
cmd/oras/root/blob/push.go 83.69% <100.00%> (ø)
cmd/oras/root/cp.go 86.36% <100.00%> (ø)
cmd/oras/root/discover.go 85.21% <100.00%> (ø)
cmd/oras/root/manifest/fetch.go 79.56% <100.00%> (ø)
cmd/oras/root/manifest/fetch_config.go 76.59% <100.00%> (ø)
cmd/oras/root/manifest/push.go 72.86% <100.00%> (ø)
cmd/oras/root/pull.go 73.62% <100.00%> (ø)
cmd/oras/root/push.go 73.83% <100.00%> (ø)
... and 2 more

cmd/oras/root/pull.go Outdated Show resolved Hide resolved
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.

Just a tiny suggestion.

Signed-off-by: Billy Zha <jinzha1@microsoft.com>
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
Copy link
Contributor Author

qweeah commented Jun 30, 2023

Just a tiny suggestion.

Resolved. @FeynmanZhou Worth mentioning that the naming of the flag is still using OCI layout, e.g. --from-oci-layout

Copy link
Member

@TerryHowe TerryHowe left a comment

Choose a reason for hiding this comment

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

/lgtm

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 ef743de into oras-project:main Jul 3, 2023
shizhMSFT pushed a commit to shizhMSFT/oras that referenced this pull request Aug 3, 2023
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
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 OCI layout support in command help doc
5 participants