f394245636
Clarifies the confusing builder.inc.sh / build-utils.sh distinction by giving the scripts more appropriate names. Most build scripts should use builder-full.inc.sh; some helper scripts can use builder-basic.inc.sh. Documented in resources/build/README.md. Renames: * resources/build/builder.inc.sh to resources/build/builder-full.inc.sh * resources/build/build-utils.sh to resources/build/builder-basic.inc.sh Other changes: * Moves Android-specific functions out of builder-basic.inc.sh and into android/build.sh. * Renames functions in builder-basic.inc.sh More functions may be moved from builder-basic.inc.sh into utils.inc.sh or other scripts in the future. Fixes: #14065 Build-bot: build all Test-bot: skip |
||
|---|---|---|
| .. | ||
| android | ||
| base | ||
| core | ||
| developer | ||
| linux | ||
| web | ||
| build.sh | ||
| docker-build.inc.sh | ||
| README.md | ||
| run.sh | ||
Container
Docker containers that can be used to build Keyman on the respective platforms. They contain everything that a CI build agent needs to build for the platform.
Prerequisites
You'll need Docker Buildx installed to successfully be able to build the container images. This is most easily achieved by installing the official Docker version.
Currently it is not possible to use Podman instead of Docker due to a number of bugs and incompatibilities in the Podman implementation.
Building the images
To build the docker images:
resources/docker-images/build.sh
By default this will create 64-bit images for building
Keyman Core, Keyman for Android, Keyman for Linux, Keyman for Web
and (cross-platform parts of) Keyman Developer. These images are based
on Ubuntu 24.04 with Node 20 and Emscripten 3.1.58 (for the exact versions,
see minimum-versions.inc.sh).
The images are named e.g. keymanapp/keyman-core-ci:default.
The versions can be changed, e.g.
resources/docker-images/build.sh --distro-version jammy --node 20
This will create an image named e.g.
keymanapp/keyman-core-ci:ubuntu-jammy-java21-node20.16.0-emsdk3.1.58.
Once the image is built, it may be used to build parts of Keyman.
Building locally
It is possible to build locally with these images:
# build 'Keyman Core' in docker
resources/docker-images/run.sh :core -- core/build.sh --debug build
Note: For Core and Linux we put the generated binaries in a container specific directory because they are platform dependent.
If you build both with Docker and directly with the build scripts, it is
advisable to run a git clean -dxf before switching between the two. The
reason is that the Docker images use a different user, so that paths
will be different.
Running tests locally
To run the tests locally, use the run.sh script:
# Run common/web tests
resources/docker-images/run.sh :web -- common/web/build.sh --debug test