name: 🐧 Linux Builds on: workflow_call: # Global Settings env: # Used for the cache key. Add version suffix to force clean build. GODOT_BASE_BRANCH: 4.3 SCONSFLAGS: verbose=yes warnings=extra werror=yes module_text_server_fb_enabled=yes DOTNET_NOLOGO: true DOTNET_CLI_TELEMETRY_OPTOUT: true TSAN_OPTIONS: suppressions=misc/error_suppressions/tsan.txt concurrency: group: ci-${{github.actor}}-${{github.head_ref || github.run_number}}-${{github.ref}}-linux cancel-in-progress: true jobs: build-linux: runs-on: "ubuntu-20.04" name: ${{ matrix.name }} strategy: fail-fast: false matrix: include: - name: Editor w/ Mono (target=editor) cache-name: linux-editor-mono target: editor sconsflags: module_mono_enabled=yes bin: "./bin/godot.linuxbsd.editor.x86_64.mono" build-mono: true tests: false # Disabled due freeze caused by mix Mono build and CI doc-test: true proj-conv: true api-compat: true artifact: true - name: Editor with doubles and GCC sanitizers (target=editor, tests=yes, dev_build=yes, scu_build=yes, precision=double, use_asan=yes, use_ubsan=yes, linker=gold) cache-name: linux-editor-double-sanitizers target: editor # Debug symbols disabled as they're huge on this build and we hit the 14 GB limit for runners. sconsflags: dev_build=yes scu_build=yes debug_symbols=no precision=double use_asan=yes use_ubsan=yes linker=gold bin: "./bin/godot.linuxbsd.editor.dev.double.x86_64.san" build-mono: false tests: true proj-test: true # Generate an API dump for godot-cpp tests. api-dump: true # Skip 2GiB artifact speeding up action. artifact: false - name: Editor with clang sanitizers (target=editor, tests=yes, dev_build=yes, use_asan=yes, use_ubsan=yes, use_llvm=yes, linker=lld) cache-name: linux-editor-llvm-sanitizers target: editor sconsflags: dev_build=yes use_asan=yes use_ubsan=yes use_llvm=yes linker=lld bin: "./bin/godot.linuxbsd.editor.dev.x86_64.llvm.san" build-mono: false tests: true # Skip 2GiB artifact speeding up action. artifact: false # Test our oldest supported SCons/Python versions on one arbitrary editor build. legacy-scons: true - name: Editor with ThreadSanitizer (target=editor, tests=yes, dev_build=yes, use_tsan=yes, use_llvm=yes, linker=lld) cache-name: linux-editor-thread-sanitizer target: editor tests: true sconsflags: dev_build=yes use_tsan=yes use_llvm=yes linker=lld bin: "./bin/godot.linuxbsd.editor.dev.x86_64.llvm.san" build-mono: false # Skip 2GiB artifact speeding up action. artifact: false - name: Template w/ Mono (target=template_release) cache-name: linux-template-mono target: template_release sconsflags: module_mono_enabled=yes tests=yes bin: "./bin/godot.linuxbsd.template_release.x86_64.mono" build-mono: false tests: true artifact: true - name: Minimal template (target=template_release, everything disabled) cache-name: linux-template-minimal target: template_release sconsflags: modules_enabled_by_default=no disable_3d=yes disable_advanced_gui=yes deprecated=no minizip=no tests=yes bin: "./bin/godot.linuxbsd.template_release.x86_64" tests: true artifact: true steps: - uses: actions/checkout@v4 with: submodules: recursive # Need newer mesa for lavapipe to work properly. - name: Linux dependencies for tests if: ${{ matrix.proj-test }} run: | sudo rm -f /etc/apt/sources.list.d/microsoft-prod.list sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys EB8B81E14DA65431D7504EA8F63F0F2B90935439 sudo add-apt-repository "deb https://ppa.launchpadcontent.net/kisak/turtle/ubuntu focal main" sudo apt-get install -qq mesa-vulkan-drivers # TODO: Figure out somehow how to embed this one. - name: wayland-scanner dependency run: | sudo apt-get install libwayland-bin - name: Free disk space on runner run: | echo "Disk usage before:" && df -h sudo rm -rf /usr/local/lib/android echo "Disk usage after:" && df -h - name: Restore Godot build cache uses: ./.github/actions/godot-cache-restore with: cache-name: ${{ matrix.cache-name }} continue-on-error: true - name: Setup Python and SCons if: ${{ ! matrix.legacy-scons }} uses: ./.github/actions/godot-deps - name: Setup Python and SCons (legacy versions) if: ${{ matrix.legacy-scons }} uses: ./.github/actions/godot-deps with: # Sync with Ensure*Version in SConstruct. python-version: 3.6 scons-version: 3.1.2 - name: Setup GCC problem matcher uses: ammaraskar/gcc-problem-matcher@master - name: Compilation uses: ./.github/actions/godot-build with: sconsflags: ${{ env.SCONSFLAGS }} ${{ matrix.sconsflags }} platform: linuxbsd target: ${{ matrix.target }} tests: ${{ matrix.tests }} - name: Save Godot build cache uses: ./.github/actions/godot-cache-save with: cache-name: ${{ matrix.cache-name }} continue-on-error: true - name: Generate C# glue if: ${{ matrix.build-mono }} run: | ${{ matrix.bin }} --headless --generate-mono-glue ./modules/mono/glue - name: Build .NET solutions if: ${{ matrix.build-mono }} run: | ./modules/mono/build_scripts/build_assemblies.py --godot-output-dir=./bin --godot-platform=linuxbsd - name: Prepare artifact if: ${{ matrix.artifact }} run: | strip bin/godot.* chmod +x bin/godot.* - name: Upload artifact uses: ./.github/actions/upload-artifact if: ${{ matrix.artifact }} with: name: ${{ matrix.cache-name }} - name: Dump Godot API uses: ./.github/actions/godot-api-dump if: ${{ matrix.api-dump }} with: bin: ${{ matrix.bin }} - name: Unit tests if: ${{ matrix.tests }} run: | ${{ matrix.bin }} --version ${{ matrix.bin }} --help ${{ matrix.bin }} --headless --test --force-colors - name: .NET source generators tests if: ${{ matrix.build-mono }} run: | dotnet test modules/mono/editor/Godot.NET.Sdk/Godot.SourceGenerators.Tests # Check class reference - name: Check for class reference updates if: ${{ matrix.doc-test }} run: | echo "Running --doctool to see if this changes the public API without updating the documentation." echo -e "If a diff is shown, it means that your code/doc changes are incomplete and you should update the class reference with --doctool.\n\n" ${{ matrix.bin }} --doctool --headless 2>&1 > /dev/null || true git diff --color --exit-code && ! git ls-files --others --exclude-standard | sed -e 's/^/New doc file missing in PR: /' | grep 'xml$' # Check API backwards compatibility - name: Check for GDExtension compatibility if: ${{ matrix.api-compat }} run: | ./misc/scripts/validate_extension_api.sh "${{ matrix.bin }}" # Download and run the test project - name: Test Godot project uses: ./.github/actions/godot-project-test if: ${{ matrix.proj-test }} with: bin: ${{ matrix.bin }} # Test the project converter - name: Test project converter uses: ./.github/actions/godot-converter-test if: ${{ matrix.proj-conv }} with: bin: ${{ matrix.bin }}