Skip to content

Commit a7b5acf

Browse files
committed
Update documentation
1 parent ce05c9f commit a7b5acf

File tree

1 file changed

+6
-15
lines changed

1 file changed

+6
-15
lines changed

Diff for: src/ci/docker/README.md

+6-15
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,20 @@
11
# Docker images for CI
22

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

7-
```
8-
./src/ci/docker/run.sh $image_name
9-
```
10-
11-
for example:
7+
To run a specific CI job locally, you can use the following script:
128

139
```
14-
./src/ci/docker/run.sh x86_64-gnu
10+
python3 ./src/ci/github-actions/ci.py run-local <job-name>
1511
```
1612

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

20-
To match conditions in rusts CI, also set the environment variable `DEPLOY=1`, e.g.:
21-
```
22-
DEPLOY=1 ./src/ci/docker/run.sh x86_64-gnu
23-
```
24-
2516
**NOTE**: In CI, the script outputs the artifacts to the `obj` directory,
26-
while locally, to the `obj/$image_name` directory. This is primarily to prevent
17+
while locally, to the `obj/<image-name>` directory. This is primarily to prevent
2718
strange linker errors when using multiple Docker images.
2819

2920
## Local Development

0 commit comments

Comments
 (0)