You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+24-24
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@
19
19
</div>
20
20
<!-- start description -->
21
21
22
-
This action runs your docker-compose file and clean up before action finished
22
+
This action runs your [dockercompose](https://docs.docker.com/reference/compose-file/) file and clean up before action finished
23
23
24
24
<!-- end description -->
25
25
@@ -30,16 +30,16 @@ This action runs your docker-compose file and clean up before action finished
30
30
31
31
### Action
32
32
33
-
The action will run `docker-compose up` to start the services defined in the given compose file(s).
33
+
The action will run `dockercompose up` to start the services defined in the given compose file(s).
34
34
The compose file(s) can be specified using the `compose-file` input.
35
-
Some extra options can be passed to the `docker-compose up` command using the `up-flags` input.
35
+
Some extra options can be passed to the `dockercompose up` command using the `up-flags` input.
36
36
37
37
### Post hook
38
38
39
-
On post hook, the action will run `docker-compose down` to clean up the services.
39
+
On post hook, the action will run `dockercompose down` to clean up the services.
40
40
In [debug mode](https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/troubleshooting-workflows/enabling-debug-logging), the logs of the running services are printed before the cleanup.
41
41
42
-
Some extra options can be passed to the `docker-compose down` command using the `down-flags` input.
42
+
Some extra options can be passed to the `dockercompose down` command using the `down-flags` input.
43
43
44
44
<!-- start usage -->
45
45
@@ -52,21 +52,21 @@ Some extra options can be passed to the `docker-compose down` command using the
52
52
# Default: ./docker-compose.yml
53
53
compose-file: ""
54
54
55
-
# Description: Services to perform docker-compose up.
55
+
# Description: Services to perform dockercompose up.
56
56
#
57
57
services: ""
58
58
59
-
# Description: Additional options to pass to `docker-compose up` command.
59
+
# Description: Additional options to pass to `dockercompose up` command.
60
60
#
61
61
# Default:
62
62
up-flags: ""
63
63
64
-
# Description: Additional options to pass to `docker-compose down` command.
64
+
# Description: Additional options to pass to `dockercompose down` command.
65
65
#
66
66
# Default:
67
67
down-flags: ""
68
68
69
-
# Description: Additional options to pass to `docker-compose` command.
69
+
# Description: Additional options to pass to `dockercompose` command.
70
70
#
71
71
# Default:
72
72
compose-flags: ""
@@ -82,7 +82,7 @@ Some extra options can be passed to the `docker-compose down` command using the
82
82
compose-version: ""
83
83
84
84
# Description: The GitHub token used to create an authenticated client (to fetch
85
-
# the latest version of docker-compose).
85
+
# the latest version of dockercompose).
86
86
#
87
87
# Default: ${{ github.token }}
88
88
github-token: ""
@@ -97,13 +97,13 @@ Some extra options can be passed to the `docker-compose down` command using the
| <code>compose-file</code> | Path to compose file(s). It can be a list of files. It can be absolute or relative to the current working directory (cwd). | <code>./docker-compose.yml</code> | **false** |
| <code>up-flags</code> | Additional options to pass to <code>dockercompose up</code> command. | | **false** |
102
+
| <code>down-flags</code> | Additional options to pass to <code>dockercompose down</code> command. | | **false** |
103
+
| <code>compose-flags</code> | Additional options to pass to <code>dockercompose</code> command. | | **false** |
104
104
| <code>cwd</code> | Current working directory | <code>${{ github.workspace }}</code> | **false** |
105
105
| <code>compose-version</code> | Compose version to use.<br />If null (default), it will use the current installed version.<br />If "latest", it will install the latest version. | | **false** |
106
-
| <code>github-token</code> | The GitHub token used to create an authenticated client (to fetch the latest version of docker-compose). | <code>${{ github.token }}</code> | **false** |
106
+
| <code>github-token</code> | The GitHub token used to create an authenticated client (to fetch the latest version of dockercompose). | <code>${{ github.token }}</code> | **false** |
107
107
108
108
<!-- end inputs -->
109
109
<!-- start outputs -->
@@ -125,14 +125,14 @@ jobs:
125
125
steps:
126
126
- uses: actions/checkout@v4
127
127
128
-
- name: Run docker-compose
128
+
- name: Run dockercompose
129
129
uses: hoverkraft-tech/compose-action@v2.0.1
130
130
with:
131
131
compose-file: "./docker/docker-compose.yml"
132
132
133
133
- name: Execute tests in the running services
134
134
run: |
135
-
docker-compose exec test-app pytest
135
+
dockercompose exec test-app pytest
136
136
```
137
137
138
138
<!-- start [.github/ghadocs/examples/] -->
@@ -152,7 +152,7 @@ steps:
152
152
153
153
### Example using `services`
154
154
155
-
Perform `docker-compose up` to some given service instead of all of them
155
+
Perform `dockercompose up` to some given service instead of all of them
156
156
157
157
```yaml
158
158
steps:
@@ -168,24 +168,24 @@ steps:
168
168
169
169
### Example using `up-flags`
170
170
171
-
Specify flags to pass to the `docker-compose up`. Default is none. Can be used
171
+
Specify flags to pass to the `dockercompose up`. Default is none. Can be used
172
172
to pass the `--build` flag, for example, if you want persistent volumes to be
173
173
deleted as well during cleanup. A full list of flags can be found in the
174
-
[docker-compose up documentation](https://docs.docker.com/compose/reference/up/).
174
+
[dockercompose up documentation](https://docs.docker.com/compose/reference/up/).
175
175
176
176
### Example using `down-flags`
177
177
178
-
Specify flags to pass to the `docker-compose down` command during cleanup.
178
+
Specify flags to pass to the `dockercompose down` command during cleanup.
179
179
Default is none. Can be used to pass the `--volumes` flag, for example, if you
180
180
want persistent volumes to be deleted as well during cleanup. A full list of
181
181
flags can be found in the
182
-
[docker-compose down documentation](https://docs.docker.com/compose/reference/down/).
182
+
[dockercompose down documentation](https://docs.docker.com/compose/reference/down/).
183
183
184
184
### Example using `compose-flags`
185
185
186
-
Specify flags to pass to the `docker-compose` command. Default is none. A full
186
+
Specify flags to pass to the `dockercompose` command. Default is none. A full
0 commit comments