feat: item.type se to "DRAFT_ISSUE" when item is a draft#40
Merged
Conversation
fixes discriminated union type, reduces confusion since isDraft exists on projectItem.content when item is a PR
gr2m
changed the title
.isDraft from projectItemitem.type se to "DRAFT_ISSUE" when item is a draft
gr2m
approved these changes
Mar 26, 2022
Owner
gr2m
left a comment
gr2m
left a comment
There was a problem hiding this comment.
Usually I'd deprecate item.isDraft first and would log a deprecation message, then in another release remove the deprecated API. Ideally breaking changes include only removal of previously deprecated APIs. But this is still a new project without a lot of usage, it's not worth the trouble
|
🎉 This PR is included in version 2.0.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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
2 participants
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.
This fixes the discriminated union type and reduces confusion of the data model since
.isDraftexists onprojectItem.contentwhen the item is aPULL_REQUEST.This also makes it possible to further break-out the types in the future if needed (for example: if type: "PULL_REQUEST" has different fields).
Note: this is a breaking change!
Initial discussion on previous PR #38 (comment)