Skip to content

Conversation

@Meorge
Copy link
Contributor

@Meorge Meorge commented Dec 7, 2025

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-*.txt file.

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.

@Calinou Calinou added enhancement area:engine details Issues and PRs related to the Engine Details section of the documentation cherrypick:4.5 labels Dec 10, 2025
Copy link
Member

@Calinou Calinou left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

@mhilbrunner mhilbrunner merged commit 580bc4c into godotengine:master Dec 10, 2025
1 check passed
@mhilbrunner
Copy link
Member

Thank you! Merged.

@Meorge
Copy link
Contributor Author

Meorge commented Dec 10, 2025

Thanks so much! 😄

One small note: I noticed this received the cherrypick:4.5 label; however, it references the new file-based system for PRs' compatibility breakages (using 4.x-stable/GH-#####.txt files instead of a single 4.x-stable.expected file) being introduced with 4.6. As such, would it make sense for this to be cherrypicked back to 4.5's documentation? This is made even trickier by the fact that the example given on the page takes place during development of 4.3, when this new system wasn't there either... 😅

@mhilbrunner
Copy link
Member

Good point, removed the label for now, thanks for pointing that out :)

@Meorge
Copy link
Contributor Author

Meorge commented Dec 10, 2025

No problem! Most of the PR content is also applicable to before the new file-based system; would it make sense for me to submit a pre-4.6-specific version for the sole purpose of cherrypicking? Given that's not where main engine development is now, it may be unnecessary, but otherwise I'd be happy to do that!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:engine details Issues and PRs related to the Engine Details section of the documentation enhancement

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Provide more specific instructions on "Handling compatibility breakages" page

3 participants