Add support for experimental event versions #62
Merged
Conversation
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
Nowadays, the protocol supports experimental (pre-1.0.0) versions, with EiffelArtifactDeployedEvent being the first event of that kind. The point of those versions is to allow experimentation and non backwards compatible changes without major version bumps. For this SDK, this means that all pre-1.0.0 versions need to get their own struct types since there could be arbitrary changes between, say, 0.1.0 and 0.2.0, and the only way to guarantee that we can support all such versions is to use distinct types for all of them. Since we're updating the protocol submodule gitlink in this commit (to get hold of EiffelArtifactDeployedEvent) we're also getting a few other changes, effectively making us cover nearly the whole intended scope of the Orizaba edition.
JonasAlfredsson
approved these changes
Jul 6, 2023
felixhall
approved these changes
Jul 10, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
Applicable Issues
Fixes #46
Description of the Change
Nowadays, the protocol supports experimental (pre-1.0.0) event versions, with EiffelArtifactDeployedEvent being the first event of that kind. The point of those versions is to allow experimentation and non backwards compatible changes without major version bumps.
For this SDK, this means that all pre-1.0.0 versions need to get their own struct types since there could be arbitrary changes between, say, 0.1.0 and 0.2.0, and the only way to guarantee that we can support all such versions is to use distinct types for all of them.
Since we're updating the protocol submodule gitlink in this commit (to get hold of EiffelArtifactDeployedEvent) we're also getting a few other changes, effectively making us cover nearly the whole intended scope of the Orizaba edition.
Alternate Designs
This design was the only reasonable option I could come up with.
Benefits
The SDK can represent all existing event versions.
Possible Drawbacks
Lots of types if there are many experimental event versions.
Sign-off
Developer's Certificate of Origin 1.1
By making a contribution to this project, I certify that:
(a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or
(b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or
(c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.
(d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.
Signed-off-by: Magnus Bäck <[email protected]>