compose-action/README.md
isbang 24f65477e7 docs: update README example usage
write more clear and specify that needs actions/checkout

ref #1
2020-11-28 02:31:53 +09:00

20 lines
423 B
Markdown

# Docker Compose Action
This action runs your docker-compose file and clean up before action finished.
## Inputs
### `compose-file`
**Optional** The name of the compose file. Default `"./docker-compose.yml"`.
## Example usage
```yaml
steps:
# need checkout before using compose-action
- uses: actions/checkout@v2
- uses: isbang/compose-action@v0.1
with:
compose-file: './docker/docker-compose.yml'
```