-
Notifications
You must be signed in to change notification settings - Fork 64
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
docs: Create BREAKING_CHANGE_AND_DEPRECATION.md #1399
Merged
susanshi
merged 10 commits into
ratify-project:dev
from
susanshi:susanshi-breakingChange
May 9, 2024
Merged
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
f1f8aa9
Create BREAKING_CHANGE_AND_DEPRECATION.md
susanshi 384e297
Merge branch 'dev' into susanshi-breakingChange
susanshi da35fbd
adding k8 policy reference
susanshi 19bf3d2
semantic versioning
susanshi e64dc20
Merge branch 'susanshi-breakingChange' of https://github.com/susanshi…
susanshi f4a3a8f
update policy around beta
susanshi 5d036ee
Merge branch 'dev' into susanshi-breakingChange
susanshi 1356a77
Merge branch 'dev' into susanshi-breakingChange
akashsinghal 9bd423f
Merge branch 'dev' into susanshi-breakingChange
binbin-li bb3e9cf
Merge branch 'dev' into susanshi-breakingChange
akashsinghal File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
# Breaking changes and deprecations | ||
|
||
Breaking changes are defined as a change to any of the following that causes installation errors or | ||
unexpected runtime behavior after upgrading to the next stable minor version of Ratify: | ||
- Verification API | ||
- Verification result and schema | ||
- Default configuration value | ||
- User facing plugin interfaces | ||
|
||
## Stability levels | ||
- Generally available features should not be removed from that version or have its behavior significantly changed to avoid breaking existing users. | ||
- Beta or pre-release versions may introduce breaking changes without deprecation notice. | ||
- Alpha or experimental API versions may change in runtime behaviour without prior change and deprecation notice. | ||
|
||
The following features are currently in experimental: | ||
- [Dynamic plugin](https://ratify.dev/docs/reference/dynamic-plugins) | ||
- [High Availability](https://ratify.dev/docs/quickstarts/ratify-high-availability) | ||
|
||
## Process for applying breaking changes | ||
- A deprecation notice must be posted as part of a release. | ||
- The PR containing the breaking changes should contain a "!" to indicate this is breaking change. E.g. feat! , fix! | ||
- Breaking changes should be listed before new features in the release notes | ||
- Create a issue to help customer to mitigate the change | ||
|
||
## Deprecations | ||
Deprecations can apply to: | ||
susanshi marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- CRDs | ||
- Experimental Features | ||
- Plugins | ||
- User facing Interfaces | ||
- Configuration Values | ||
- Cli Usage and Configuration | ||
- Verification Schema | ||
|
||
susanshi marked this conversation as resolved.
Show resolved
Hide resolved
|
||
## Process for deprecation | ||
|
||
- A deprecation notice must be posted as part of the release notes. | ||
- Documentation should mark the feature as deprecated and redirect user to the alternative implementation. | ||
|
||
## Attribution | ||
|
||
The specification release process was created using content and verbiage from the following specifications: | ||
- [Kubernetes Deprecation Policy](https://kubernetes.io/docs/reference/using-api/deprecation-policy/) | ||
- [Dapr reference](https://docs.dapr.io/operations/support/breaking-changes-and-deprecations/) | ||
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is this issue for helping customers migrate to the breaking change?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
note: the mitigation steps must be available at the time of release