From 6f51871cc1596e22a63475817c99e9648988863e Mon Sep 17 00:00:00 2001 From: Emmanuel Engelhart Date: Tue, 7 Feb 2023 15:50:26 +0100 Subject: [PATCH 1/3] Add env container images documentation --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 9771591..9ffbf12 100644 --- a/README.md +++ b/README.md @@ -164,6 +164,22 @@ Kiwix-build.py will create several directories: If you want to install all those directories elsewhere, you can pass the `--working-dir` option to `kiwix-build`: +CI/CD containerised environments +-------------------------------- + +Beside the `kiwix-build` command line tool, Kiwix Build proposes +[prepared compilation environments for multiple GNU/Linux +systems](.github/ci_images/) too. + +These prepared environments include: compilers, binary toolchains and +any third-party tool necessary to run the compilation toolchain. They +don't contain pre-compiled library dependence (like Xapian, Libicu, +Libmicrohttps, ...) for any Kiwix solution. + +These container images are mostly used by Kiwix itself in many of its +CI. But they are free to download and reused, you can find them on +[Docker Hub](https://hub.docker.com/r/kiwix/kiwix-build_ci). + Troubleshooting --------------- From 19beb1323f1fa3f46b9212a9c386b90828817503 Mon Sep 17 00:00:00 2001 From: Emmanuel Engelhart Date: Tue, 7 Feb 2023 16:10:40 +0100 Subject: [PATCH 2/3] Internal usage purpose only of CI containers --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9ffbf12..c5377ab 100644 --- a/README.md +++ b/README.md @@ -174,11 +174,13 @@ systems](.github/ci_images/) too. These prepared environments include: compilers, binary toolchains and any third-party tool necessary to run the compilation toolchain. They don't contain pre-compiled library dependence (like Xapian, Libicu, -Libmicrohttps, ...) for any Kiwix solution. +Libmicrohttps, ...), Qt being an exception, for any Kiwix solution. -These container images are mostly used by Kiwix itself in many of its -CI. But they are free to download and reused, you can find them on -[Docker Hub](https://hub.docker.com/r/kiwix/kiwix-build_ci). +These container images are necessary and intended to be used by Kiwix +itself in many of its CI. But they are free to download et can be +reused, although they can break anytime, therefore at your won risk. +You can find them on [Docker +Hub](https://hub.docker.com/r/kiwix/kiwix-build_ci). Troubleshooting --------------- From d89f6224716c0da8c8b601838830601cacb88270 Mon Sep 17 00:00:00 2001 From: Matthieu Gautier Date: Tue, 7 Feb 2023 16:53:15 +0100 Subject: [PATCH 3/3] Fix description of which dependencies is in the docker image. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c5377ab..572c4c3 100644 --- a/README.md +++ b/README.md @@ -173,8 +173,8 @@ systems](.github/ci_images/) too. These prepared environments include: compilers, binary toolchains and any third-party tool necessary to run the compilation toolchain. They -don't contain pre-compiled library dependence (like Xapian, Libicu, -Libmicrohttps, ...), Qt being an exception, for any Kiwix solution. +don't contain pre-compiled library dependences build by kiwix-build, (like Xapian, Libicu, +Libmicrohttps, ...) but it contains dependencies installed with package manager. These container images are necessary and intended to be used by Kiwix itself in many of its CI. But they are free to download et can be