Include register-docs feature in CI

godot-rust · Jul 27, 2024 · cc1fbf0 · cc1fbf0
1 parent 01678e5
commit cc1fbf0
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 3 deletions.
diff --git a/.github/workflows/full-ci.yml b/.github/workflows/full-ci.yml
@@ -324,7 +324,7 @@ jobs:
             os: ubuntu-20.04
             artifact-name: linux-nightly
             godot-binary: godot.linuxbsd.editor.dev.x86_64
-            rust-extra-args: --features itest/experimental-threads,itest/codegen-full-experimental,godot/api-custom,godot/serde
+            rust-extra-args: --features itest/experimental-threads,itest/codegen-full-experimental,godot/api-custom,godot/serde,itest/register-docs
 
           - name: linux-release
             os: ubuntu-20.04

diff --git a/.github/workflows/minimal-ci.yml b/.github/workflows/minimal-ci.yml
@@ -164,7 +164,7 @@ jobs:
             os: ubuntu-20.04
             artifact-name: linux-nightly
             godot-binary: godot.linuxbsd.editor.dev.x86_64
-            rust-extra-args: --features itest/experimental-threads,itest/codegen-full-experimental,godot/api-custom,godot/serde
+            rust-extra-args: --features itest/experimental-threads,itest/codegen-full-experimental,godot/api-custom,godot/serde,itest/register-docs
 
           # Linux compat
 

diff --git a/godot-core/src/init/mod.rs b/godot-core/src/init/mod.rs
@@ -144,7 +144,10 @@ unsafe fn gdext_on_level_init(level: InitLevel) {
         }
         InitLevel::Editor => {
             #[cfg(all(since_api = "4.3", feature = "docs"))]
-            crate::docs::register();
+            // SAFETY: Godot binding is initialized, and this is called from the main thread.
+            unsafe {
+                crate::docs::register();
+            }
         }
         _ => (),
     }

diff --git a/itest/rust/Cargo.toml b/itest/rust/Cargo.toml
@@ -13,6 +13,7 @@ crate-type = ["cdylib"]
 default = []
 codegen-full-experimental = ["godot/__codegen-full", "godot/experimental-godot-api"]
 experimental-threads = ["godot/experimental-threads"]
+register-docs = ["godot/register-docs"] # TODO remove as soon as constant_test.rs checks bitfields with #[constant] proc-macro
 serde = ["dep:serde", "dep:serde_json", "godot/serde"]
 
 # Do not add features here that are 1:1 forwarded to the `godot` crate, unless they are needed by itest itself.

diff --git a/itest/rust/src/register_tests/constant_test.rs b/itest/rust/src/register_tests/constant_test.rs
@@ -166,6 +166,7 @@ impl godot::obj::cap::ImplementsGodotApi for HasOtherConstants {
     }
 }
 
+// TODO once this is done via proc-macro, remove `register-docs` feature from itest, and update CI workflows.
 godot::sys::plugin_add!(
     __GODOT_PLUGIN_REGISTRY in ::godot::private;
     ::godot::private::ClassPlugin {
@@ -174,6 +175,8 @@ godot::sys::plugin_add!(
             register_methods_constants_fn: ::godot::private::ErasedRegisterFn {
                 raw: ::godot::private::callbacks::register_user_methods_constants::<HasOtherConstants>,
             },
+            #[cfg(all(since_api = "4.3", feature = "register-docs"))]
+            docs: None,
         },
         init_level: HasOtherConstants::INIT_LEVEL,
     }