Skip to main content

Matrix pipelines

Woodpecker has integrated support for matrix pipeline. Woodpecker executes a separate pipeline for each combination in the matrix, allowing you to build and test a single commit against multiple configurations.

Example matrix definition:

matrix:
GO_VERSION:
- 1.4
- 1.3
REDIS_VERSION:
- 2.6
- 2.8
- 3.0

Example matrix definition containing only specific combinations:

matrix:
include:
- GO_VERSION: 1.4
REDIS_VERSION: 2.8
- GO_VERSION: 1.5
REDIS_VERSION: 2.8
- GO_VERSION: 1.6
REDIS_VERSION: 3.0

Interpolationโ€‹

Matrix variables are interpolated in the yaml using the ${VARIABLE} syntax, before the yaml is parsed. This is an example yaml file before interpolating matrix parameters:

matrix:
GO_VERSION:
- 1.4
- 1.3
DATABASE:
- mysql:5.5
- mysql:6.5
- mariadb:10.1

pipeline:
build:
image: golang:${GO_VERSION}
commands:
- go get
- go build
- go test

services:
database:
image: ${DATABASE}

Example YAML file after injecting the matrix parameters:

pipeline:
build:
- image: golang:${GO_VERSION}
+ image: golang:1.4
commands:
- go get
- go build
- go test
+ environment:
+ - GO_VERSION=1.4
+ - DATABASE=mysql:5.5

services:
database:
- image: ${DATABASE}
+ image: mysql:5.5

Examplesโ€‹

Example matrix pipeline based on Docker image tagโ€‹

matrix:
TAG:
- 1.7
- 1.8
- latest

pipeline:
build:
image: golang:${TAG}
commands:
- go build
- go test

Example matrix pipeline based on container imageโ€‹

matrix:
IMAGE:
- golang:1.7
- golang:1.8
- golang:latest

pipeline:
build:
image: ${IMAGE}
commands:
- go build
- go test

Example matrix pipeline using multiple platformsโ€‹

matrix:
platform:
- linux/amd64
- linux/arm64

platform: ${platform}

pipeline:
test:
image: alpine
commands:
- echo "I am running on ${platform}"

test-arm-only:
image: alpine
commands:
- echo "I am running on ${platform}"
- echo "Arm is cool!"
when:
platform: linux/arm*