From 57a2375c118628c10609e2c4fcaf7c9c65c0c7ef Mon Sep 17 00:00:00 2001 From: "hoverkraft-bot[bot]" <128996893+hoverkraft-bot[bot]@users.noreply.github.com> Date: Mon, 29 Sep 2025 19:51:01 +0000 Subject: [PATCH] docs: update actions and workflows documentation [skip ci] Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- README.md | 14 +------------- 1 file changed, 1 insertion(+), 13 deletions(-) diff --git a/README.md b/README.md index 139f4ed..7050a0b 100644 --- a/README.md +++ b/README.md @@ -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. 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. 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 -### Example using in a full workflow - ```yaml name: Docker Compose Action @@ -147,8 +145,6 @@ jobs: docker compose exec test-app pytest ``` -### Example Using environment variables - ```yaml steps: - uses: actions/checkout@v4.2.2 @@ -159,8 +155,6 @@ steps: CUSTOM_VARIABLE: "test" ``` -### Example using `services` - Perform `docker compose up` to some given service instead of all of them ```yaml @@ -175,8 +169,6 @@ steps: helloworld3 ``` -### Example using `up-flags` - Specify flags to pass to the `docker compose up`. 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/). -### Example using `down-flags` - Specify flags to pass to the `docker compose down` command during cleanup. 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/). -### Example using `compose-flags` - 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).