Make dora versions compatible by using separate versioning for dora-message crate
#614
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
Decouples the `dora-message` version from the version of the other `dora-*` crates. This allows us to use semver-versioning for the `dora-message` crate to encode message compatibility across dora versions.
The dora-message package is versioned separately, so this publish command might fail if the version is already published.
haixuanTao
approved these changes
Aug 13, 2024
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.
By versioning the
dora-messagecrate individually, we can use the semver rules to encode which versions are compatible. This way, we can allow different versions of dora to work together (e.g. CLI version can be different than node API version), as long as the message formats are compatible. Breaking message format changes are signaled by a semver-incompatible release ofdora-message. For example, 0.4.0 is not compatible with 0.3.5.One alternative approach could be to use the main version to signal compatibility, i.e. the common version that we use for all dora crates. This has the disadvantage that we might need to bump the minor version of the main dora crate every time we want to change the message format in a breaking way. As we still expect semi-regular breaking changes to the message format in the near future, we want to avoid this churn. Once we consider the message format more stable, we plan to revisit this approach.
Fixes #504
TODO
dora-messagecrate if there is no new version.