From 89f869f5fd19c482b5fd20c8acedbd47d1d6dafe Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 20 Sep 2024 09:49:47 +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 | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index d203a14..ceb1ae0 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,8 @@ 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: Relative path to compose file(s). It can be a list of files. + # 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). # # Default: ./docker-compose.yml compose-file: "" @@ -82,14 +83,14 @@ Some extra options can be passed to the `docker-compose down` command using the -| **Input** | **Description** | **Default** | **Required** | -| -------------------------- | ----------------------------------------------------------------------- | ------------------------------------ | ------------ | -| compose-file | Relative path to compose file(s). It can be a list of files. | ./docker-compose.yml | **false** | -| services | Services to perform docker-compose up. | | **false** | -| up-flags | Additional options to pass to docker-compose up command. | | **false** | -| down-flags | Additional options to pass to docker-compose down command. | | **false** | -| compose-flags | Additional options to pass to docker-compose command. | | **false** | -| cwd | Current working directory | ${{ github.workspace }} | **false** | +| **Input** | **Description** | **Default** | **Required** | +| -------------------------- | -------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | ------------ | +| 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** | +| down-flags | Additional options to pass to docker-compose down command. | | **false** | +| compose-flags | Additional options to pass to docker-compose command. | | **false** | +| cwd | Current working directory | ${{ github.workspace }} | **false** |