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
6 changes: 1 addition & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ The default policy for taking contributions is “Squash and Merge” - because

The CI will do this for you, but a project maintainer must kick it off for you. Currently all versions of Swift >= 5.9 are supported.

If you wish to test this locally you have two options [act](https://github.com/nektos/act) and Docker Compose files.
If you wish to test this locally use [act](https://github.com/nektos/act).

#### Act

Expand All @@ -77,10 +77,6 @@ act pull_request
```
Note that SwiftNIO matrix testing makes use of nightly builds, so you may want to make use of the ```--action-offline-mode``` to avoid repulling those.

#### Docker Compose files

You can use the docker-compose files. For example usage of Docker Compose see the main [README](./README.md#an-alternative-using-docker-compose)

### Make sure your code is performant

SwiftNIO has been created to be high performance. The integration tests cover some measures of performance including allocations which should be avoided if possible. For help with allocation problems refer to the guide to [allocation debugging](./docs/debugging-allocations.md)
Expand Down
25 changes: 0 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -294,31 +294,6 @@ If all goes well, you'll see the message echoed back to you.
To work on SwiftNIO in Xcode, you can just open the `Package.swift`
file in Xcode and use Xcode's support for SwiftPM Packages.

### An alternative: using `docker-compose`

Alternatively, you may want to develop or test with `docker-compose`.

First make sure you have [Docker](https://www.docker.com/community-edition) installed, next run the following commands:

- `docker-compose -f docker/docker-compose.yaml run test`

Will create a base image with Swift runtime and other build and test dependencies, compile SwiftNIO and run the unit and integration tests

- `docker-compose -f docker/docker-compose.yaml up echo`

Will create a base image, compile SwiftNIO, and run a sample `NIOEchoServer` on
`localhost:9999`. Test it by `echo Hello SwiftNIO | nc localhost 9999`.

- `docker-compose -f docker/docker-compose.yaml up http`

Will create a base image, compile SwiftNIO, and run a sample `NIOHTTP1Server` on
`localhost:8888`. Test it by `curl http://localhost:8888`

- `docker-compose -f docker/docker-compose.yaml -f docker/docker-compose.2204.57.yaml run test`

Will create a base image using Ubuntu 22.04 and Swift 5.7, compile SwiftNIO and run the unit and integration tests. Files exist for other Ubuntu and swift versions in the docker directory.


## Developing SwiftNIO

*Note*: This section is only relevant if you would like to develop SwiftNIO yourself. You can ignore the information here if you just want to use SwiftNIO as a SwiftPM package.
Expand Down
41 changes: 0 additions & 41 deletions dev/update-benchmark-thresholds.sh

This file was deleted.

Loading