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

doc: add feature marks to cmd description and log #865

Merged
merged 13 commits into from
Mar 9, 2023

Conversation

qweeah
Copy link
Contributor

@qweeah qweeah commented Mar 8, 2023

What this PR does / why we need it:
This PR updates feature marks to commands and features as summarized below:

  1. stable commands need to remove preview mark
  • oras blob
    • oras blob fetch
    • oras blob delete
    • oras blob push
  • oras manifest
    • oras manifest fetch
    • oras manifest fetch-config
    • oras manifest delete
    • oras manifest push
  • oras repo
    • oras repo ls
    • oras repo tags
  • oras cp
  1. preview commands
  • oras attach, oras discover: since the command always involves referrer API change, GA requires distribution-spec v1.1 release
  1. experimental commands
    none

  2. preview features

  • --distribution-spec: oci distribution spec v1.1 is not released
  • oras pull --include-subject: image with subject will be defined in oci image-spec v1.1
  • oras cp --recursive: recursively upward lookup for referrers requires referrer API in oci distribution spec v1.1
  • oras repo tags --exclude-digest-tags: it uses the tag scheme as fallback referrers API fallback and defined in oci distribution spec v1.1
  1. experimental features
  • --image-spec: uses artifact manifest
  • oras repo tags: should print experimental hint when using associated tag/digest querying

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

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 qweeah changed the title Feature mark doc: add feature marks to cmd description and log Mar 8, 2023
@yizha1
Copy link

yizha1 commented Mar 8, 2023

@qweeah Are there any flags for oras repo tags: print when using associated tag/digest querying?

@qweeah
Copy link
Contributor Author

qweeah commented Mar 8, 2023

@qweeah Are there any flags for oras repo tags: print when using associated tag/digest querying?

No, there is no flag. But when used, there will be a log output saying it's an experimental feature in verbose mode.

@codecov-commenter
Copy link

codecov-commenter commented Mar 8, 2023

Codecov Report

Merging #865 (9296eaa) into main (03bc2b2) will not change coverage.
The diff coverage is 0.00%.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

@@           Coverage Diff           @@
##             main     #865   +/-   ##
=======================================
  Coverage   66.39%   66.39%           
=======================================
  Files          21       21           
  Lines         860      860           
=======================================
  Hits          571      571           
  Misses        243      243           
  Partials       46       46           
Impacted Files Coverage Δ
cmd/oras/internal/option/spec.go 18.51% <0.00%> (ø)
cmd/oras/internal/option/target.go 18.75% <0.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

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

test/e2e/suite/command/attach.go Outdated Show resolved Hide resolved
@yizha1
Copy link

yizha1 commented Mar 8, 2023

LGTM but IANAM

@FeynmanZhou
Copy link
Member

@qweeah What's the reason for making the following three commands to Preview status in v1.0.0?

oras pull --include-subject
oras cp --recursive
oras repo tags --exclude-digest-tags

@qweeah
Copy link
Contributor Author

qweeah commented Mar 8, 2023

@qweeah What's the reason for making the following three commands to Preview status in v1.0.0?

oras pull --include-subject # image with subject will be defined in oci image-spec v1.1
oras cp --recursive # recursively upward lookup for referrers requires referrer API in oci distribution spec v1.1
oras repo tags --exclude-digest-tags # uses the tag scheme fallback defined in oci distribution spec v1.1

Basically, because the underlying specs are not released. Commented inline.

@FeynmanZhou
Copy link
Member

Make sense. Agree with the changes above.

cmd/oras/internal/option/target.go Outdated Show resolved Hide resolved
cmd/oras/repo/tags.go Show resolved Hide resolved
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

qweeah added 12 commits March 9, 2023 19:44
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@shizhMSFT shizhMSFT merged commit e539375 into oras-project:main Mar 9, 2023
@qweeah qweeah mentioned this pull request Mar 17, 2023
5 tasks
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 feature marks in command docs and examples
6 participants