Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions .github/workflows/pull_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: PR

on:
pull_request:
types: [opened, reopened, synchronize]

jobs:
soundness:
name: Soundness
uses: apple/swift-nio/.github/workflows/soundness.yml@main
with:
api_breakage_check_container_image: "swift:6.0-noble"
api_breakage_check_enabled: false
docs_check_container_image: "swift:6.0-noble"
license_header_check_project_name: "SwiftContainerPlugin"
shell_check_container_image: "swift:6.0-noble"
28 changes: 28 additions & 0 deletions .licenseignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
**/*.docc/*
**/*.md
**/.gitignore
**/Package.resolved
**/Package.swift
**/README.md
.dockerignore
.github/*
.gitignore
.licenseignore
.mailmap
.spi.yml
.swift-format
.swiftformatignore
CODE_OF_CONDUCT.md
CONTRIBUTING.md
CONTRIBUTORS.txt
LICENSE.txt
NOTICE.txt
Package.resolved
Package.swift
README.md
SECURITY.md
Tests/ContainerRegistryTests/Resources/*
Vendor/*
docker-compose.yaml
docker/*
scripts/*
6 changes: 6 additions & 0 deletions .spi.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
version: 1
builder:
configs:
- documentation_targets:
- ContainerRegistry
- ContainerImageBuilderPlugin
1 change: 1 addition & 0 deletions .swiftformatignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Vendor/*
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The plugin does not require a container runtime to be installed locally in order

Try one of the [Examples](../../../Examples)

## Install a Swift SDK for cross-compilation on macOS
### Install a Swift SDK for cross-compilation on macOS

If you are running on macOS, you can use a [Swift SDK](https://github.com/apple/swift-evolution/blob/main/proposals/0387-cross-compilation-destinations.md) to cross-compile your server executable for Linux. Either:

Expand All @@ -36,7 +36,7 @@ swift-6.0.1-RELEASE_static-linux-0.0.1

> Note: To use the Static Linux SDK on macOS, you must [install the open source Swift toolchain from swift.org](https://www.swift.org/documentation/articles/static-linux-getting-started.html#installing-the-sdk)

## Add the plugin to your project
### Add the plugin to your project

Swift Container Plugin is distributed as a Swift Package Manager package. Use the `swift package` command to add it to your project:

Expand All @@ -59,7 +59,7 @@ Check that `ContainerImageBuilder` is now available in Swift Package Manager:
‘build-container-image’ (plugin ‘ContainerImageBuilder’ in package ‘swift-container-plugin)
```

## Add your registry credentials to .netrc
### Add your registry credentials to .netrc

Many registries require authentication in order to push images, or even pull them. The plugin can read your registry credentials from a `.netrc` file in your home directory. You can add a netrc record for each registry you need to use:

Expand All @@ -69,7 +69,7 @@ machine registry.example.com
password mypassword
```

## Build and package your service
### Build and package your service

`build-container-image` takes care of building your service, packaging it in a container image and uploading it to a container registry, all in one command:

Expand Down Expand Up @@ -110,7 +110,7 @@ registry.example.com/myservice@sha256:a3f75d0932d052dd9d448a1c9040b16f9f2c2ed919

When it finishes, ContainerImageBuilder prints a reference identifying the new image. Any standard container runtime can use the reference to pull and run your service.

## Run your service
### Run your service

For example, you could use `podman` to run the service locally, making it available on port 8080:

Expand Down
50 changes: 0 additions & 50 deletions scripts/check-for-broken-symlinks.sh

This file was deleted.

53 changes: 0 additions & 53 deletions scripts/check-for-docc-warnings.sh

This file was deleted.

50 changes: 0 additions & 50 deletions scripts/check-for-unacceptable-language.sh

This file was deleted.

114 changes: 0 additions & 114 deletions scripts/check-license-headers.sh

This file was deleted.

Loading