Add more details to "Handling compatibility breakages" page #11519
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Closes #11459 .
This PR adds more detailed instructions to the "Handling compatibility breakages" page, explaining how to generate the "Validate extension JSON" text that goes in the
GH-*.txtfile.It also emphasizes the "Hash changed" error and gives some guidance on things to check when trying to fix it.
This is probably already assumed, but just in case: it'd be very good to get GDExtension peoples' OK on this before merging. The steps I laid out here make logical sense to me and they worked when I tested them with a PR of mine, but I certainly don't want to end up misleading people if there are steps or caveats I'm not aware of.