This action runs your docker-compose file, allows you to run tests and cleans up before action finished.

Optional The name of the compose file. Default "./docker-compose.yml".

It can be a list of files:

compose-file: |
  docker-compose.yml
  docker-compose.ci.yml

Optional Just perform docker-compose up to one service instead of all of them

Optional Used to specify flags to pass to the docker-compose up. Default is none. Can be used to pass the --build 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 up documentation.

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.

Optional Used to specify flags to pass to the docker-compose command. Default is none. A full list of flags can be found in the docker-compose documentation.

Optional Used to specify the container to run the tests in. Default is none. If not specified, no tests will be run.

Optional Used to specify the command to run the tests with. Default is none. If not specified, no tests will be run.

steps:
  # need checkout before using docker-compose-action
  - uses: actions/checkout@v3
  - uses: adambirds/[email protected]
    with:
      compose-file: "./docker/docker-compose.yml"
      down-flags: "--volumes"
      services: |
        helloworld2
        helloworld3
      test-container: helloworld
      test-command: "npm test"

steps:
  - uses: actions/checkout@v3
  - uses: adambirds/[email protected]
    with:
      compose-file: "./docker/docker-compose.yml"
    env:
      CUSTOM_VARIABLE: "test"