8000 [Doc] Define feature deprecation policy · Issue #460 · oras-project/oras-www · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

[Doc] Define feature deprecation policy #460

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

Open
FeynmanZhou opened this issue Mar 21, 2025 · 0 comments
Open

[Doc] Define feature deprecation policy #460

FeynmanZhou opened this issue Mar 21, 2025 · 0 comments

Comments

@FeynmanZhou
Copy link
Member

There is no formal deprecation policy defined in the ORAS community. Some flags/commands hide a deprecated flag immediately but some have explicit deprecated feature mark in the --help information. We may want to align on the deprecation policy and formalize the policies in the ORAS community. This should be a part of feature lifecycle management.

My suggstions:

  • Soft Deprecation First: When a flag or command is deprecated, show warnings in logs and help text in the current release. Suggest new commands or flags in the warning.
  • Gradual Removal: Keep deprecated features for multiple versions before removal.
  • Versioning & Breaking Changes: Use the major version upgrades for entire removals.
  • Document & Announcement: Clearly list deprecations in release notes and documentation. Announce it in the release blog post.

Linking to another corresponding issue: #199

@FeynmanZhou FeynmanZhou changed the title Define feature deprecation policy [Doc] Define feature deprecation policy Mar 21, 2025
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

No branches or pull requests

1 participant
0