BREAKING CHANGE: use string instead of enum for Version
#561
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
TypeScript does not consider enum values equivalent, even if the string representation is the same. So, when a module imports `cloudevents` and also has a dependency on `cloudevents` this can cause conflicts where the `CloudEvent.version` attribute is not considered equal when, in fact, it is. Changing the `enum` to a string is pretty straightforward, but should be considered a breaking change since TypeScript dependents will potentially fail the build with a change like this. Signed-off-by: Lance Ball <lball@redhat.com>
|
@lance looks like the merging of this didn't have the effect we wanted(creating a major bump PR) |
I noticed that. I should have used |
|
maybe that "empty commit release as version" workflow, that we've done before? |
lance
added a commit
to lance/sdk-javascript
that referenced
this pull request
Jul 20, 2023
This is an empty commit that provides a reference to cloudevents#561 which was not considered a breaking change by release-please. Release-As: 8.0.0 Signed-off-by: Lance Ball <lball@redhat.com>
lholmquist
pushed a commit
that referenced
this pull request
Jul 20, 2023
This is an empty commit that provides a reference to #561 which was not considered a breaking change by release-please. Release-As: 8.0.0 Signed-off-by: Lance Ball <lball@redhat.com>
That didn't seem to work either... Hmm |
|
maybe the prefix of the commit should just be |
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.
TypeScript does not consider enum values equivalent, even if the string representation is the same. So, when a module imports
cloudeventsand also has a dependency on another module which also has a dependency oncloudeventsthis can cause conflicts where theCloudEvent.versionattribute is not considered equal when, in fact, it is.Changing the
enumto a string is pretty straightforward, but should be considered a breaking change since TypeScript dependents will potentially fail the build with a change like this.See: knative/func#1873 (comment)
Fixes: #323