api: compare the ABI against the last release - #711
Open
maxime-leroy wants to merge 1 commit into
Open
Conversation
The check compared the API headers with the parent commit, which required a GR_API_VERSION bump from every commit changing a type, including a commit changing a type another commit of the same series had just introduced. Nothing outside the series ever saw that intermediate layout, and bumping for it puts clients and daemons in lockstep for something which never shipped. GR_API_VERSION is negotiated in the hello handshake between two binaries, so what it has to describe is the compatibility of released versions. Compare against the last release tag instead, which needs one bump per release cycle at most and leaves the commit layout of a series free. What this gives up is the mixing of binaries built from two different commits of the same cycle: they announce the same version while the API has changed in between. PREV_REVISION is still honoured for anyone wanting the previous behaviour. Signed-off-by: Maxime Leroy <maxime@leroys.fr>
Code Review by Qodo🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)
Great, no issues found!Qodo reviewed your code and found no material issues that require reviewTip of the day💡 Did you know, you can switch off images and animations for a plain-text comment |
Collaborator
|
The point of GR_API_VERSION is twofold:
I understand your point about pointless enforcing for things that will never be shipped. But think about the following issues with your approach:
I would prefer keeping the current per-commit ABI compatibility check. |
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.
The check compared the API headers with the parent commit, which required a GR_API_VERSION bump from every commit changing a type, including a commit changing a type another commit of the same series had just introduced. Nothing outside the series ever saw that intermediate layout, and bumping for it puts clients and daemons in lockstep for something which never shipped.
GR_API_VERSION is negotiated in the hello handshake between two binaries, so what it has to describe is the compatibility of released versions. Compare against the last release tag instead, which needs one bump per release cycle at most and leaves the commit layout of a series free.
What this gives up is the mixing of binaries built from two different commits of the same cycle: they announce the same version while the API has changed in between. PREV_REVISION is still honoured for anyone wanting the previous behaviour.