Skip to content

Commit fa7523d

Browse files
author
MarcoFalke
committed
ci: Extend docs
1 parent fa493ef commit fa7523d

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

ci/README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,16 @@ and numbered according to which stage and lifecycle step it belongs to.
88

99
### Running a stage locally
1010

11+
Be aware that the tests will be built and run in-place, so please run at your own risk.
12+
If the repository is not a fresh git clone, you might have to clean files from previous builds or test runs first.
13+
14+
The ci needs to perform various sysadmin tasks such as installing packages or writing to the user's home directory.
15+
While most of the actions are done inside a docker container, this is not possible for all. Thus, cache directories,
16+
such as the depends cache or ccache, are mounted as read-write into the docker container. While it should be fine to run
17+
the ci system locally on you development box, the ci scripts can generally be assumed to have received less review and
18+
testing compared to other parts of the codebase. If you want to keep the work tree clean, you might want to run the ci
19+
system in a virtual machine with a Linux operating system of your choice.
20+
1121
To allow for a wide range of tested environments, but also ensure reproducibility to some extent, the test stage
1222
requires `docker` to be installed. To install all requirements on Ubuntu, run
1323

@@ -26,6 +36,3 @@ To run the test stage with a specific configuration,
2636
```
2737
FILE_ENV="./ci/test/00_setup_env_arm.sh" ./ci/test_run_all.sh
2838
```
29-
30-
Be aware that the tests will be build and run in-place, so please run at your own risk.
31-
If the repository is not a fresh git clone, you might have to clean files from previous builds or test runs first.

0 commit comments

Comments
 (0)