2020-08-22 21:04:57 +00:00
|
|
|
name: 🍎 macOS Builds
|
2023-04-04 13:56:53 +00:00
|
|
|
on:
|
|
|
|
workflow_call:
|
2020-07-20 22:36:22 +00:00
|
|
|
|
2020-10-09 20:18:51 +00:00
|
|
|
# Global Settings
|
2020-07-20 22:36:22 +00:00
|
|
|
env:
|
2023-05-18 14:22:25 +00:00
|
|
|
# Used for the cache key. Add version suffix to force clean build.
|
2022-08-25 11:44:22 +00:00
|
|
|
GODOT_BASE_BRANCH: master
|
2024-08-29 15:33:29 +00:00
|
|
|
SCONSFLAGS: verbose=yes warnings=extra werror=yes module_text_server_fb_enabled=yes strict_checks=yes
|
2020-07-20 22:36:22 +00:00
|
|
|
|
2021-08-24 18:49:06 +00:00
|
|
|
concurrency:
|
2024-07-08 15:41:20 +00:00
|
|
|
group: ci-${{ github.actor }}-${{ github.head_ref || github.run_number }}-${{ github.ref }}-macos
|
2021-08-24 18:49:06 +00:00
|
|
|
cancel-in-progress: true
|
|
|
|
|
2020-07-20 22:36:22 +00:00
|
|
|
jobs:
|
2021-09-01 15:26:01 +00:00
|
|
|
build-macos:
|
2024-07-08 15:41:20 +00:00
|
|
|
runs-on: macos-latest
|
2021-09-01 15:26:01 +00:00
|
|
|
name: ${{ matrix.name }}
|
|
|
|
strategy:
|
|
|
|
fail-fast: false
|
|
|
|
matrix:
|
|
|
|
include:
|
SCons: Unify tools/target build type configuration
Implements https://github.com/godotengine/godot-proposals/issues/3371.
New `target` presets
====================
The `tools` option is removed and `target` changes to use three new presets,
which match the builds users are familiar with. These targets control the
default optimization level and enable editor-specific and debugging code:
- `editor`: Replaces `tools=yes target=release_debug`.
* Defines: `TOOLS_ENABLED`, `DEBUG_ENABLED`, `-O2`/`/O2`
- `template_debug`: Replaces `tools=no target=release_debug`.
* Defines: `DEBUG_ENABLED`, `-O2`/`/O2`
- `template_release`: Replaces `tools=no target=release`.
* Defines: `-O3`/`/O2`
New `dev_build` option
======================
The previous `target=debug` is now replaced by a separate `dev_build=yes`
option, which can be used in combination with either of the three targets,
and changes the following:
- `dev_build`: Defines `DEV_ENABLED`, disables optimization (`-O0`/`/0d`),
enables generating debug symbols, does not define `NDEBUG` so `assert()`
works in thirdparty libraries, adds a `.dev` suffix to the binary name.
Note: Unlike previously, `dev_build` defaults to off so that users who
compile Godot from source get an optimized and small build by default.
Engine contributors should now set `dev_build=yes` in their build scripts or
IDE configuration manually.
Changed binary names
====================
The name of generated binaries and object files are changed too, to follow
this format:
`godot.<platform>.<target>[.dev][.double].<arch>[.<extra_suffix>][.<ext>]`
For example:
- `godot.linuxbsd.editor.dev.arm64`
- `godot.windows.template_release.double.x86_64.mono.exe`
Be sure to update your links/scripts/IDE config accordingly.
More flexible `optimize` and `debug_symbols` options
====================================================
The optimization level and whether to generate debug symbols can be further
specified with the `optimize` and `debug_symbols` options. So the default
values listed above for the various `target` and `dev_build` combinations
are indicative and can be replaced when compiling, e.g.:
`scons p=linuxbsd target=template_debug dev_build=yes optimize=debug`
will make a "debug" export template with dev-only code enabled, `-Og`
optimization level for GCC/Clang, and debug symbols. Perfect for debugging
complex crashes at runtime in an exported project.
2022-09-22 06:28:55 +00:00
|
|
|
- name: Editor (target=editor, tests=yes)
|
2021-09-01 15:26:01 +00:00
|
|
|
cache-name: macos-editor
|
SCons: Unify tools/target build type configuration
Implements https://github.com/godotengine/godot-proposals/issues/3371.
New `target` presets
====================
The `tools` option is removed and `target` changes to use three new presets,
which match the builds users are familiar with. These targets control the
default optimization level and enable editor-specific and debugging code:
- `editor`: Replaces `tools=yes target=release_debug`.
* Defines: `TOOLS_ENABLED`, `DEBUG_ENABLED`, `-O2`/`/O2`
- `template_debug`: Replaces `tools=no target=release_debug`.
* Defines: `DEBUG_ENABLED`, `-O2`/`/O2`
- `template_release`: Replaces `tools=no target=release`.
* Defines: `-O3`/`/O2`
New `dev_build` option
======================
The previous `target=debug` is now replaced by a separate `dev_build=yes`
option, which can be used in combination with either of the three targets,
and changes the following:
- `dev_build`: Defines `DEV_ENABLED`, disables optimization (`-O0`/`/0d`),
enables generating debug symbols, does not define `NDEBUG` so `assert()`
works in thirdparty libraries, adds a `.dev` suffix to the binary name.
Note: Unlike previously, `dev_build` defaults to off so that users who
compile Godot from source get an optimized and small build by default.
Engine contributors should now set `dev_build=yes` in their build scripts or
IDE configuration manually.
Changed binary names
====================
The name of generated binaries and object files are changed too, to follow
this format:
`godot.<platform>.<target>[.dev][.double].<arch>[.<extra_suffix>][.<ext>]`
For example:
- `godot.linuxbsd.editor.dev.arm64`
- `godot.windows.template_release.double.x86_64.mono.exe`
Be sure to update your links/scripts/IDE config accordingly.
More flexible `optimize` and `debug_symbols` options
====================================================
The optimization level and whether to generate debug symbols can be further
specified with the `optimize` and `debug_symbols` options. So the default
values listed above for the various `target` and `dev_build` combinations
are indicative and can be replaced when compiling, e.g.:
`scons p=linuxbsd target=template_debug dev_build=yes optimize=debug`
will make a "debug" export template with dev-only code enabled, `-Og`
optimization level for GCC/Clang, and debug symbols. Perfect for debugging
complex crashes at runtime in an exported project.
2022-09-22 06:28:55 +00:00
|
|
|
target: editor
|
2021-09-01 15:26:01 +00:00
|
|
|
tests: true
|
2024-07-08 15:41:20 +00:00
|
|
|
bin: ./bin/godot.macos.editor.universal
|
2021-09-01 15:26:01 +00:00
|
|
|
|
2024-07-08 15:41:20 +00:00
|
|
|
- name: Template (target=template_release, tests=yes)
|
2021-09-01 15:26:01 +00:00
|
|
|
cache-name: macos-template
|
SCons: Unify tools/target build type configuration
Implements https://github.com/godotengine/godot-proposals/issues/3371.
New `target` presets
====================
The `tools` option is removed and `target` changes to use three new presets,
which match the builds users are familiar with. These targets control the
default optimization level and enable editor-specific and debugging code:
- `editor`: Replaces `tools=yes target=release_debug`.
* Defines: `TOOLS_ENABLED`, `DEBUG_ENABLED`, `-O2`/`/O2`
- `template_debug`: Replaces `tools=no target=release_debug`.
* Defines: `DEBUG_ENABLED`, `-O2`/`/O2`
- `template_release`: Replaces `tools=no target=release`.
* Defines: `-O3`/`/O2`
New `dev_build` option
======================
The previous `target=debug` is now replaced by a separate `dev_build=yes`
option, which can be used in combination with either of the three targets,
and changes the following:
- `dev_build`: Defines `DEV_ENABLED`, disables optimization (`-O0`/`/0d`),
enables generating debug symbols, does not define `NDEBUG` so `assert()`
works in thirdparty libraries, adds a `.dev` suffix to the binary name.
Note: Unlike previously, `dev_build` defaults to off so that users who
compile Godot from source get an optimized and small build by default.
Engine contributors should now set `dev_build=yes` in their build scripts or
IDE configuration manually.
Changed binary names
====================
The name of generated binaries and object files are changed too, to follow
this format:
`godot.<platform>.<target>[.dev][.double].<arch>[.<extra_suffix>][.<ext>]`
For example:
- `godot.linuxbsd.editor.dev.arm64`
- `godot.windows.template_release.double.x86_64.mono.exe`
Be sure to update your links/scripts/IDE config accordingly.
More flexible `optimize` and `debug_symbols` options
====================================================
The optimization level and whether to generate debug symbols can be further
specified with the `optimize` and `debug_symbols` options. So the default
values listed above for the various `target` and `dev_build` combinations
are indicative and can be replaced when compiling, e.g.:
`scons p=linuxbsd target=template_debug dev_build=yes optimize=debug`
will make a "debug" export template with dev-only code enabled, `-Og`
optimization level for GCC/Clang, and debug symbols. Perfect for debugging
complex crashes at runtime in an exported project.
2022-09-22 06:28:55 +00:00
|
|
|
target: template_release
|
2024-07-17 10:15:13 +00:00
|
|
|
tests: true
|
2024-07-08 15:41:20 +00:00
|
|
|
sconsflags: debug_symbols=no
|
|
|
|
bin: ./bin/godot.macos.template_release.universal
|
2020-07-20 22:36:22 +00:00
|
|
|
|
|
|
|
steps:
|
2024-07-08 15:41:20 +00:00
|
|
|
- name: Checkout
|
|
|
|
uses: actions/checkout@v4
|
2024-03-16 02:52:47 +00:00
|
|
|
with:
|
|
|
|
submodules: recursive
|
2020-07-20 22:36:22 +00:00
|
|
|
|
2024-07-13 13:50:30 +00:00
|
|
|
- name: Restore Godot build cache
|
|
|
|
uses: ./.github/actions/godot-cache-restore
|
2020-07-20 22:36:22 +00:00
|
|
|
with:
|
2021-09-01 15:26:01 +00:00
|
|
|
cache-name: ${{ matrix.cache-name }}
|
2021-08-18 19:00:56 +00:00
|
|
|
continue-on-error: true
|
2020-07-20 22:36:22 +00:00
|
|
|
|
2024-05-17 07:28:56 +00:00
|
|
|
- name: Setup Python and SCons
|
2021-09-01 15:26:01 +00:00
|
|
|
uses: ./.github/actions/godot-deps
|
2020-07-20 22:36:22 +00:00
|
|
|
|
2022-07-29 10:52:40 +00:00
|
|
|
- name: Setup Vulkan SDK
|
|
|
|
run: |
|
|
|
|
sh misc/scripts/install_vulkan_sdk_macos.sh
|
|
|
|
|
2024-04-24 09:45:11 +00:00
|
|
|
- name: Compilation (x86_64)
|
2021-09-01 15:26:01 +00:00
|
|
|
uses: ./.github/actions/godot-build
|
2020-09-29 21:42:41 +00:00
|
|
|
with:
|
2024-04-24 09:45:11 +00:00
|
|
|
sconsflags: ${{ env.SCONSFLAGS }} arch=x86_64
|
|
|
|
platform: macos
|
|
|
|
target: ${{ matrix.target }}
|
|
|
|
tests: ${{ matrix.tests }}
|
|
|
|
|
|
|
|
- name: Compilation (arm64)
|
|
|
|
uses: ./.github/actions/godot-build
|
|
|
|
with:
|
|
|
|
sconsflags: ${{ env.SCONSFLAGS }} arch=arm64
|
2022-07-20 06:28:22 +00:00
|
|
|
platform: macos
|
2021-09-01 15:26:01 +00:00
|
|
|
target: ${{ matrix.target }}
|
|
|
|
tests: ${{ matrix.tests }}
|
2020-09-29 21:42:41 +00:00
|
|
|
|
2024-07-13 13:50:30 +00:00
|
|
|
- name: Save Godot build cache
|
|
|
|
uses: ./.github/actions/godot-cache-save
|
|
|
|
with:
|
|
|
|
cache-name: ${{ matrix.cache-name }}
|
|
|
|
continue-on-error: true
|
|
|
|
|
2021-09-21 19:54:55 +00:00
|
|
|
- name: Prepare artifact
|
|
|
|
run: |
|
2024-04-24 09:45:11 +00:00
|
|
|
lipo -create ./bin/godot.macos.${{ matrix.target }}.x86_64 ./bin/godot.macos.${{ matrix.target }}.arm64 -output ./bin/godot.macos.${{ matrix.target }}.universal
|
|
|
|
rm ./bin/godot.macos.${{ matrix.target }}.x86_64 ./bin/godot.macos.${{ matrix.target }}.arm64
|
2021-09-21 19:54:55 +00:00
|
|
|
strip bin/godot.*
|
2022-07-29 10:52:40 +00:00
|
|
|
chmod +x bin/godot.*
|
2021-09-21 19:54:55 +00:00
|
|
|
|
2021-09-01 15:26:01 +00:00
|
|
|
- name: Upload artifact
|
|
|
|
uses: ./.github/actions/upload-artifact
|
2020-09-29 21:42:41 +00:00
|
|
|
with:
|
2021-09-01 15:26:01 +00:00
|
|
|
name: ${{ matrix.cache-name }}
|
2023-08-01 18:38:07 +00:00
|
|
|
|
|
|
|
- name: Unit tests
|
2024-07-08 15:41:20 +00:00
|
|
|
if: matrix.tests
|
2023-08-01 18:38:07 +00:00
|
|
|
run: |
|
|
|
|
${{ matrix.bin }} --version
|
|
|
|
${{ matrix.bin }} --help
|
2023-10-28 07:22:27 +00:00
|
|
|
${{ matrix.bin }} --test --force-colors
|