Skip to content

GitHub action to wait for docker compose services to become healthy

Notifications You must be signed in to change notification settings

ejhayes/docker-compose-wait-for-healthy

Repository files navigation

docker compose wait for healthy

All Contributors

Description

This action waits for a docker compose services to be marked as healthy

IMPORTANT: in order for this to work your container must have a functioning HEALTHCHECK directive. More info on that can be found here.

Usage

To use this in your projects do this:

...
- uses: ejhayes/docker-compose-wait-for-healthy@releases/v1
  with:
    services: 'space separate list of services you want to wait for'
    path: relativePathToDockerComposeFile
...

Inputs

parameter description required default
timeout amount of time in seconds to wait before failing false 60
services space separate list of services to wait for false
path default path to use false ${{ github.workspace }}

Runs

This action is a node16 action.

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Eric Hayes

📖 🚇 💻

This project follows the all-contributors specification. Contributions of any kind welcome!