Skip to content

Commit df54c72

Browse files
committed
Updated the README
1 parent 765aaa0 commit df54c72

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

README.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@
2828
* [Error: Suite contains no tests](#error-suite-contains-no-tests)
2929
* [Database tests are failing in spite of the DatabaseLibrary being present](#database-tests-are-failing-in-spite-of-the-databaselibrary-being-present)
3030
* [Supported devices and architectures](#supported-devices-and-architectures)
31+
* [Container image is too large](#troubleshooting-image-too-large)
3132
* [Please contribute!](#please-contribute)
3233

3334
-----
@@ -200,6 +201,8 @@ rpa==1.50.0
200201
201202
**For large dependencies, it is still recommended to extend the project's image and to add them there, to avoid delaying the CI/CD pipelines with repeated dependency installations.**
202203
204+
<a name="rerunning-tests"></a>
205+
203206
### Rerunning tests
204207
205208
Failing tests can be rerun by setting the environment variable `ROBOT_RERUN_MAX_ROUNDS` to a value above 0. All reruns of failed tests are executed without parallelization.
@@ -467,7 +470,7 @@ It is anyway mandatory to extend the container image to install the specific dat
467470

468471
### Supported devices and architectures
469472

470-
As mentioned on the [Docker Hub](https://hub.docker.com/r/ppodgorsek/robot-framework), the project has been built and uploaded as a `linux/amd64` image only. This means ARM devices such as MacBook M1/M2 and Amazon EC2 Graviton won't be able to run the image with the default configuration.
473+
As mentioned on the [Docker Hub](https://hub.docker.com/r/ppodgorsek/robot-framework), the project has been built and uploaded for `linux/amd64` and `linux/arm64` architectures only.
471474

472475
As mentioned in the official documentation, [Podman](https://docs.podman.io/en/latest/markdown/podman-run.1.html#platform-os-arch) and [Docker](https://docs.docker.com/build/building/multi-platform/) provide a `--platform` option which selects a given application architecture, such as:
473476

@@ -479,12 +482,22 @@ docker run \
479482
ppodgorsek/robot-framework:<version>
480483
```
481484

482-
Please note that builds and automated tests of this project are only performed on `linux/amd64` and `linux/arm64` architectures so such emulation might not work, depending on your device and operating system.
483-
484485
**It is to be noted that Microsoft Edge is not available for Linux ARM. Please visit [the official Microsoft Edge website](https://www.microsoft.com/en-us/edge/business/download) and [the Arm developer website](https://learn.arm.com/install-guides/browsers/edge/) for more information.**
485486

486487
If this does not solve your platform-related issues, you might have to rebuild the image for your device/platform, specifying that `--platform` option during the build and run.
487488

489+
<a name="troubleshooting-image-too-large"></a>
490+
491+
### Container image is too large
492+
493+
Unfortunately, the image size is due to the presence of both Selenium and Playwright. (the latter requiring its own set of browsers)
494+
495+
Should you need to use Robot Framework in embedded devices, this is too much.
496+
497+
Instead, a basic multi-arch container (under 200MB) can be found in this public container registry: [Robot Framework for Embedded Multi-Arch Container](https://gitlab.com/gitlab-accelerates-embedded/comp/robot-for-embdd/container_registry).
498+
499+
It is built as part of the [Robot Framework for Embedded](https://gitlab.com/explore/catalog/gitlab-accelerates-embedded/comp/robot-for-embdd).
500+
488501
<a name="please-contribute"></a>
489502

490503
## Please contribute!

0 commit comments

Comments
 (0)