Skip to content

Commit 5eb4b07

Browse files
committed
ci: Switch to shared GitHub actions for soundness checks
1 parent adc5fbe commit 5eb4b07

12 files changed

+56
-417
lines changed

.github/workflows/pull_request.yml

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
name: PR
2+
3+
on:
4+
pull_request:
5+
types: [opened, reopened, synchronize]
6+
7+
jobs:
8+
soundness:
9+
name: Soundness
10+
uses: apple/swift-nio/.github/workflows/soundness.yml@main
11+
with:
12+
api_breakage_check_container_image: "swift:6.0-noble"
13+
api_breakage_check_enabled: false
14+
docs_check_container_image: "swift:6.0-noble"
15+
license_header_check_project_name: "SwiftContainerPlugin"
16+
shell_check_container_image: "swift:6.0-noble"

.licenseignore

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
**/*.docc/*
2+
**/*.md
3+
**/.gitignore
4+
**/Package.resolved
5+
**/Package.swift
6+
**/README.md
7+
.dockerignore
8+
.github/*
9+
.gitignore
10+
.licenseignore
11+
.mailmap
12+
.spi.yml
13+
.swift-format
14+
.swiftformatignore
15+
CODE_OF_CONDUCT.md
16+
CONTRIBUTING.md
17+
CONTRIBUTORS.txt
18+
LICENSE.txt
19+
NOTICE.txt
20+
Package.resolved
21+
Package.swift
22+
README.md
23+
SECURITY.md
24+
Tests/ContainerRegistryTests/Resources/*
25+
Vendor/*
26+
docker-compose.yaml
27+
docker/*
28+
scripts/*

.spi.yml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
version: 1
2+
builder:
3+
configs:
4+
- documentation_targets:
5+
- ContainerRegistry
6+
- ContainerImageBuilderPlugin

.swiftformatignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Vendor/*

Sources/ContainerImageBuilderPluginDocumentation/Documentation.docc/ContainerImageBuilderPlugin.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The plugin does not require a container runtime to be installed locally in order
2020

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

23-
## Install a Swift SDK for cross-compilation on macOS
23+
### Install a Swift SDK for cross-compilation on macOS
2424

2525
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:
2626

@@ -36,7 +36,7 @@ swift-6.0.1-RELEASE_static-linux-0.0.1
3636

3737
> 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)
3838
39-
## Add the plugin to your project
39+
### Add the plugin to your project
4040

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

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

62-
## Add your registry credentials to .netrc
62+
### Add your registry credentials to .netrc
6363

6464
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:
6565

@@ -69,7 +69,7 @@ machine registry.example.com
6969
password mypassword
7070
```
7171

72-
## Build and package your service
72+
### Build and package your service
7373

7474
`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:
7575

@@ -110,7 +110,7 @@ registry.example.com/myservice@sha256:a3f75d0932d052dd9d448a1c9040b16f9f2c2ed919
110110

111111
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.
112112

113-
## Run your service
113+
### Run your service
114114

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

scripts/check-for-broken-symlinks.sh

-50
This file was deleted.

scripts/check-for-docc-warnings.sh

-53
This file was deleted.

scripts/check-for-unacceptable-language.sh

-50
This file was deleted.

scripts/check-license-headers.sh

-114
This file was deleted.

0 commit comments

Comments
 (0)