Skip to content

Commit 5aaa3d2

Browse files
committed
Update swift-ci/README to add missing required build parameters for using the CI Dockerfiles. Also normalize some whitespace.
1 parent 0c45417 commit 5aaa3d2

File tree

1 file changed

+5
-10
lines changed

1 file changed

+5
-10
lines changed

swift-ci/README.md

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,17 @@
22

33
Swift.org uses Docker based virtual build environment to build & qualify Swift toolchains on Linux.
44

5-
The Continuous Integration system uses the Dockerfiles in this directory to define the virtual build environment,
6-
then runs the build and qualification steps inside a docker container based on the image.
5+
The Continuous Integration system uses the Dockerfiles in this directory to define the virtual build environment, then runs the build and qualification steps inside a docker container based on the image.
76

87
## Directory Structure
98

10-
The Dockerfiles used for Continuous Integration are layed out under the top level `swift-ci` directory.
11-
Under that, we have a directory for each of the target branches, e.g.
12-
Continuous Integration for Swift's `master` branch uses the `swift-ci/master` Dockerfiles.
9+
The Dockerfiles used for Continuous Integration are layed out under the top level `swift-ci` directory. Under that, we have a directory for each of the target branches, e.g. Continuous Integration for Swift's `main` branch uses the `swift-ci/master` Dockerfiles.
1310

1411
There is also a specific directory (`swift-docc-render`) for the Dockerfile used to build Swift-DocC-Render. Swift-DocC-Render builds separately from the rest of the projects in the Swift toolchain and ships a pre-built copy for use in the toolchain in the Swift-DocC-Render-Artifact repository.
1512

1613
## Continuous Integration
1714

18-
This system is designed to support many distributions.
19-
Once a working Dockerfile is added to this repository,
20-
we set up Continuous Integration jobs to produce toolchains for the distribution and publish them on Swift.org.
15+
This system is designed to support many distributions. Once a working Dockerfile is added to this repository, we set up Continuous Integration jobs to produce toolchains for the distribution and publish them on Swift.org.
2116

2217
## Local development & testing
2318

@@ -27,7 +22,7 @@ First build & tag the Dockerfile:
2722
docker build -f <dockerfile path> . -t <some tag>
2823
```
2924

30-
Next run the Swift build using that Docker image
25+
Next, run the Swift build using that Docker image:
3126

3227
```bash
3328
docker run \
@@ -37,7 +32,7 @@ docker run \
3732
-v <some docker volume name>:/home/build-user \
3833
-w /home/build-user/ \
3934
<docker image tag from above> \
40-
/bin/bash -lc "cp -r /source/* /home/build-user/; ./swift/utils/build-script --preset buildbot_linux"
35+
/bin/bash -lc "cp -r /source/* /home/build-user/; ./swift/utils/build-script --preset buildbot_linux install_destdir=/home/build-user/swift-install installable_package=/home/build-user/swift-DEVELOPMENT-SNAPSHOT-$(date +'%F')-a.tar.gz"
4136
```
4237

4338
## Contributions

0 commit comments

Comments
 (0)