- Updated gRPC configuration to disable Abseil installation, ensuring it is only included when necessary.
- This change aims to streamline the build process and reduce unnecessary dependencies, aligning with recent CI improvements.
This adjustment supports ongoing efforts to enhance build efficiency and maintainability across platforms.
- Updated CI presets for Linux, macOS, and Windows to enable gRPC, improving build performance with caching.
- Adjusted Abseil inclusion logic to only include standalone Abseil when gRPC is disabled, ensuring compatibility and reducing unnecessary dependencies.
- Enhanced the list of exported Abseil targets from gRPC's bundled version for better utility access.
This change aims to streamline CI processes while maintaining the necessary dependencies for successful builds.
Abseil is required for failure_signal_handler and other utilities
used by the application even when gRPC is disabled. This fixes CI
build failures on Ubuntu where Abseil targets were not found when
gRPC was disabled in CI presets.
fix: resolve Windows and Linux CI build failures
- Add platform-specific CI presets (ci-linux, ci-macos, ci-windows)
- Disable gRPC in CI builds to reduce build time from 40+ min to 5-10 min
- Fix gRPC version to 1.67.1 for MSVC compatibility
- Update run-tests action to use CTest presets
- Add comprehensive CI build failure analysis documentation
Resolves CI build failures on Windows (MSVC gRPC errors) and Linux (timeouts)
This commit implements the fixes identified in CI_BUILD_FAILURE_ANALYSIS.md
to ensure stable, fast CI builds across all platforms.
Changes:
1. Add platform-specific CI presets (ci-linux, ci-macos, ci-windows)
- Disable gRPC to avoid 30-40 min build times and MSVC errors
- Use minimal build configuration for faster, reliable CI
- Expected build time reduction: ~40 min -> 5-10 min
2. Update CI workflow to use platform-specific presets
- Build job now uses ci-linux, ci-macos, ci-windows
- Test job now uses platform-specific presets
- Ensures consistent behavior across all platforms
3. Fix gRPC version for Windows MSVC compatibility
- Downgrade from v1.75.1 to v1.67.1
- v1.75.1 has UPB compilation errors on Windows MSVC
- v1.67.1 is tested and stable on all platforms
4. Update test presets to use 'minimal' configuration
- Ensures test presets work on all platforms
- Consistent with new CI approach
Benefits:
- Eliminates Windows MSVC gRPC compilation errors
- Prevents Linux CI timeout issues from long gRPC builds
- Reduces CI build time by ~75% (40 min -> 5-10 min)
- Maintains build stability for releases
- No symbol linkage conflicts (verified)
Technical Notes:
- Test executables use gtest_main (no main() conflicts)
- Main app (yaze), emulator (yaze_emu), and tests are separate executables
- Shared libraries (yaze_core, yaze_gfx, etc.) properly isolated
- gRPC disabled in CI but still available for local dev builds
Add detailed root cause analysis for Windows and Linux CI build failures.
Key findings:
- gRPC version 1.75.1 has MSVC compilation errors on Windows
- CPM configuration missing Windows version override logic
- Long gRPC build times (30-40 min) causing potential timeouts
- CI preset forces gRPC build even though it's optional
Recommended solution: Use platform-specific CI presets with gRPC disabled
to reduce build times from 40 min to 5-10 min and eliminate errors.
Document includes:
- Detailed root cause analysis
- Multiple solution options with code examples
- 3-phase implementation plan
- Testing procedures and risk assessment
- Removed PARENT_SCOPE from various dependency target definitions in CMake files (grpc.cmake, imgui.cmake, sdl2.cmake, testing.cmake, yaml.cmake).
- Ensured that all targets are set locally for better clarity and management.
Benefits:
- Simplifies the dependency management process and improves the readability of CMake configurations.
- Incremented cache revision in dependencies.lock to trigger rebuild.
- Deleted obsolete imgui.cmake file to streamline project structure.
- Updated imgui.cmake to set C++ standard requirement for ImGui and its test engine.
Benefits:
- Simplifies dependency management and ensures compatibility with C++17.
- Cleans up unused files, improving project maintainability.
Line 205 had '$dir`: $_' which is invalid PowerShell syntax.
Changed to '$dir': $_' (regular colon without backtick escape).
PowerShell backticks are only needed for:
- Escape sequences (`n for newline, `t for tab)
- Line continuation
- Escaping special chars like $, `, "
Colons in strings don't need escaping and the backtick was causing
'missing terminator' parse errors.
Add comprehensive checks for Windows development tools:
- Ninja build system detection (required for win-dbg presets)
- NASM assembler check (needed for gRPC/BoringSSL builds)
- VS Code and CMake Tools extension detection
- CMakePresets.json validation with Windows preset enumeration
- Detailed Visual Studio component verification (C++ tools, SDKs, CMake support)
Improve user experience:
- Smart preset recommendations based on installed tools
- Separate guidance for Visual Studio, VS Code, and command-line workflows
- Context-aware help messages (Ninja vs VS generator presets)
- Enhanced troubleshooting section with tool-specific solutions
- Added verbose mode to list all available presets
The script now provides tailored next-steps based on the user's environment,
recommending win-vs-* presets when Ninja is missing, and win-* presets when
Ninja is available for faster builds.
- Fix .gitignore overly broad 'build*/' pattern that was ignoring .github/actions/build-project/
- Add missing build-project action file to repository
- Add comprehensive Windows CMake presets (win-dbg, win-rel, win-ai, win-vs-*, etc.)
- Add windows-base and windows-vs-base hidden presets for Ninja and Visual Studio generators
- Remove needs: build dependency from test job to allow parallel testing
- Support both x64 and ARM64 Windows architectures
- Configure MSVC runtime library settings for static linking
Fixes GitHub Actions errors: 'Can't find action.yml under build-project'
- Introduced multiple new CMake presets for Windows, including base presets for Ninja and Visual Studio generators, as well as specific configurations for Debug, Release, and Development builds.
- Added ARM64 support and various build options for AI development and z3ed CLI.
- Enhanced the build system's flexibility by allowing users to select from a range of configurations tailored for different development needs.
Benefits:
- Streamlines the build process for Windows environments, improving usability for developers.
- Provides comprehensive support for various build types and architectures, enhancing the overall development experience.
- Introduced a new script, `validate-actions.sh`, to validate the structure of GitHub Actions composite actions, ensuring required fields are present and correctly configured.
- The script checks for the existence of action files, required fields, and proper references in the CI workflow, enhancing the reliability of CI processes.
Benefits:
- Improves the integrity of GitHub Actions by automating validation checks, reducing the likelihood of misconfigurations.
- Streamlines the CI workflow by ensuring that all actions are correctly defined and referenced before execution.
- Created a new README.md for GitHub Actions composite actions, detailing available actions, inputs, and usage instructions for the YAZE CI/CD pipeline.
- Added a BUILD-GUIDE.md to provide a detailed overview of the build process across macOS, Linux, and Windows, including quick start commands and build system configurations.
- Introduced a BUILD-TROUBLESHOOTING.md to address common build issues, platform-specific problems, and provide solutions, enhancing the developer experience and support.
Benefits:
- Improves onboarding and usability for developers by providing clear and structured documentation.
- Facilitates easier troubleshooting and understanding of the build process across different platforms.
- Removed the code checkout step from the custom setup action and added it directly in the CI workflow steps for better clarity and control.
- This change ensures that the code is checked out before the build environment is set up, improving the overall workflow execution.
Benefits:
- Enhances the CI process by making the code checkout explicit and easier to manage within the workflow.
- Modified `.vscode/settings.json` to use workspace-relative paths for `compileCommands` and `buildDirectory`, enhancing portability across different environments.
- Updated task labels in `tasks.json` for clarity, renaming them to reflect their specific CMake operations.
- Added new tasks for cleaning builds and running tests, streamlining the development workflow.
Benefits:
- Improves the development experience by ensuring configurations are adaptable and tasks are clearly defined, facilitating easier project management.
- Added new entries to `.pre-commit-config.yaml`, `cmake-format.yaml`, and `.github/dependabot.yml` to improve code quality checks and dependency updates.
- Enhanced GitHub Actions workflows by adding new steps for testing and build retention.
- Introduced support for the nlohmann_json library in CMake, allowing for conditional inclusion based on the `YAZE_ENABLE_JSON` option.
- Updated CMake configurations to streamline SDL2 and gRPC integration, ensuring proper linking and target management.
Benefits:
- Improves code quality and consistency through automated checks and formatting.
- Enhances dependency management and build reliability across platforms.
- Provides flexibility for users to enable optional features, improving overall functionality.
- Updated `.clangd` configuration to include additional include paths and feature flags tailored for ROM hacking workflows, optimizing IntelliSense support.
- Introduced `.pre-commit-config.yaml` for managing code quality checks and formatting, ensuring consistent code style across the project.
- Added `cmake-format.yaml` for CMake formatting configuration, promoting adherence to style guidelines.
- Enhanced CI workflows to include new actions for testing and building, improving overall reliability and efficiency in the development process.
Benefits:
- Streamlines development setup and improves code quality through automated checks.
- Facilitates better collaboration by ensuring consistent coding standards and configurations.
- Added gRPC installation to the macOS section of the CI workflow, ensuring that the necessary dependencies are available for builds.
- Updated the GitHub path to include the gRPC prefix, improving accessibility for subsequent build steps.
Benefits:
- Enhances the CI process by ensuring all required tools are installed, leading to more reliable builds.
- Modified the CI workflow to remove the `build/_deps` directory during the clean-up process, ensuring a more thorough cache reset.
- Updated gRPC CMake configuration to disable reflection support, further optimizing the build process by preventing unnecessary proto generation.
Benefits:
- Enhances the CI workflow by ensuring a clean build environment.
- Improves build efficiency by reducing unnecessary steps in gRPC integration.
- Added `yaze_app_core_lib` and `yaze_editor` to the linking of the `yaze_emu_test` target in the CMake configuration.
- This change enhances the test's access to core application functionalities, improving test coverage and reliability.
Benefits:
- Ensures that the emulator tests have the necessary dependencies linked, facilitating more comprehensive testing of the emulator's features.
- Introduced a new file for Linux CI package dependencies to streamline the installation process.
- Updated gRPC CMake configuration to disable C++ reflection support, reducing unnecessary proto generation.
Benefits:
- Enhances the CI workflow by clearly defining required packages for Linux builds.
- Improves build efficiency by avoiding extra generation steps in gRPC integration.
- Modified the CI configuration to enhance the installation of Linux packages by using a more efficient command.
- Updated macOS dependency installation to include LLVM version 18 and set the LLVM_PREFIX in the GitHub path for better accessibility.
Benefits:
- Streamlines the CI process for Linux and macOS, improving build reliability and ensuring necessary tools are available for the build environment.
- Introduced new CMake presets for Linux release and AI builds, enhancing cross-platform support.
- Updated CI workflows to include Linux build configurations, ensuring consistent build processes across platforms.
- Added a new release packaging script to streamline artifact creation for different operating systems.
Benefits:
- Improves build flexibility and reliability for Linux users.
- Simplifies the release process by automating artifact packaging and checksum generation.
- Added logic to handle gRPC target resolution, allowing for fallback to bare names when using FetchContent or vcpkg.
- Updated the handling of CMAKE_CROSSCOMPILING to ensure proper configuration for host builds, preventing issues with protoc binary location.
- Adjusted target_add_protobuf function to use generator expressions for better compatibility and maintainability.
Benefits:
- Improves build reliability and flexibility when integrating gRPC support.
- Ensures correct handling of cross-compilation scenarios, enhancing compatibility across platforms.
- Added optional gRPC support in CMake, allowing for conditional inclusion based on the `YAZE_WITH_GRPC` option.
- Updated the handling of the FTXUI library to ensure it is fetched if not found, improving build reliability.
- Streamlined dependency management by including the `dependencies.cmake` file in the appropriate location.
Benefits:
- Provides flexibility for users to enable gRPC support, enhancing functionality.
- Improves build process by ensuring necessary libraries are available and properly configured.
- Added settings to disable x86-specific optimizations in the CMake configuration for ARM64 macOS builds, ensuring compatibility and stability.
- Removed redundant x86-specific settings that were previously included, streamlining the configuration.
Benefits:
- Enhances build compatibility for ARM64 macOS users by preventing the inclusion of incompatible optimizations.
- Introduced a new `yaze_grpc_support` library to centralize all gRPC and protobuf usage, addressing Windows linker errors and improving build stability.
- Updated CMake configurations across various components to link against the new support library instead of individual protobuf targets, simplifying the linking process.
- Removed legacy whole-archive linking logic, ensuring a cleaner and more maintainable build setup.
Benefits:
- Reduces complexity in CMake files and enhances compatibility across platforms.
- Prevents potential linker errors by consolidating gRPC and protobuf dependencies into a single library.
- Introduced a new document detailing the overworld entity system, including its architecture, core components, and critical bug fixes.
- Outlined the ongoing refactor plan aimed at modularizing the system for improved maintainability and compatibility with ZScream features.
- Documented specific bug fixes related to entity interaction, property management, and coordinate systems to enhance functionality.
Benefits:
- Provides a comprehensive reference for developers working on the overworld entity system.
- Facilitates understanding of recent changes and future development directions.
- Updated CMake configuration to conditionally apply whole-archive linking for the `yaze_agent` target on Unix-like systems, ensuring all necessary symbols are included.
- Maintained standard linking for Windows while improving compatibility across platforms.
Benefits:
- Increases build stability and ensures proper symbol inclusion for test support libraries, reducing potential linker errors.
- Enhanced CMake configuration to conditionally apply /WHOLEARCHIVE linking for protobuf targets, ensuring only library targets are included.
- Updated linking logic across multiple components including `yaze`, `yaze_emu`, `z3ed`, and test suites to improve compatibility and prevent linker errors.
Benefits:
- Increases build stability and clarity by ensuring only relevant targets are linked, reducing potential conflicts during the build process.
- Modified CMakeLists.txt for test helper executables to use PRIVATE visibility for linked libraries, ensuring encapsulation of dependencies.
- This change enhances build clarity and prevents unintended linkage of libraries in other targets.
Benefits:
- Improves modularity and maintainability of the build configuration for test helpers.
- Adjusted CMake files to conditionally link protobuf using /WHOLEARCHIVE on Windows to include internal symbols while avoiding LNK1241 errors.
- Updated linking logic for `yaze`, `yaze_editor`, `yaze_emu`, `z3ed`, and test suites to ensure compatibility across platforms.
Benefits:
- Improves build stability and compatibility for Windows users by ensuring proper symbol inclusion without resource duplication issues.
- Refactored `OverworldMap` to utilize `OverworldVersionHelper` for version checks, enhancing clarity and maintainability.
- Updated logic for loading area information and handling custom overworld data based on versioning.
- Cleaned up includes and namespace declarations for better organization and readability.
Benefits:
- Streamlines version handling, reducing code duplication and potential errors.
- Enhances overall code structure, making it easier to navigate and maintain.
- Added /WHOLEARCHIVE linking for protobuf in various CMake files to ensure internal symbols are included while preventing resource duplication.
- Updated linking options for `yaze`, `yaze_emu`, `z3ed`, and test suites to apply this option conditionally on Windows with MSVC.
Benefits:
- Ensures proper inclusion of protobuf symbols in executables, improving compatibility and functionality across platforms.
- Updated caching keys in CI and release workflows from v2 to v3 for gRPC dependencies to improve cache management.
- Enhanced linking options for `yaze_editor` and `yaze_agent` to ensure test symbols are included correctly across different platforms.
Benefits:
- Streamlines the build process by ensuring proper versioning and linking of test support libraries.
- Improves cache efficiency in CI workflows, reducing build times.
- Updated `UpdateMapProperties` methods across various entities (entrances, exits, items, sprites) to include an optional context parameter for improved area size detection.
- Introduced `OverworldVersionHelper` for centralized ROM version detection and feature gating, replacing scattered inline checks.
- Refactored coordinate calculations to utilize normalized map IDs, ensuring consistency and preventing data corruption.
- Enhanced exit properties to sync player positions and calculate scroll/camera values based on the overworld context.
Benefits:
- Streamlines entity property updates and improves compatibility with different ROM versions.
- Reduces code duplication and enhances maintainability by centralizing version checks.
- Ensures accurate coordinate calculations for overworld entities, improving overall functionality.
- Upgraded gRPC version from v1.68.0 to v1.75.1 for improved compatibility across all platforms.
- Removed /WHOLEARCHIVE linking for protobuf to prevent duplicate version resource errors in the dependency chain.
- Updated status messages to reflect the latest gRPC version and build optimizations.
Benefits:
- Enhances build stability and compatibility with modern toolchains.
- Simplifies linking process by avoiding unnecessary options that cause conflicts.
- Changed gRPC version from v1.75.1 to v1.68.0 to resolve linker errors related to protobuf resource files on Windows.
- Updated compatibility notes to reflect the stable version and reasons for the downgrade.
Benefits:
- Improves build stability on Windows by avoiding LNK1241 errors during linking.
- Ensures better compatibility with clang-cl and MSVC toolchains.
- Modified CI workflow to correctly format the toolchain file argument for CMake.
- Updated release workflow to enhance the release creation process, ensuring the latest release is marked appropriately.
- Added configuration to disable protobuf version resource on Windows to prevent duplicate resource errors during linking.
Benefits:
- Improves build reliability and consistency across different environments.
- Streamlines the release process, making it more intuitive for developers.
- Upgraded gRPC from v1.67.1 to v1.75.1 for improved Windows compatibility.
- Disabled BoringSSL ASM optimizations for better clang-cl support.
- Updated documentation to reflect changes in build times and reasons for using FetchContent over vcpkg for gRPC.
- Removed unused gRPC and protobuf dependencies from `vcpkg.json`.
- Updated CI configuration to enable vcpkg installation for SDL2 and yaml-cpp.
- Added support for MSVC in CI workflows and improved caching strategies for vcpkg packages.
- Enhanced logging in build steps to provide better feedback on dependency status and build progress.
- Changed `x_camera_` and `y_camera_` in `OverworldExit` from `uint8_t` to `uint16_t` for consistency and to accommodate larger values.
- Updated the `DrawExitEditorPopup` function to use `InputHexWord` for camera positions, reflecting the new data type.
- Added `ImGui::PushID` and `ImGui::PopID` calls in various popup functions to resolve duplicate ID warnings, enhancing the stability of the UI.
Benefits:
- Ensures proper handling of camera coordinates in the overworld editor.
- Improves UI robustness by addressing ID conflicts in popups.
