Add breaking change label to announcement schema - #100
Open
shivamsingh-007 wants to merge 1 commit into
Open
Conversation
Adds a dedicated 'breaking change' label so breaking changes no longer need to be shoehorned under 'deprecation'. Includes schema update, ChangelogLabel enum, LABEL_MAPPING redirect, prompt update, and README docs. Fixes zenml-io#83
This file contains hidden or 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
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.
Summary
Add a dedicated
breaking changelabel to the changelog announcement schema so breaking changes can be properly categorized instead of being mapped todeprecation.Related Issue
Fixes #83
What changed
"breaking change"to the labels enum inannouncement-schema.jsonBREAKING_CHANGEto theChangelogLabelPython enumLABEL_MAPPINGto routebreaking/breaking-changevariants to the new label instead ofdeprecationbreaking changeas a valid label option["breaking change"]passes schemaWhy this approach
Minimal change — 6 files, +25/-7. Reuses existing label infrastructure. Test proven to fail without the schema change.
Testing done
validate_changelog.pypasses against existingchangelog.jsonChecklist
breaking changelabel to the changelog announcement schema #83 referenced