Woodpecker provides a services section in the Yaml file used for defining service containers. The below configuration composes database and cache containers.
1 2 3 4 5 6 7 8 9 10 11 12 13
pipeline: build: image: golang commands: - go build - go test services: database: image: mysql cache: image: redis
Services are accessed using custom hostnames. In the above example the mysql service is assigned the hostname
database and is available at
Service containers generally expose environment variables to customize service startup such as default usernames, passwords and ports. Please see the official image documentation to learn more.
1 2 3 4 5 6 7 8 9
services: database: image: mysql + environment: + - MYSQL_DATABASE=test + - MYSQL_ALLOW_EMPTY_PASSWORD=yes cache: image: redis
Service and long running containers can also be included in the pipeline section of the configuration using the detach parameter without blocking other steps. This should be used when explicit control over startup order is required.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
pipeline: build: image: golang commands: - go build - go test database: image: redis + detach: true test: image: golang commands: - go test
Containers from detached steps will terminate when the pipeline ends.
Service containers require time to initialize and begin to accept connections. If you are unable to connect to a service you may need to wait a few seconds or implement a backoff.
1 2 3 4 5 6 7 8 9 10 11
pipeline: test: image: golang commands: + - sleep 15 - go get - go test services: database: image: mysql