actions/compose-action
1
0
Fork 0
mirror of https://github.com/hoverkraft-tech/compose-action.git synced 2026-01-11 15:13:06 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

docs: update actions and workflows documentation

Browse Source 
[skip ci]

Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
This commit is contained in:
hoverkraft-bot[bot] 2025-09-29 19:51:01 +00:00
parent 492e297766
commit 57a2375c11
1 changed files with 1 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -37,7 +37,7 @@ Some extra options can be passed to the `docker compose up` command using the `u
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.
Logs of the Docker Compose services are logged using GitHub `core.ts` API before the cleanup. Logs of the Docker Compose services are logged using GitHub `core.ts` API before the cleanup.
The log level can be set using the `services-log-level` input. The log level can be set using the `services-log-level` input.
The default is `debug`, which will only print logs if [debug mode](https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/troubleshooting-workflows/enabling-debug-logging) is switched on. The default is `debug`, which will only print logs if [debug mode](https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/troubleshooting-workflows/enabling-debug-logging) is switched on.
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.
@ -123,8 +123,6 @@ Some extra options can be passed to the `docker compose down` command using the
## Examples ## Examples
### Example using in a full workflow
```yaml ```yaml
name: Docker Compose Action name: Docker Compose Action
@ -147,8 +145,6 @@ jobs:
docker compose exec test-app pytest docker compose exec test-app pytest
``` ```
### Example Using environment variables
```yaml ```yaml
steps: steps:
- uses: actions/checkout@v4.2.2 - uses: actions/checkout@v4.2.2
@ -159,8 +155,6 @@ steps:
CUSTOM_VARIABLE: "test" CUSTOM_VARIABLE: "test"
``` ```
### 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 ```yaml
@ -175,8 +169,6 @@ steps:
helloworld3 helloworld3
``` ```
### Example using `up-flags`
Specify flags to pass to the `docker compose up`. Specify flags to pass to the `docker compose up`.
Default is none. Default is none.
@ -185,8 +177,6 @@ Can be used to pass the `--build` flag, for example, if you want persistent volu
A full list of flags can be found in the [Docker compose up documentation](https://docs.docker.com/compose/reference/up/). A full list of flags can be found in the [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. Default is none.
@ -195,8 +185,6 @@ Can be used to pass the want persistent volumes to be deleted as well during cle
A full list of flags can be found in the [Docker compose down documentation](https://docs.docker.com/compose/reference/down/). A full list of flags can be found in the [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. 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). A full list of flags can be found in the [Docker compose documentation](https://docs.docker.com/compose/reference/#command-options-overview-and-help).