-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs; use docker compose wording instead of docker-compose
- Loading branch information
Showing
6 changed files
with
52 additions
and
35 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
<!-- markdownlint-disable-next-line first-line-heading --> | ||
### Example using `up-flags` | ||
|
||
Specify flags to pass to the `docker-compose up`. Default is none. Can be used | ||
Specify flags to pass to the `docker compose up`. Default is none. Can be used | ||
to pass the `--build` flag, for example, if you want persistent volumes to be | ||
deleted as well during cleanup. A full list of flags can be found in the | ||
[docker-compose up documentation](https://docs.docker.com/compose/reference/up/). | ||
[docker compose up documentation](https://docs.docker.com/compose/reference/up/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -19,7 +19,7 @@ | |
</div> | ||
<!-- start description --> | ||
|
||
This action runs your docker-compose file and clean up before action finished | ||
This action runs your [docker compose](https://docs.docker.com/reference/compose-file/) file and clean up before action finished | ||
|
||
<!-- end description --> | ||
|
||
|
@@ -30,16 +30,16 @@ This action runs your docker-compose file and clean up before action finished | |
|
||
### Action | ||
|
||
The action will run `docker-compose up` to start the services defined in the given compose file(s). | ||
The action will run `docker compose up` to start the services defined in the given compose file(s). | ||
The compose file(s) can be specified using the `compose-file` input. | ||
Some extra options can be passed to the `docker-compose up` command using the `up-flags` input. | ||
Some extra options can be passed to the `docker compose up` command using the `up-flags` input. | ||
|
||
### Post hook | ||
|
||
On post hook, the action will run `docker-compose down` to clean up the services. | ||
On post hook, the action will run `docker compose down` to clean up the services. | ||
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. | ||
|
||
Some extra options can be passed to the `docker-compose down` command using the `down-flags` input. | ||
Some extra options can be passed to the `docker compose down` command using the `down-flags` input. | ||
|
||
<!-- start usage --> | ||
|
||
|
@@ -52,21 +52,21 @@ Some extra options can be passed to the `docker-compose down` command using the | |
# Default: ./docker-compose.yml | ||
compose-file: "" | ||
|
||
# Description: Services to perform docker-compose up. | ||
# Description: Services to perform docker compose up. | ||
# | ||
services: "" | ||
|
||
# Description: Additional options to pass to `docker-compose up` command. | ||
# Description: Additional options to pass to `docker compose up` command. | ||
# | ||
# Default: | ||
up-flags: "" | ||
|
||
# Description: Additional options to pass to `docker-compose down` command. | ||
# Description: Additional options to pass to `docker compose down` command. | ||
# | ||
# Default: | ||
down-flags: "" | ||
|
||
# Description: Additional options to pass to `docker-compose` command. | ||
# Description: Additional options to pass to `docker compose` command. | ||
# | ||
# Default: | ||
compose-flags: "" | ||
|
@@ -82,7 +82,7 @@ Some extra options can be passed to the `docker-compose down` command using the | |
compose-version: "" | ||
|
||
# Description: The GitHub token used to create an authenticated client (to fetch | ||
# the latest version of docker-compose). | ||
# the latest version of docker compose). | ||
# | ||
# Default: ${{ github.token }} | ||
github-token: "" | ||
|
@@ -97,13 +97,13 @@ Some extra options can be passed to the `docker-compose down` command using the | |
| **Input** | **Description** | **Default** | **Required** | | ||
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------ | ------------ | | ||
| <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>services</code> | Services to perform docker-compose up. | | **false** | | ||
| <code>up-flags</code> | Additional options to pass to <code>docker-compose up</code> command. | | **false** | | ||
| <code>down-flags</code> | Additional options to pass to <code>docker-compose down</code> command. | | **false** | | ||
| <code>compose-flags</code> | Additional options to pass to <code>docker-compose</code> command. | | **false** | | ||
| <code>services</code> | Services to perform docker compose up. | | **false** | | ||
| <code>up-flags</code> | Additional options to pass to <code>docker compose up</code> command. | | **false** | | ||
| <code>down-flags</code> | Additional options to pass to <code>docker compose down</code> command. | | **false** | | ||
| <code>compose-flags</code> | Additional options to pass to <code>docker compose</code> command. | | **false** | | ||
| <code>cwd</code> | Current working directory | <code>${{ github.workspace }}</code> | **false** | | ||
| <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** | | ||
| <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** | | ||
| <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** | | ||
<!-- end inputs --> | ||
<!-- start outputs --> | ||
|
@@ -125,14 +125,14 @@ jobs: | |
steps: | ||
- uses: actions/checkout@v4 | ||
|
||
- name: Run docker-compose | ||
- name: Run docker compose | ||
uses: hoverkraft-tech/[email protected] | ||
with: | ||
compose-file: "./docker/docker-compose.yml" | ||
|
||
- name: Execute tests in the running services | ||
run: | | ||
docker-compose exec test-app pytest | ||
docker compose exec test-app pytest | ||
``` | ||
<!-- start [.github/ghadocs/examples/] --> | ||
|
@@ -152,7 +152,7 @@ steps: | |
### Example using `services` | ||
|
||
Perform `docker-compose up` to some given service instead of all of them | ||
Perform `docker compose up` to some given service instead of all of them | ||
|
||
```yaml | ||
steps: | ||
|
@@ -168,24 +168,24 @@ steps: | |
|
||
### Example using `up-flags` | ||
|
||
Specify flags to pass to the `docker-compose up`. Default is none. Can be used | ||
Specify flags to pass to the `docker compose up`. Default is none. Can be used | ||
to pass the `--build` flag, for example, if you want persistent volumes to be | ||
deleted as well during cleanup. A full list of flags can be found in the | ||
[docker-compose up documentation](https://docs.docker.com/compose/reference/up/). | ||
[docker compose up documentation](https://docs.docker.com/compose/reference/up/). | ||
|
||
### Example using `down-flags` | ||
|
||
Specify flags to pass to the `docker-compose down` command during cleanup. | ||
Specify flags to pass to the `docker compose down` command during cleanup. | ||
Default is none. Can be used to pass the `--volumes` flag, for example, if you | ||
want persistent volumes to be deleted as well during cleanup. A full list of | ||
flags can be found in the | ||
[docker-compose down documentation](https://docs.docker.com/compose/reference/down/). | ||
[docker compose down documentation](https://docs.docker.com/compose/reference/down/). | ||
|
||
### Example using `compose-flags` | ||
|
||
Specify flags to pass to the `docker-compose` command. Default is none. A full | ||
Specify flags to pass to the `docker compose` command. Default is none. A full | ||
list of flags can be found in the | ||
[docker-compose documentation](https://docs.docker.com/compose/reference/#command-options-overview-and-help). | ||
[docker compose documentation](https://docs.docker.com/compose/reference/#command-options-overview-and-help). | ||
|
||
```yaml | ||
steps: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters