actions/compose-action
1
0
Fork 0
mirror of https://github.com/hoverkraft-tech/compose-action.git synced 2026-01-10 06:33: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-03-29 22:22:34 +00:00 committed by hoverkraft-bot[bot]
parent 0a6ea0e8cd
commit 4a04a283ed
1 changed files with 13 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -11,6 +11,9 @@
<!-- end title -->
<!-- start badges -->
<a href="https%3A%2F%2Fgithub.com%2Fhoverkraft-tech%2Fcompose-action%2Freleases%2Flatest"><img src="https://img.shields.io/github/v/release/hoverkraft-tech/compose-action?display_name=tag&sort=semver&logo=github&style=flat-square" alt="Release%20by%20tag" /></a><a href="https%3A%2F%2Fgithub.com%2Fhoverkraft-tech%2Fcompose-action%2Freleases%2Flatest"><img src="https://img.shields.io/github/release-date/hoverkraft-tech/compose-action?display_name=tag&sort=semver&logo=github&style=flat-square" alt="Release%20by%20date" /></a><img src="https://img.shields.io/github/last-commit/hoverkraft-tech/compose-action?logo=github&style=flat-square" alt="Commit" /><a href="https%3A%2F%2Fgithub.com%2Fhoverkraft-tech%2Fcompose-action%2Fissues"><img src="https://img.shields.io/github/issues/hoverkraft-tech/compose-action?logo=github&style=flat-square" alt="Open%20Issues" /></a><img src="https://img.shields.io/github/downloads/hoverkraft-tech/compose-action/total?logo=github&style=flat-square" alt="Downloads" />
<!-- end badges -->
</div>
@ -24,31 +27,31 @@ This action runs your docker-compose file and clean up before action finished
<!-- start usage -->
```yaml
- uses: hoverkraft-tech/compose-action@v1.0.0
- uses: hoverkraft-tech/compose-action@v0.0.0
with:
# Description: Relative path to compose file(s). It can be a list of files.
#
# Default: ./docker-compose.yml
compose-file: ''
compose-file: ""
# Description: Services to perform docker-compose up.
#
services: ''
services: ""
# Description: Additional options to pass to `docker-compose up` command.
#
# Default:
up-flags: ''
up-flags: ""
# Description: Additional options to pass to `docker-compose down` command.
#
# Default:
down-flags: ''
down-flags: ""
# Description: Additional options to pass to `docker-compose` command.
#
# Default:
compose-flags: ''
compose-flags: ""
```
<!-- end usage -->
@ -81,9 +84,9 @@ steps:
- uses: actions/checkout@v4
- uses: hoverkraft-tech/compose-action@v1.5.1
with:
compose-file: './docker/docker-compose.yml'
compose-file: "./docker/docker-compose.yml"
env:
CUSTOM_VARIABLE: 'test'
CUSTOM_VARIABLE: "test"
```
### Example using `services`
@ -96,7 +99,7 @@ steps:
- uses: actions/checkout@v3
- uses: hoverkraft-tech/compose-action@v1.5.1
with:
compose-file: './docker/docker-compose.yml'
compose-file: "./docker/docker-compose.yml"
services: |
helloworld2
helloworld3
@ -129,7 +132,7 @@ steps:
- uses: actions/checkout@v3
- uses: hoverkraft-tech/compose-action@v1.5.1
with:
compose-file: './docker/docker-compose.yml'
compose-file: "./docker/docker-compose.yml"
services: |
helloworld2
helloworld3