erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-08-06 17:05:34 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 13
spiegel-keyman/resources/docker-images
History
Eberhard Beilharz 33fe775aa7
maint(developer): use docker buildx to build docker images 
This change verifies that `docker buildx` is available and then uses that
for building the images. For that we apparently need the magic line at
the top of the `Dockerfile`s and set the environment variable
`DOCKER_BUILDKIT`. This solves a problem building docker images on
Linux with an older Docker version where the heredocs didn't work.
2025-06-06 18:10:53 +02:00
..
android maint(developer): use docker buildx to build docker images 2025-06-06 18:10:53 +02:00
base maint(developer): use docker buildx to build docker images 2025-06-06 18:10:53 +02:00
core maint(developer): use docker buildx to build docker images 2025-06-06 18:10:53 +02:00
developer maint(developer): use docker buildx to build docker images 2025-06-06 18:10:53 +02:00
linux maint(developer): use docker buildx to build docker images 2025-06-06 18:10:53 +02:00
web maint(developer): use docker buildx to build docker images 2025-06-06 18:10:53 +02:00
build.sh maint(developer): use docker buildx to build docker images 2025-06-06 18:10:53 +02:00
docker-build.inc.sh maint(developer): use docker buildx to build docker images 2025-06-06 18:10:53 +02:00
README.md maint(developer): specify platforms as targets instead of actions in run.sh 2025-06-06 17:07:02 +02:00
run.sh maint(developer): specify platforms as targets instead of actions in run.sh 2025-06-06 17:07:02 +02:00

README.md

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