Docker Compose

Starting from TeamCity 2017.2, TeamCity comes with built-in Docker integration, which includes the Docker Compose runner.

Docker Compose

The runner allows starting Docker Compose build services and shutting down those services at the end of the build.

A Docker Compose YAML file with a description of the services to be used during the build is required. The path to the docker-compose.yml file should be relative to the checkout directory.

The executed commands are

# The commands are executed with the current working directory, where the docker-compose file resides.
docker-compose -f <docker-compose.yml> up -d
# At the end of the build, for each docker compose build step the build agent will run:
docker-compose -f <docker-compose.yml> down -v

When using Docker Compose with images which support HEALTHCHECK, TeamCity will wait for the healthy status of all containers, which support this parameter.

If the start of Docker Compose was successful, the TeamCity agent will register the TEAMCITY_DOCKER_NETWORK environment variable containing the name of the Docker Compose default network. This network will be passed transparently to the Docker Wrapper when used in some build runners.

Last modified: 20 April 2023