CI: Compare API compatibility against both 4.0 and 4.1 #80354
CI: Compare API compatibility against both 4.0 and 4.1
- Loading branch information
commit b83dff752ca3fad0940f2eb8a1af32cdfd7e3c68
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,118 @@ | ||
| This file contains the expected output of --validate-extension-api when run against the extension_api.json of the | ||
| 4.1-stable tag (the basename of this file). | ||
|
|
||
| Only lines that start with "Validate extension JSON:" matter, everything else is considered a comment and ignored. They | ||
| should instead be used to justify these changes and describe how users should work around these changes. | ||
|
|
||
| Add new entries at the end of the file. | ||
|
|
||
| ## Changes between 4.1-stable and 4.2-stable | ||
|
|
||
| GH-79911 | ||
| -------- | ||
| Validate extension JSON: Error: Field 'classes/RenderingDevice/enums/BarrierMask/values/BARRIER_MASK_RASTER': value changed value in new API, from 1.0 to 9. | ||
| Validate extension JSON: Error: Field 'classes/RenderingDevice/enums/BarrierMask/values/BARRIER_MASK_ALL_BARRIERS': value changed value in new API, from 7.0 to 32767. | ||
| Validate extension JSON: Error: Field 'classes/RenderingDevice/enums/BarrierMask/values/BARRIER_MASK_NO_BARRIER': value changed value in new API, from 8.0 to 32768. | ||
| Validate extension JSON: Error: Field 'classes/RenderingDevice/methods/texture_update/arguments/3': default_value changed value in new API, from "7" to "32767". | ||
| Validate extension JSON: Error: Field 'classes/RenderingDevice/methods/texture_copy/arguments/9': default_value changed value in new API, from "7" to "32767". | ||
| Validate extension JSON: Error: Field 'classes/RenderingDevice/methods/texture_clear/arguments/6': default_value changed value in new API, from "7" to "32767". | ||
| Validate extension JSON: Error: Field 'classes/RenderingDevice/methods/texture_resolve_multisample/arguments/2': default_value changed value in new API, from "7" to "32767". | ||
| Validate extension JSON: Error: Field 'classes/RenderingDevice/methods/buffer_update/arguments/4': default_value changed value in new API, from "7" to "32767". | ||
| Validate extension JSON: Error: Field 'classes/RenderingDevice/methods/buffer_clear/arguments/3': default_value changed value in new API, from "7" to "32767". | ||
| Validate extension JSON: Error: Field 'classes/RenderingDevice/methods/draw_list_end/arguments/0': default_value changed value in new API, from "7" to "32767". | ||
| Validate extension JSON: Error: Hash changed for 'classes/RenderingDevice/methods/draw_list_end', from 19365687 to E9B4FA8E. This means that the function has changed and no compatibility function was provided. | ||
| Validate extension JSON: Error: Field 'classes/RenderingDevice/methods/compute_list_end/arguments/0': default_value changed value in new API, from "7" to "32767". | ||
| Validate extension JSON: Error: Hash changed for 'classes/RenderingDevice/methods/compute_list_end', from 19365687 to E9B4FA8E. This means that the function has changed and no compatibility function was provided. | ||
| Validate extension JSON: Error: Field 'classes/RenderingDevice/methods/barrier/arguments/0': default_value changed value in new API, from "7" to "32767". | ||
| Validate extension JSON: Error: Field 'classes/RenderingDevice/methods/barrier/arguments/1': default_value changed value in new API, from "7" to "32767". | ||
| Validate extension JSON: Error: Hash changed for 'classes/RenderingDevice/methods/barrier', from 0FE50041 to DD9E8DAB. This means that the function has changed and no compatibility function was provided. | ||
|
|
||
| Raster barrier was split into vertex and fragment barriers for use in mobile renderer. | ||
|
|
||
|
|
||
| GH-79308 | ||
| -------- | ||
| Validate extension JSON: API was removed: classes/GraphEdit/methods/get_scroll_ofs | ||
| Validate extension JSON: API was removed: classes/GraphEdit/methods/get_snap | ||
| Validate extension JSON: API was removed: classes/GraphEdit/methods/get_zoom_hbox | ||
| Validate extension JSON: API was removed: classes/GraphEdit/methods/is_using_snap | ||
| Validate extension JSON: API was removed: classes/GraphEdit/methods/set_scroll_ofs | ||
| Validate extension JSON: API was removed: classes/GraphEdit/methods/set_snap | ||
| Validate extension JSON: API was removed: classes/GraphEdit/methods/set_use_snap | ||
| Validate extension JSON: API was removed: classes/GraphEdit/properties/snap_distance | ||
| Validate extension JSON: API was removed: classes/GraphEdit/properties/use_snap | ||
| Validate extension JSON: API was removed: classes/GraphNode/methods/is_comment | ||
| Validate extension JSON: API was removed: classes/GraphNode/methods/set_comment | ||
| Validate extension JSON: API was removed: classes/GraphNode/properties/comment | ||
| Validate extension JSON: Error: Field 'classes/GraphEdit/properties/scroll_offset': getter changed value in new API, from "get_scroll_ofs" to &"get_scroll_offset". | ||
| Validate extension JSON: Error: Field 'classes/GraphEdit/properties/scroll_offset': setter changed value in new API, from "set_scroll_ofs" to &"set_scroll_offset". | ||
|
|
||
| Intentional compatibility breakage during refactoring of API marked as experimental. | ||
|
|
||
| FIXME: Still a WIP, review this list once the work is completed, especially if compatibility | ||
| code is added. | ||
|
|
||
|
|
||
| GH-73196 | ||
| -------- | ||
| Validate extension JSON: Error: Field 'classes/CodeEdit/methods/get_text_for_symbol_lookup': is_const changed value in new API, from false to true. | ||
|
|
||
| Function was made `const`. No adjustments should be necessary. | ||
|
|
||
|
|
||
| GH-78328 | ||
| -------- | ||
| Validate extension JSON: Error: Field 'classes/TileMap/methods/get_used_rect': is_const changed value in new API, from false to true. | ||
|
|
||
| Function was made `const`. No adjustments should be necessary. | ||
|
|
||
|
|
||
| GH-79606 | ||
| -------- | ||
| Validate extension JSON: Error: Field 'classes/RenderingDevice/methods/shader_create_from_bytecode/arguments': size changed value in new API, from 1 to 2. | ||
|
|
||
| Added optional argument. Compatibility method registered. | ||
|
|
||
|
|
||
| GH-78266 | ||
| -------- | ||
| Validate extension JSON: API was removed: classes/FontFile/properties/fallbacks | ||
| Validate extension JSON: API was removed: classes/FontVariation/properties/fallbacks | ||
| Validate extension JSON: API was removed: classes/SystemFont/properties/fallbacks | ||
|
|
||
| The property was moved to their common base class Font. | ||
| The setters and getters were already in Font, so this shouldn't affect compatibility. | ||
|
|
||
|
|
||
| GH-36493 | ||
| -------- | ||
| Validate extension JSON: Error: Field 'classes/PopupMenu/methods/add_icon_shortcut/arguments': size changed value in new API, from 4 to 5. | ||
| Validate extension JSON: Error: Field 'classes/PopupMenu/methods/add_shortcut/arguments': size changed value in new API, from 3 to 4. | ||
|
|
||
| Added optional argument. Compatibility methods registered. | ||
|
|
||
|
|
||
| GH-80954 | ||
| -------- | ||
| Validate extension JSON: Error: Field 'classes/Font/methods/find_variation/arguments': size changed value in new API, from 4 to 8. | ||
|
|
||
| Added optional arguments. Compatibility method registered. | ||
|
|
||
|
|
||
| GH-80852 | ||
| -------- | ||
|
|
||
| Validate extension JSON: API was removed: classes/GDScriptEditorTranslationParserPlugin | ||
| Validate extension JSON: API was removed: classes/GDScriptNativeClass | ||
| Validate extension JSON: API was removed: classes/GodotPhysicsServer2D | ||
| Validate extension JSON: API was removed: classes/GodotPhysicsServer3D | ||
| Validate extension JSON: API was removed: classes/IPUnix | ||
| Validate extension JSON: API was removed: classes/MovieWriterMJPEG | ||
| Validate extension JSON: API was removed: classes/MovieWriterPNGWAV | ||
| Validate extension JSON: API was removed: classes/ResourceFormatImporterSaver | ||
| Validate extension JSON: API was removed: classes/FramebufferCacheRD | ||
| Validate extension JSON: API was removed: classes/UniformSetCacheRD | ||
| Validate extension JSON: API was removed: classes/GLTFDocumentExtensionPhysics | ||
| Validate extension JSON: API was removed: classes/GLTFDocumentExtensionTextureWebP | ||
|
|
||
| Excluded unexposed classes from extension_api.json. | ||
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These two entries are new, but they are mentioned in this PR as being removed from the export, so this is correct and exactly the kind of thing that could slip through before this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The GitHub action still raises a warning for those but on the wrong file:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have hidden warnings from prior versions (as I originally intended), as it is kinda unavoidable that they happen (unless editing the expected files for old versions). (tho thinking about it there may still be some issues when changing a value in multiple versions, potentially still requiring changes to old expected files)