diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 4b0a4f2..cac8fe0 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -9,4 +9,4 @@ jobs: - uses: isbang/compose-action@v0.1 with: compose-file: './docker/docker-compose.yml' - down-options: '--volumes' + down-flags: '--volumes' diff --git a/README.md b/README.md index bccf368..0413137 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,9 @@ 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-options` +### `down-flags` -**Optional** Options to pass to the `docker-compose down` command during cleanup. Default is none. Primarily used to pass the `--volumes` flag if you want persistent volumes to be deleted as well during cleanup. +**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 diff --git a/action.yml b/action.yml index 95b24a7..86209d1 100644 --- a/action.yml +++ b/action.yml @@ -5,7 +5,7 @@ inputs: description: 'relative path to compose file' required: false default: './docker-compose.yml' - down-options: # id of input + down-flags: # id of input description: 'additional options to pass to `docker-compose down` command' required: false default: '' 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 994865f..186b84c 100644 --- a/post.js +++ b/post.js @@ -4,11 +4,11 @@ const fs = require('fs'); try { const composeFile = core.getInput('compose-file'); - const downOptionsString = core.getInput('down-options'); + const downFlagsString = core.getInput('down-flags'); let options = { config: composeFile, log: true}; - if (downOptionsString.length > 0) - options['commandOptions'] = downOptionsString.split(" "); + if (downFlagsString.length > 0) + options['commandOptions'] = downFlagsString.split(" "); if (!fs.existsSync(composeFile)) { console.log(`${composeFile} not exists`);