docs: Create BREAKING_CHANGE_AND_DEPRECATION.md #1399
Merged
Conversation
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
Signed-off-by: Susan Shi <[email protected]>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## dev #1399 +/- ##
==========================================
+ Coverage 66.76% 68.16% +1.39%
==========================================
Files 116 119 +3
Lines 6030 6134 +104
==========================================
+ Hits 4026 4181 +155
+ Misses 1620 1559 -61
- Partials 384 394 +10 ☔ View full report in Codecov by Sentry. |
susanshi
commented
Apr 17, 2024
susanshi
commented
Apr 23, 2024
binbin-li
reviewed
Apr 23, 2024
| For example, feature X is announced to be deprecated in the 1.0.0 release notes and will then be removed in 1.2.0 | ||
| - 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 |
There was a problem hiding this comment.
is this issue for helping customers migrate to the breaking change?
There was a problem hiding this comment.
note: the mitigation steps must be available at the time of release
BREAKING_CHANGE_AND_DEPRECATION.md
Outdated
|
|
||
| We do our best to maintain backwards compatibility, however breaking changes may be introduced between version for features that have not yet reached v1.0.0 or only available in RATIFY_EXPERIMENTAL flag. | ||
|
|
||
| ### Features in Preview |
There was a problem hiding this comment.
do we only focus on breaking features or do we consider all new features?
There was a problem hiding this comment.
Features in EXPERIMENTAL , vs feature in beta
susanshi
requested review from
akashsinghal,
jimmyraywv,
luisdlp and
toddysm
as code owners
susanshi
commented
Apr 30, 2024
akashsinghal
approved these changes
May 5, 2024
akashsinghal
changed the title
|
lgtm, thanks for adding the doc! |
binbin-li
approved these changes
May 6, 2024
akashsinghal
added a commit
to akashsinghal/ratify
that referenced
this pull request
Sep 13, 2024
Signed-off-by: Susan Shi <[email protected]> Co-authored-by: Akash Singhal <[email protected]> Co-authored-by: Binbin Li <[email protected]> Signed-off-by: akashsinghal <[email protected]>
binbin-li
added a commit
to binbin-li/ratify
that referenced
this pull request
Sep 14, 2024
Signed-off-by: Susan Shi <[email protected]> Co-authored-by: Akash Singhal <[email protected]> Co-authored-by: Binbin Li <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
What this PR does / why we need it:
document process for breaking change and deprecation
Which issue(s) this PR fixes (optional, using
fixes #<issue number>(, fixes #<issue_number>, ...)format, will close the issue(s) when the PR gets merged):Fixes #
Type of change
Please delete options that are not relevant.
mainbranch)Checklist:
Post Merge Requirements
Helm Chart Change