actions/compose-action
1
0
Fork 0
mirror of https://github.com/hoverkraft-tech/compose-action.git synced 2026-01-11 15:13: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-09-20 09:49:47 +00:00 committed by hoverkraft-bot[bot]
parent 4d0ceccdad
commit 89f869f5fd
1 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -46,7 +46,8 @@ Some extra options can be passed to the `docker-compose down` command using the
```yaml ```yaml
- uses: hoverkraft-tech/compose-action@v0.0.0 - uses: hoverkraft-tech/compose-action@v0.0.0
with: 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 # Default: ./docker-compose.yml
compose-file: "" compose-file: ""
@ -82,14 +83,14 @@ Some extra options can be passed to the `docker-compose down` command using the
<!-- start inputs --> <!-- start inputs -->
| **Input** | **Description** | **Default** | **Required** | | **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>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>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>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>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>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** | | <code>cwd</code> | Current working directory | <code>${{ github.workspace }}</code> | **false** |
<!-- end inputs --> <!-- end inputs -->
<!-- start outputs --> <!-- start outputs -->