Validate that api-custom is run for Godot Debug binary
#1071
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
Necessary because Release builds (export templates) don't provide flags like `--dump-extension-api` and provide weird errors instead.
Bromeon
added
quality-of-life
|
API docs are being generated and will be shortly available at: https://godot-rust.github.io/docs/gdext/pr-1071 |
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.
When compiling an
api-customwithGODOT4_BINpointing to a release version of Godot (e.g. export template), thenError: Couldn't load project data at path ".". Is the .pck file missing?This unhelpful error appears because Godot doesn't know command-line arguments such as
--dump-extension-apiin Release mode, and simply ignores those -- interpreting the CLI invocation to be a call to run Godot itself.This PR checks for Release builds and panics in that case, with a better error message and no popup.
For the future, I plan a feature
api-custom-json. This would allow users to specify an environment variable such asGODOT4_GDEXTENSION_JSONpointing to a file, which is then used to generate code instead of the binary. Maybe in addition to a known C header. This could then also be a step towards #951.