Skip to content

hoverkraft-tech/compose-action

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Oct 7, 2022
29b21f6 · Oct 7, 2022

History

36 Commits
Oct 5, 2022
Oct 5, 2022
Oct 7, 2022
Oct 5, 2022
Oct 5, 2022
Oct 7, 2022
Oct 5, 2022
Oct 5, 2022
Oct 5, 2022
Oct 6, 2022
Oct 5, 2022
Oct 5, 2022

Repository files navigation

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".

It can be a list of files:

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

services

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

up-flags

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.

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.

compose-flags

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.

Example usage

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

Using environment variables

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