Skip to content

chore: update help doc with OCI layout support#997

Merged
shizhMSFT merged 5 commits into
oras-project:mainfrom
qweeah:oci-help
Jul 3, 2023
Merged

chore: update help doc with OCI layout support#997
shizhMSFT merged 5 commits into
oras-project:mainfrom
qweeah:oci-help

Conversation

@qweeah

@qweeah qweeah commented Jun 29, 2023

Copy link
Copy Markdown
Contributor

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?

@qweeah
chore: update help doc with OCI layout support
88333e8 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah

qweeah commented Jun 29, 2023

Copy link
Copy Markdown
Contributor Author

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

@codecov-commenter

codecov-commenter commented Jun 29, 2023 •
edited
Loading

Copy link
Copy Markdown

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

shizhMSFT
shizhMSFT reviewed Jun 29, 2023
View reviewed changes
Comment thread cmd/oras/root/pull.go Outdated
FeynmanZhou
FeynmanZhou reviewed Jun 29, 2023
View reviewed changes
Comment thread cmd/oras/root/blob/fetch.go Outdated
FeynmanZhou
FeynmanZhou reviewed Jun 29, 2023
View reviewed changes

@FeynmanZhou FeynmanZhou left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Just a tiny suggestion.

qweeah added 3 commits June 29, 2023 15:17
@qweeah
correct description
9d1da64 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
change naming to OCI image layout
5f83210 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
unify naming
cca8376 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah

qweeah commented Jun 30, 2023

Copy link
Copy Markdown
Contributor Author

Just a tiny suggestion.

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

TerryHowe
TerryHowe approved these changes Jul 1, 2023
View reviewed changes

@TerryHowe TerryHowe left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

/lgtm

shizhMSFT
shizhMSFT approved these changes Jul 3, 2023
View reviewed changes

@shizhMSFT shizhMSFT left a comment

Copy link
Copy Markdown
Contributor

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
This was referenced Jul 5, 2023
Closed
Merged
shizhMSFT pushed a commit to shizhMSFT/oras that referenced this pull request Aug 3, 2023
@qweeah @shizhMSFT
chore: update help doc with OCI layout support (oras-project#997)
9f3cc75 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@ZhongRuoyu ZhongRuoyu mentioned this pull request Aug 7, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@FeynmanZhou FeynmanZhou FeynmanZhou left review comments

@TerryHowe TerryHowe TerryHowe approved these changes

@shizhMSFT shizhMSFT shizhMSFT approved these changes

@sajayantony sajayantony Awaiting requested review from sajayantony sajayantony is a code owner

@SteveLasker SteveLasker Awaiting requested review from SteveLasker

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

add OCI layout support in command help doc

5 participants

@qweeah @codecov-commenter @TerryHowe @shizhMSFT @FeynmanZhou