Skip to content

Commit 51987ec

Browse files
README: update development setup command (#77)
Modifications: * `README`: update `docker-compose` command for local testing * update Docker documentation in `docker-compose.yaml`
1 parent b98f1a4 commit 51987ec

File tree

2 files changed

+4
-5
lines changed

2 files changed

+4
-5
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,5 +151,5 @@ It has source files that are excluded in `Package.swift`.
151151
We provide a Docker environment for this package. This will automatically start a local Kafka server and run the package tests.
152152

153153
```bash
154-
docker-compose -f docker/docker-compose.yaml run swift-kafka-gsoc
154+
docker-compose -f docker/docker-compose.yaml run test
155155
```

docker/docker-compose.yaml

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Usage: docker-compose -f docker/docker-compose.yaml run swift-kafka-gsoc
1+
# this file is not designed to be run directly
2+
# instead, use the docker-compose.<os>.<swift> files
3+
# eg docker-compose -f docker/docker-compose.yaml -f docker/docker-compose.2204.57.yaml run test
24
version: "3.9"
35
services:
46

@@ -21,9 +23,6 @@ services:
2123
environment:
2224
KAFKA_HOST: kafka
2325

24-
# Swift on Server CI
25-
# e.g. docker-compose -f docker/docker-compose.yaml -f docker/docker-compose.2204.57.yaml run test
26-
2726
runtime-setup:
2827
image: swift-kafka-gsoc:default
2928
build:

0 commit comments

Comments
 (0)