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

docs: add basic usage exemple

Browse Source 
Signed-off-by: Emilien Escalle <emilien.escalle@escemi.com>
This commit is contained in:
Emilien Escalle 2024-06-18 22:57:03 +02:00
parent f7ac24c0d1
commit 89eb95b928
1 changed files with 28 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -44,7 +44,7 @@ Some extra options can be passed to the `docker-compose down` command using the
<!-- start usage --> <!-- start usage -->
```yaml ```yaml
- uses: hoverkraft-tech/compose-action@v0.0.0 - uses: hoverkraft-tech/compose-action@v2.0.1
with: with:
# Description: Relative path to compose file(s). It can be a list of files. # Description: Relative path to compose file(s). It can be a list of files.
# #
@ -97,6 +97,30 @@ Some extra options can be passed to the `docker-compose down` command using the
## Examples ## Examples
### Example using in a full workflow
```yaml
name: Docker Compose Action
on: [push]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Run docker-compose
uses: hoverkraft-tech/compose-action@v2.0.1
with:
compose-file: "./docker/docker-compose.yml"
- name: Execute tests in the running services
run: |
docker-compose exec test-app pytest
```
<!-- start [.github/ghadocs/examples/] --> <!-- start [.github/ghadocs/examples/] -->
<!-- end [.github/ghadocs/examples/] --> <!-- end [.github/ghadocs/examples/] -->
@ -105,7 +129,7 @@ Some extra options can be passed to the `docker-compose down` command using the
```yaml ```yaml
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v4
- uses: hoverkraft-tech/compose-action@v1.5.1 - uses: hoverkraft-tech/compose-action@v2.0.1
with: with:
compose-file: "./docker/docker-compose.yml" compose-file: "./docker/docker-compose.yml"
env: env:
@ -120,7 +144,7 @@ Perform `docker-compose up` to some given service instead of all of them
steps: steps:
# need checkout before using compose-action # need checkout before using compose-action
- uses: actions/checkout@v3 - uses: actions/checkout@v3
- uses: hoverkraft-tech/compose-action@v1.5.1 - uses: hoverkraft-tech/compose-action@v2.0.1
with: with:
compose-file: "./docker/docker-compose.yml" compose-file: "./docker/docker-compose.yml"
services: | services: |
@ -153,7 +177,7 @@ list of flags can be found in the
steps: steps:
# need checkout before using compose-action # need checkout before using compose-action
- uses: actions/checkout@v3 - uses: actions/checkout@v3
- uses: hoverkraft-tech/compose-action@v1.5.1 - uses: hoverkraft-tech/compose-action@v2.0.1
with: with:
compose-file: "./docker/docker-compose.yml" compose-file: "./docker/docker-compose.yml"
services: | services: |