actions/compose-action
1
0
Fork 0
mirror of https://github.com/hoverkraft-tech/compose-action.git synced 2026-01-10 22:53:06 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

docs: update actions and workflows documentation

Browse Source 
[skip ci]

Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
This commit is contained in:
github-actions[bot] 2024-04-02 10:12:41 +00:00 committed by hoverkraft-bot[bot]
parent 9e48869ba4
commit a48c80beab
1 changed files with 13 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -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 -->
@ -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 -->