From bdbabb28278b34dfc9a81bd2d32cdfbbcee5dae1 Mon Sep 17 00:00:00 2001 From: Jaleel Akbashev Date: Mon, 5 May 2025 13:08:27 +0200 Subject: [PATCH] Removed Docker references as repo moved to Github actions (#3227) ### Motivation: A bit confusing to see docker mentioned in Readme file, when in reality you can't run docker compose anymore. ### Modifications: Updated README and CONTRIBUTING files, removed some scripts. ### Result: No mentions of docker so users are not confused. Co-authored-by: Rick Newton-Rogers --- CONTRIBUTING.md | 6 +---- README.md | 25 ------------------ dev/update-benchmark-thresholds.sh | 41 ------------------------------ 3 files changed, 1 insertion(+), 71 deletions(-) delete mode 100755 dev/update-benchmark-thresholds.sh diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 05b102e75..61941866d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 @@ -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) diff --git a/README.md b/README.md index 3621501d2..029db3985 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/dev/update-benchmark-thresholds.sh b/dev/update-benchmark-thresholds.sh deleted file mode 100755 index 452cb14b7..000000000 --- a/dev/update-benchmark-thresholds.sh +++ /dev/null @@ -1,41 +0,0 @@ -#!/bin/bash -##===----------------------------------------------------------------------===## -## -## This source file is part of the SwiftNIO open source project -## -## Copyright (c) 2023 Apple Inc. and the SwiftNIO project authors -## Licensed under Apache License v2.0 -## -## See LICENSE.txt for license information -## See CONTRIBUTORS.txt for the list of SwiftNIO project authors -## -## SPDX-License-Identifier: Apache-2.0 -## -##===----------------------------------------------------------------------===## -##===----------------------------------------------------------------------===## -## -## This source file is part of the SwiftCertificates open source project -## -## Copyright (c) 2023 Apple Inc. and the SwiftCertificates project authors -## Licensed under Apache License v2.0 -## -## See LICENSE.txt for license information -## See CONTRIBUTORS.txt for the list of SwiftCertificates project authors -## -## SPDX-License-Identifier: Apache-2.0 -## -##===----------------------------------------------------------------------===## - -set -eu -set -o pipefail - -here="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" -target_repo=${2-"$here/.."} - -for f in 58 59 510 nightly-6.0 main; do - echo "swift$f" - - docker_file=$(ls "$target_repo/docker/docker-compose."*"$f"*".yaml") - - docker-compose -f docker/docker-compose.yaml -f "$docker_file" run update-benchmark-baseline -done