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 Apr 2, 2024
1 parent 9e48869 commit a48c80b
Showing 1 changed file with 13 additions and 7 deletions.
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,11 @@ This action runs your docker-compose file and clean up before action finished
#
# Default:
compose-flags: ""

# Description: Current working directory
#
# Default: ${{ github.workspace }}
cwd: ""
```
<!-- end usage -->
Expand All @@ -60,13 +65,14 @@ This action runs your docker-compose file and clean up before action finished
<!-- 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** |
| **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** |
<!-- end inputs -->
<!-- start outputs -->
Expand Down

0 comments on commit a48c80b

Please sign in to comment.