2022-08-28 18:27:45 +00:00
|
|
|
name: 🌐 Web Builds
|
2023-04-04 13:56:53 +00:00
|
|
|
on:
|
|
|
|
workflow_call:
|
2020-07-23 21:21:26 +00:00
|
|
|
|
2020-10-09 20:18:51 +00:00
|
|
|
# Global Settings
|
2020-07-23 21:21:26 +00:00
|
|
|
env:
|
2023-05-18 14:22:25 +00:00
|
|
|
# Used for the cache key. Add version suffix to force clean build.
|
2023-07-05 20:09:59 +00:00
|
|
|
GODOT_BASE_BRANCH: '4.1'
|
2021-09-01 15:26:01 +00:00
|
|
|
SCONSFLAGS: verbose=yes warnings=extra werror=yes debug_symbols=no
|
2023-09-05 12:56:53 +00:00
|
|
|
EM_VERSION: 3.1.45
|
2021-09-01 15:26:01 +00:00
|
|
|
EM_CACHE_FOLDER: "emsdk-cache"
|
2020-07-23 21:21:26 +00:00
|
|
|
|
2021-08-24 18:49:06 +00:00
|
|
|
concurrency:
|
2022-08-28 18:27:45 +00:00
|
|
|
group: ci-${{github.actor}}-${{github.head_ref || github.run_number}}-${{github.ref}}-web
|
2021-08-24 18:49:06 +00:00
|
|
|
cancel-in-progress: true
|
|
|
|
|
2020-07-23 21:21:26 +00:00
|
|
|
jobs:
|
2022-08-28 18:27:45 +00:00
|
|
|
web-template:
|
2023-09-05 12:56:53 +00:00
|
|
|
runs-on: "ubuntu-22.04"
|
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: Template (target=template_release)
|
2020-07-23 21:21:26 +00:00
|
|
|
|
|
|
|
steps:
|
2023-09-04 14:05:38 +00:00
|
|
|
- uses: actions/checkout@v4
|
2020-07-23 21:21:26 +00:00
|
|
|
|
|
|
|
- name: Set up Emscripten latest
|
2023-03-26 01:12:53 +00:00
|
|
|
uses: mymindstorm/setup-emsdk@v12
|
2020-07-23 21:21:26 +00:00
|
|
|
with:
|
|
|
|
version: ${{env.EM_VERSION}}
|
|
|
|
actions-cache-folder: ${{env.EM_CACHE_FOLDER}}
|
|
|
|
|
|
|
|
- name: Verify Emscripten setup
|
|
|
|
run: |
|
|
|
|
emcc -v
|
|
|
|
|
2021-09-01 15:26:01 +00:00
|
|
|
- name: Setup Godot build cache
|
|
|
|
uses: ./.github/actions/godot-cache
|
|
|
|
continue-on-error: true
|
|
|
|
|
|
|
|
- name: Setup python and scons
|
|
|
|
uses: ./.github/actions/godot-deps
|
2020-09-29 21:42:41 +00:00
|
|
|
|
2021-09-01 15:26:01 +00:00
|
|
|
- name: Compilation
|
|
|
|
uses: ./.github/actions/godot-build
|
2020-09-29 21:42:41 +00:00
|
|
|
with:
|
2021-09-01 15:26:01 +00:00
|
|
|
sconsflags: ${{ env.SCONSFLAGS }}
|
2022-08-28 18:27:45 +00:00
|
|
|
platform: web
|
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
|
2021-09-01 15:26:01 +00:00
|
|
|
tests: false
|
|
|
|
|
|
|
|
- name: Upload artifact
|
|
|
|
uses: ./.github/actions/upload-artifact
|