diff options
| author | Jakub Beránek <jakub.beranek@vsb.cz> | 2024-12-29 19:20:39 +0100 |
|---|---|---|
| committer | Jakub Beránek <berykubik@gmail.com> | 2025-01-07 18:15:13 +0100 |
| commit | e4b6ccef43133bae1e2396f3375aaeeb799461ca (patch) | |
| tree | 333b8e635c1c3b4e1675a46947ef9617b45e8197 /src | |
| parent | 0cc11f8c480cce40859ecb82fd8db54771b6aba7 (diff) | |
| download | rust-e4b6ccef43133bae1e2396f3375aaeeb799461ca.tar.gz rust-e4b6ccef43133bae1e2396f3375aaeeb799461ca.zip | |
Update documentation
Diffstat (limited to 'src')
| -rw-r--r-- | src/ci/docker/README.md | 27 |
1 files changed, 14 insertions, 13 deletions
diff --git a/src/ci/docker/README.md b/src/ci/docker/README.md index 508b7b40c01..2f52ff5a99a 100644 --- a/src/ci/docker/README.md +++ b/src/ci/docker/README.md @@ -1,29 +1,30 @@ # 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 -``` +Note that a single Docker image can be used by multiple CI jobs, so the job name +is the important thing that you should know. You can examine the existing CI jobs in +the [`jobs.yml`](../github-actions/jobs.yml) file. -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 -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.: +For example, to run the `x86_64-gnu-llvm-18-1` job: ``` -DEPLOY=1 ./src/ci/docker/run.sh x86_64-gnu +python3 ./src/ci/github-actions/ci.py run-local x86_64-gnu-llvm-18-1 ``` +The job 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. `<image-name>` is set based on the +Docker image executed in the given CI job. + **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. For some Linux workflows (for example `x86_64-gnu-llvm-18-N`), the process is more involved. You will need to see which script is executed for the given workflow inside the [`jobs.yml`](../github-actions/jobs.yml) file and pass it through the `DOCKER_SCRIPT` environment variable. For example, to reproduce the `x86_64-gnu-llvm-18-3` workflow, you can run the following script: |