From d98be6ed723fbd8a8e7c0f47b9285c50ecb6c544 Mon Sep 17 00:00:00 2001
From: "github-actions[bot]"
<41898282+github-actions[bot]@users.noreply.github.com>
Date: Thu, 30 Jan 2025 20:05:13 +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 | 13 +++++++------
1 file changed, 7 insertions(+), 6 deletions(-)
diff --git a/README.md b/README.md
index f9c6747..463a230 100644
--- a/README.md
+++ b/README.md
@@ -12,18 +12,14 @@
-
-
-
-
-
+
-This action runs your [docker compose](https://docs.docker.com/reference/compose-file/) file and clean up before action finished
+This action runs your compose file(s) and clean up before action finished
@@ -50,6 +46,10 @@ Some extra options can be passed to the `docker compose down` command using the
```yaml
- uses: hoverkraft-tech/compose-action@v0.0.0
with:
+ # Description: Additional options to pass to `docker` command.
+ #
+ docker-flags: ""
+
# Description: Path to compose file(s). It can be a list of files. It can be
# absolute or relative to the current working directory (cwd).
#
@@ -100,6 +100,7 @@ Some extra options can be passed to the `docker compose down` command using the
| **Input** | **Description** | **Default** | **Required** |
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------ | ------------ |
+| docker-flags | Additional options to pass to docker command. | | **false** |
| compose-file | Path to compose file(s). It can be a list of files. It can be absolute or relative to the current working directory (cwd). | ./docker-compose.yml | **false** |
| services | Services to perform docker compose up. | | **false** |
| up-flags | Additional options to pass to docker compose up command. | | **false** |