Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Kobzol committed Dec 29, 2024
1 parent ce05c9f commit a7b5acf
Showing 1 changed file with 6 additions and 15 deletions.
21 changes: 6 additions & 15 deletions src/ci/docker/README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,20 @@
# Docker images for CI

This folder contains a bunch of docker images used by the continuous integration
(CI) of Rust. An script is accompanied (`run.sh`) with these images to actually
execute them. To test out an image execute:
(CI) of Rust. A script is accompanied (`run.sh`) with these images to actually
execute them.

```
./src/ci/docker/run.sh $image_name
```

for example:
To run a specific CI job locally, you can use the following script:

```
./src/ci/docker/run.sh x86_64-gnu
python3 ./src/ci/github-actions/ci.py run-local <job-name>
```

Images will output artifacts in an `obj/$image_name` dir at the root of a repository. Note
Images will output artifacts in an `obj/<image-name>` dir at the root of a repository. Note
that the script will overwrite the contents of this directory.

To match conditions in rusts CI, also set the environment variable `DEPLOY=1`, e.g.:
```
DEPLOY=1 ./src/ci/docker/run.sh x86_64-gnu
```

**NOTE**: In CI, the script outputs the artifacts to the `obj` directory,
while locally, to the `obj/$image_name` directory. This is primarily to prevent
while locally, to the `obj/<image-name>` directory. This is primarily to prevent
strange linker errors when using multiple Docker images.

## Local Development
Expand Down

0 comments on commit a7b5acf

Please sign in to comment.