public_mirrors
/
build-containers
mirror of https://github.com/godotengine/build-containers.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
build-containers/README.md

84 lines
3.7 KiB
Markdown
Raw Normal View History

Initial commit
2019-01-07 21:51:22 +01:00
# Godot engine build containers
Adding usage documentation.
2021-02-15 01:26:43 +01:00
This repository contains the Dockerfiles for the official Godot engine builds.
These containers should help you build Godot for all platforms supported on
any machine that can run Docker containers.
Initial commit
2019-01-07 21:51:22 +01:00
Adding usage documentation.
2021-02-15 01:26:43 +01:00
The in-container build scripts are in a separate repository:
https://github.com/godotengine/godot-build-scripts
Initial commit
2019-01-07 21:51:22 +01:00
Link to godot-build-scripts
2021-02-09 12:05:06 +01:00
Adding usage documentation.
2021-02-15 01:26:43 +01:00
## Introduction
These scripts build a number of containers which are then used to build final
Godot tools, templates and server packages for several platforms.
Once these containers are built, they can be used to compile different Godot
versions without the need of recreating them.
The `upload.sh` file is meant to be used by Godot Release Team and is not
documented here.
## Requirements
Cleanup and improve README Removed old instructions about Ubuntu 18.04 as there's no good reason to use such an old OS to build those containers, and we're not testing it so chances are that the containers may not build/work properly there. It saves a lot of trouble to just use latest Fedora (or possibly RHEL/CentOS) to build those containers.
2022-06-27 16:29:29 +02:00
These containers have been tested under Fedora 36 (other distros/releases may work too).
Adding usage documentation.
2021-02-15 01:26:43 +01:00
Cleanup and improve README Removed old instructions about Ubuntu 18.04 as there's no good reason to use such an old OS to build those containers, and we're not testing it so chances are that the containers may not build/work properly there. It saves a lot of trouble to just use latest Fedora (or possibly RHEL/CentOS) to build those containers.
2022-06-27 16:29:29 +02:00
The tool used to build and manage the containers is `podman` (install it with `dnf -y podman`).
Adding usage documentation.
2021-02-15 01:26:43 +01:00
Cleanup and improve README Removed old instructions about Ubuntu 18.04 as there's no good reason to use such an old OS to build those containers, and we're not testing it so chances are that the containers may not build/work properly there. It saves a lot of trouble to just use latest Fedora (or possibly RHEL/CentOS) to build those containers.
2022-06-27 16:29:29 +02:00
We currently use `podman` as root to build and use these containers. Documenting a workflow to
configure the host OS to be able to do all this without root would be welcome (but back when we
tried we ran into performance issues).
Adding usage documentation.
2021-02-15 01:26:43 +01:00
## Usage
Cleanup and improve README Removed old instructions about Ubuntu 18.04 as there's no good reason to use such an old OS to build those containers, and we're not testing it so chances are that the containers may not build/work properly there. It saves a lot of trouble to just use latest Fedora (or possibly RHEL/CentOS) to build those containers.
2022-06-27 16:29:29 +02:00
The `build.sh` script included is used to build the containers themselves.
Adding usage documentation.
2021-02-15 01:26:43 +01:00
Cleanup and improve README Removed old instructions about Ubuntu 18.04 as there's no good reason to use such an old OS to build those containers, and we're not testing it so chances are that the containers may not build/work properly there. It saves a lot of trouble to just use latest Fedora (or possibly RHEL/CentOS) to build those containers.
2022-06-27 16:29:29 +02:00
The first two arguments can take any value and are meant to convey what Godot branch
you are building for (e.g. `3.x`) and what Linux distribution the `Dockerfile.base`
is based on (e.g. `f36` for Fedora 36).
Adding usage documentation.
2021-02-15 01:26:43 +01:00
Cleanup and improve README Removed old instructions about Ubuntu 18.04 as there's no good reason to use such an old OS to build those containers, and we're not testing it so chances are that the containers may not build/work properly there. It saves a lot of trouble to just use latest Fedora (or possibly RHEL/CentOS) to build those containers.
2022-06-27 16:29:29 +02:00
The third argument is important and should be the name of a tagged Mono release from
the upstream `2020-02` branch (e.g. `mono-6.12.0.182`).
Adding usage documentation.
2021-02-15 01:26:43 +01:00
Cleanup and improve README Removed old instructions about Ubuntu 18.04 as there's no good reason to use such an old OS to build those containers, and we're not testing it so chances are that the containers may not build/work properly there. It saves a lot of trouble to just use latest Fedora (or possibly RHEL/CentOS) to build those containers.
2022-06-27 16:29:29 +02:00
Run the command using:
Adding usage documentation.
2021-02-15 01:26:43 +01:00
Cleanup and improve README Removed old instructions about Ubuntu 18.04 as there's no good reason to use such an old OS to build those containers, and we're not testing it so chances are that the containers may not build/work properly there. It saves a lot of trouble to just use latest Fedora (or possibly RHEL/CentOS) to build those containers.
2022-06-27 16:29:29 +02:00
./build.sh 3.x f36 mono-6.12.0.182
Adding usage documentation.
2021-02-15 01:26:43 +01:00
Cleanup and improve README Removed old instructions about Ubuntu 18.04 as there's no good reason to use such an old OS to build those containers, and we're not testing it so chances are that the containers may not build/work properly there. It saves a lot of trouble to just use latest Fedora (or possibly RHEL/CentOS) to build those containers.
2022-06-27 16:29:29 +02:00
The above will generate images using the tag '3.x-f36-mono-6.12.0.182'.
You can then specify it in the `build.sh` of [godot-build-scripts]().
Adding usage documentation.
2021-02-15 01:26:43 +01:00
### Selecting which images to build
If you don't need to build all versions or you want to try with a single target OS first,
you can comment out the corresponding lines from the script:
Linux: New container based on Fedora using Godot SDKs We now provide pre-built toolchains for Linux with old glibc and the required Godot dependencies, which can be used to build portable Godot binaries without having to be on an extremely old Linux distro. So we can retire the old Ubuntu 14.04 containers and instead do our portable builds directly on Fedora 34, like for other platforms. This commit also makes use of `godot-mono-builds` to build Mono and the BCL for Linux, instead of doing it manually. The same will be done for Windows and macOS in the next commit.
2021-07-12 14:32:49 +02:00
$podman_build_mono -t godot-linux:${img_version} -f Dockerfile.linux . 2>&1 | tee logs/linux.log
Update README with Fedora 34 digest, disable MSVC build
2021-10-11 12:27:35 +02:00
$podman_build_mono -t godot-windows:${img_version} -f Dockerfile.windows . 2>&1 | tee logs/windows.log
Adding usage documentation.
2021-02-15 01:26:43 +01:00
$podman_build_mono -t godot-javascript:${img_version} -f Dockerfile.javascript . 2>&1 | tee logs/javascript.log
$podman_build_mono -t godot-android:${img_version} -f Dockerfile.android . 2>&1 | tee logs/android.log
...
Cleanup and improve README Removed old instructions about Ubuntu 18.04 as there's no good reason to use such an old OS to build those containers, and we're not testing it so chances are that the containers may not build/work properly there. It saves a lot of trouble to just use latest Fedora (or possibly RHEL/CentOS) to build those containers.
2022-06-27 16:29:29 +02:00
**Note:** The MSVC image (used for UWP builds) does not work currently.
Adding usage documentation.
2021-02-15 01:26:43 +01:00
Cleanup and improve README Removed old instructions about Ubuntu 18.04 as there's no good reason to use such an old OS to build those containers, and we're not testing it so chances are that the containers may not build/work properly there. It saves a lot of trouble to just use latest Fedora (or possibly RHEL/CentOS) to build those containers.
2022-06-27 16:29:29 +02:00
## Image sizes
Adding usage documentation.
2021-02-15 01:26:43 +01:00
These are the expected container image sizes, so you can plan your disk usage in advance:
Cleanup and improve README Removed old instructions about Ubuntu 18.04 as there's no good reason to use such an old OS to build those containers, and we're not testing it so chances are that the containers may not build/work properly there. It saves a lot of trouble to just use latest Fedora (or possibly RHEL/CentOS) to build those containers.
2022-06-27 16:29:29 +02:00
REPOSITORY TAG SIZE
localhost/godot-fedora 3.x-f36-mono-6.12.0.182 546 MB
localhost/godot-export 3.x-f36-mono-6.12.0.182 1.03 GB
localhost/godot-mono 3.x-f36-mono-6.12.0.182 1.41 GB
localhost/godot-mono-glue 3.x-f36-mono-6.12.0.182 1.75 GB
localhost/godot-linux 3.x-f36-mono-6.12.0.182 3.8 GB
localhost/godot-windows 3.x-f36-mono-6.12.0.182 3.31 GB
localhost/godot-javascript 3.x-f36-mono-6.12.0.182 3.87 GB
localhost/godot-android 3.x-f36-mono-6.12.0.182 16.8 GB
localhost/godot-osx 3.x-f36-mono-6.12.0.182 5.71 GB
localhost/godot-ios 3.x-f36-mono-6.12.0.182 6.53 GB
Update README with current list of containers
2021-07-13 08:28:01 +02:00
In addition to this, generating containers will also require some host disk space
(up to 30 GB) for the downloaded Mono sources and dependencies (Xcode, MSVC).