diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index fdaa739..cac8fe0 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -9,3 +9,4 @@ jobs: - uses: isbang/compose-action@v0.1 with: compose-file: './docker/docker-compose.yml' + down-flags: '--volumes' diff --git a/README.md b/README.md index 311ff4b..0413137 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,11 @@ This action runs your docker-compose file and clean up before action finished. **Optional** The name of the compose file. Default `"./docker-compose.yml"`. +### `down-flags` + +**Optional** Used to specify flags to pass to the `docker-compose down` command during cleanup. Default is none. Can be used to pass the `--volumes` flag, for example, if you want persistent volumes to be deleted as well during cleanup. A full list of flags can be found in the [docker-compose down documentation](https://docs.docker.com/compose/reference/down/). + + ## Example usage ```yaml diff --git a/action.yml b/action.yml index d922ce3..86209d1 100644 --- a/action.yml +++ b/action.yml @@ -5,6 +5,10 @@ inputs: description: 'relative path to compose file' required: false default: './docker-compose.yml' + down-flags: # id of input + description: 'additional options to pass to `docker-compose down` command' + required: false + default: '' runs: using: 'node12' main: 'main.js' diff --git a/docker/docker-compose.yml b/docker/docker-compose.yml index 690e07f..9d5a4d6 100644 --- a/docker/docker-compose.yml +++ b/docker/docker-compose.yml @@ -1,4 +1,10 @@ version: "3.8" + +volumes: + test_volume: {} + services: helloworld: image: hello-world + volumes: + - test_volume:/test:Z diff --git a/post.js b/post.js index f786de3..186b84c 100644 --- a/post.js +++ b/post.js @@ -4,13 +4,18 @@ const fs = require('fs'); try { const composeFile = core.getInput('compose-file'); + const downFlagsString = core.getInput('down-flags'); + + let options = { config: composeFile, log: true}; + if (downFlagsString.length > 0) + options['commandOptions'] = downFlagsString.split(" "); if (!fs.existsSync(composeFile)) { console.log(`${composeFile} not exists`); return } - compose.down({ config: composeFile, log: true }) + compose.down(options) .then( () => { console.log('compose removed')}, err => { core.setFailed(`compose down failed ${err}`)}