Skip to content

Commit

Permalink
docs: update actions and workflows documentation
Browse files Browse the repository at this point in the history
[skip ci]

Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
  • Loading branch information
github-actions[bot] authored and hoverkraft-bot[bot] committed Sep 20, 2024
1 parent 4d0cecc commit 89f869f
Showing 1 changed file with 10 additions and 9 deletions.
19 changes: 10 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,8 @@ Some extra options can be passed to the `docker-compose down` command using the
```yaml
- uses: hoverkraft-tech/[email protected]
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: ""
Expand Down Expand Up @@ -82,14 +83,14 @@ Some extra options can be passed to the `docker-compose down` command using the
<!-- start inputs -->
| **Input** | **Description** | **Default** | **Required** |
| -------------------------- | ----------------------------------------------------------------------- | ------------------------------------ | ------------ |
| <code>compose-file</code> | Relative path to compose file(s). It can be a list of files. | <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>cwd</code> | Current working directory | <code>${{ github.workspace }}</code> | **false** |
| **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>cwd</code> | Current working directory | <code>${{ github.workspace }}</code> | **false** |
<!-- end inputs -->
<!-- start outputs -->
Expand Down

0 comments on commit 89f869f

Please sign in to comment.