Skip to content

Commit a256a6b

Browse files
committed
Update spelling of "Docker Compose" bundle in various places.
1 parent 35db063 commit a256a6b

File tree

3 files changed

+13
-13
lines changed

3 files changed

+13
-13
lines changed

.github/workflows/test-setup-e2e-environment-action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ jobs:
3838
cypress-docker-image:
3939
hastus-docker-image:
4040
custom-docker-compose:
41-
# use custom docker-compose file
41+
# use custom Docker Compose file
4242
- ui-docker-image:
4343
hasura-docker-image:
4444
auth-docker-image:

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ CMD /bin/bash -c "source /tmp/read-secrets.sh && java -jar /.../xxx.jar"
6767

6868
Downloads and extract the latest version of the docker bundle. It uses the `gh` github command line tool to retrieve the bundle from the releases.
6969

70-
To see how docker-compose bundle is created and used, refer to [wiki](https://github.com/HSLdevcom/jore4/wiki/Infra#docker-compose-bundle)
70+
To see how Docker compose bundle is created and used, refer to [wiki](https://github.com/HSLdevcom/jore4/wiki/Infra#docker-compose-bundle)
7171

7272
Parameters:
7373
- with the `DOCKER_BUNDLE_PATH` environment variable you can set the destination folder to where the bundle is downloaded. Default "./docker"
@@ -96,7 +96,7 @@ docker compose -f ./docker/docker-compose.yml up -d jore4-testdb jore4-hasura jo
9696
# start up some dependency services with some overrides (e.g. pinned docker image versions) in a docker-compose.custom.yml file and build on demand (if using own repo's Dockerfile too)
9797
docker compose -f ./docker/docker-compose.yml -f ./docker/docker-compose.custom.yml up --build jore4-testdb jore4-hasura jore4-auth
9898

99-
# more info on docker-compose up command: https://docs.docker.com/engine/reference/commandline/compose_up/
99+
# more info on docker compose up command: https://docs.docker.com/engine/reference/commandline/compose_up/
100100
```
101101

102102
## Github Actions
@@ -139,14 +139,14 @@ steps:
139139

140140
### setup-e2e-environment
141141

142-
Retrieves a given version of the docker-compose bundle from the releases and runs it. Optionally
142+
Retrieves a given version of the Docker Compose bundle from the releases and runs it. Optionally
143143
can set given services' docker image versions.
144144

145-
To see how docker-compose bundle is created and used, refer to [wiki](https://github.com/HSLdevcom/jore4/wiki/Infra#docker-compose-bundle)
145+
To see how Docker Compose bundle is created and used, refer to [wiki](https://github.com/HSLdevcom/jore4/wiki/Infra#docker-compose-bundle)
146146

147147
Parameters:
148-
- bundle_version: Version of the docker-compose bundle to use (= github release version)
149-
- custom_docker_compose: Path for an additional docker-compose file to be used when starting up the environment.
148+
- bundle_version: Version of the Docker Compose bundle to use (= github release version)
149+
- custom_docker_compose: Path for an additional Docker Compose file to be used when starting up the environment.
150150
- ui_version, hasura_version, ... (*_version): Specific the docker image tag of the microservice to be used. For all options, see `/github-actions/setup-e2e-environment/action.yml`
151151

152152
Example usage:
@@ -173,7 +173,7 @@ Runs cypress e2e tests. It assumes that a container with the name `cypress` is a
173173
is parameterized to access all the tested containers. Best combine with the `setup-e2e-environment`
174174
action as the docker bundle already contains the latest version of the cypress tests.
175175

176-
To see how docker-compose bundle is created and used, refer to [wiki](https://github.com/HSLdevcom/jore4/wiki/Infra#docker-compose-bundle)
176+
To see how Docker Compose bundle is created and used, refer to [wiki](https://github.com/HSLdevcom/jore4/wiki/Infra#docker-compose-bundle)
177177

178178
Parameters:
179179
- test-tags: Specify which e2e tests to run. `""` to run all, `"@smoke @routes"` to run with given tags. Default: `"@smoke"`

github-actions/setup-e2e-environment/action.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
name: "Start e2e environment"
22
description:
3-
"Builds e2e environment with docker-compose and tests that services are
3+
"Builds e2e environment with docker compose and tests that services are
44
running."
55
inputs:
66
bundle_version:
77
description:
8-
Version of the docker-compose bundle to use (= github release version)
8+
Version of the Docker Compose bundle to use (= github release version)
99
required: false
1010
default: "e2e-docker-compose"
1111
ui_version:
@@ -76,7 +76,7 @@ inputs:
7676
default: ""
7777
custom_docker_compose:
7878
description:
79-
Path for an additional docker-compose file to be used when starting up the
79+
Path for an additional Docker Compose file to be used when starting up the
8080
environment. Can be used to e.g. run tests with the repository's own
8181
docker-compose.custom.yml setup
8282
required: false
@@ -85,7 +85,7 @@ inputs:
8585
runs:
8686
using: "composite"
8787
steps:
88-
- name: Download and extract e2e docker-compose release
88+
- name: Download and extract e2e Docker Compose release
8989
run: |
9090
mkdir -p ${{ github.workspace }}/docker
9191
curl -L https://github.com/HSLdevcom/jore4-tools/releases/download/${{ inputs.bundle_version }}/e2e-docker-compose.tar.gz --silent -o compose-bundle.tar.gz
@@ -94,7 +94,7 @@ runs:
9494
shell: bash
9595

9696
- name: Start e2e environment
97-
# use environment variables within the docker-compose bundle to override some images
97+
# use environment variables within the Docker Compose bundle to override some images
9898
env:
9999
UI_DOCKER_IMAGE: ${{ inputs.ui_version }}
100100
HASURA_DOCKER_IMAGE: ${{ inputs.hasura_version }}

0 commit comments

Comments
 (0)