RFC: IR format versioning #258
Open
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
iamdanfox
force-pushed
the
dfox/ir-format-versioning
branch
from
5d4b612
to
95355b9
Compare
carterkozak
reviewed
Mar 18, 2019
| **Producers** | Don't care (minor rev) | Breaking (major rev) | ||
| **Consumers** | Breaking (major rev) | Don't care (minor rev) | ||
|
|
||
| Producers don't care about additive changes to the IR because they can keep taking upgrades whether the new features are relevant to them or not. Producers do care about restrictive changes to the IR as this could potentially make their current API definitions invalid, thereby even . This suggests additive changes should increment minor, and restrictive should increment major. |
There was a problem hiding this comment.
thereby even .
I think we're missing some words
|
This looks sane to me. It reinforces the decision to support a single integer version field, and I don't see serious downsides. If we were to fundamentally change the meaning of the IR we could also rename the version, causing all existing non-compliant parsers/generators to fail as we would expect in alternative version proposals. |
|
This PR has been automatically marked as stale because it has not been touched in the last 14 days. If you'd like to keep it open, please leave a comment or add the 'long-lived' label, otherwise it'll be closed in 7 days. |
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.
Rendered
Before this PR
We're somewhat blocked on all the issues tagged 'IR change' and also #227 because the mechanism for actually making an IR change is undefined.
After this PR
==COMMIT_MSG==
RFC: IR format versioning recommends single-digit scheme
==COMMIT_MSG==
This RFC just tackles the first problem for an IR rev - will follow up with a separate RFC to discuss lossless upgrading/downgrading etc.
Possible downsides?
A bad decision about IR versioning could result in the conjure ecosystem becoming confusing to use / contribute to, or alternatively introduce excessive overhead and unintentionally hamper development.
The upside is that this RFC can always be superseded if significant problems arise.