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

Define feature mark behavior for [Experimental] and [Preview] #199

Open
1 task
FeynmanZhou opened this issue Apr 11, 2023 · 2 comments
Open
1 task

Define feature mark behavior for [Experimental] and [Preview] #199

FeynmanZhou opened this issue Apr 11, 2023 · 2 comments
Assignees
Labels
enhancement New feature or request

Comments

@FeynmanZhou
Copy link
Member

FeynmanZhou commented Apr 11, 2023

What is the version of your ORAS CLI

v1.0.0

What would you like to be added?

ORAS has introduced three feature marks to divide the CLI command feature maturity into three stages:

  • Experimental: This feature can radically change or completely disappear at any time. It may be in development but for the early trial. It's not recommended to use it in production; It may introduce breaking changes in the future. It requires setting an environmental variable to enable the experimental feature. It should have a warning message to remind users. Recommended for use only in short-lived testing clusters, due to increased risk of bugs and lack of long-term support.

  • Preview: This feature development is almost done and is closing to stable. It is visible to all users by default with [Preview] feature mark and can be used without any additional settings. But it's recommended for only non-business-critical uses because of potential for incompatible changes in subsequent releases.

  • Stable: This feature is mature and should be always enabled; The corresponding feature mark is no longer needed. Stable versions of features will appear in released software for many subsequent versions.

Why is this needed for ORAS?

Provide flexibility for new features that are still in progress and gather feedback from early adopters. Popular project like Kubernetes has its feature gate as a reference for users: https://kubernetes.io/docs/reference/command-line-tools-reference/feature-gates/#feature-stages

Are you willing to submit PRs to contribute to this feature?

  • Yes, I am willing to implement it.
@FeynmanZhou FeynmanZhou added the enhancement New feature or request label Apr 11, 2023
@FeynmanZhou FeynmanZhou changed the title Define feature mark behavior for [Experimental], [Preview] Define feature mark behavior for [Experimental] and [Preview] Apr 11, 2023
@qweeah
Copy link
Contributor

qweeah commented Apr 12, 2023

Sounds good! Should also emphasize that the preview feature is still subject to change. Also need to document this somehow.

@FeynmanZhou
Copy link
Member Author

FeynmanZhou commented Apr 13, 2023

@qweeah Yes. we need to write a document to explain these two feature marks.

@shizhMSFT shizhMSFT transferred this issue from oras-project/oras Jun 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants