You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Sources/SPIManifest/Documentation.docc/CommonUseCases.md
+15-11Lines changed: 15 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -74,29 +74,33 @@ There is also a `target:` key in order to configure a specific target instead of
74
74
75
75
Package authors can also use the `.spi.yml` file to configure custom docker base images for our Linux builds.
76
76
77
-
We build packages for Linux with docker commands using the official Swift docker images:
77
+
We build packages for Linux with docker commands using our own images based on the official Swift docker images:
78
78
79
79
```bash
80
-
docker run --rm -v "$PWD":/host -w /host swift:5.7 swift build
80
+
docker run --rm -v "$PWD":/host -w /host registry.gitlab.com/finestructure/spi-images:basic-5.8-latest swift build
81
81
```
82
82
83
-
Some packages however have additional operating system level dependencies that the official Swift images do not provide.
83
+
Our default image comes with a few dependencies pre-installed which you can review via its [`Dockerfile`](https://gitlab.com/finestructure/spi-images/-/blob/main/Dockerfile).
84
84
85
-
If this is the case for your package, you can use our [images derived from the official Swift docker images](https://gitlab.com/finestructure/spi-images/-/blob/main/Dockerfile), which include some common Linux packages.
85
+
There might also be other, more specialised `Dockerfiles` that match your dependencies, for example [`Dockerfile.AppKid`](https://gitlab.com/finestructure/spi-images/-/blob/main/Dockerfile.AppKid). It may be worth reviewing the `Dockerfile`s in the [`spi-images` repository for matches](https://gitlab.com/finestructure/spi-images/-/tree/main).
86
86
87
-
Here's an example:
87
+
As mentioned above, we are referencing the basic image by default, so if `Dockerfile` matches your requirements you do not need to add an `image:` clause to your `.spi.yml` file at all.
88
+
89
+
If you would like to reference a specialized `Dockerfile`, like for instance `Dockerfile.AppKid`, use the following `image:` clause:
If your package requires additional dependencies not covered by any of the existing images, please [open an issue](https://github.com/SwiftPackageIndex/SwiftPackageIndex-Server/issues/new/choose) so that we can either add them to the basic image if they are of a general nature or create a new specialized image.
0 commit comments