Skip to content

Work on Kanama

Use this path when you are changing Kanama itself: runtime code, annotations, the KSP processor, generated wrappers, native bootstrap, docs, or package artifacts.

Local Checks

Run the main Gradle checks:

./gradlew check -PkanamaBuildNativeBootstrap=false

Build docs strictly:

mkdocs build --strict

Run local CI with a Godot binary:

scripts/local_ci.sh /absolute/path/to/godot-4.7-beta4

For a release-facing source check, run the isolated clone gate:

scripts/fresh_clone_smoke.sh /absolute/path/to/godot-4.7-beta4

Package Builds

Build the host desktop kit and local host store addon:

./gradlew packageDistributions

Build only the desktop kit:

./gradlew packageDesktopKit

Validate a desktop kit without a sibling Kanama checkout:

scripts/package_install_smoke.sh \
  --desktop-kit \
  build/distributions/kanama-desktop-kit-v<version>-<platform>.zip \
  /absolute/path/to/godot-4.7-beta4

Validate a store addon through the same temporary-project smoke:

scripts/package_install_smoke.sh \
  --store-addon \
  build/distributions/kanama-store-addon-v<version>.zip \
  /absolute/path/to/godot-4.7-beta4

GitHub Actions builds the release matrix for macOS arm64, Linux x64, Linux ARM64, and Windows x64. The package workflow intentionally has no pull request trigger; release artifacts are built only from manual dispatch or v* tags.

Wrapper and API Work

Use the contributing docs for deeper maintenance paths: