Skip to main content

Multi pipelines

NOTE: This Feature is only available for GitHub, Gitea & Gitlab repositories. Follow this issue to support further development.

By default, Woodpecker looks for the pipeline definition in .woodpecker.yml in the project root.

The Multi-Pipeline feature allows the pipeline to be split into several files and placed in the .woodpecker/ folder. Only .yml files will we used and files in any subfolders like .woodpecker/sub-folder/test.yml will be ignored. You can set some custom path like .my-ci/pipelines/ instead of .woodpecker/ in the project settings.

Rational

  • faster lint/test feedback, the pipeline doesn't have to run fully to have a lint status pushed to the the remote
  • better organization of the pipeline along various concerns: testing, linting, feature apps
  • utilizing more agents to speed up build

Example multi-pipeline definition

.woodpecker/
โ”œโ”€โ”€ .build.yml
โ”œโ”€โ”€ .deploy.yml
โ”œโ”€โ”€ .lint.yml
โ””โ”€โ”€ .test.yml

.woodpecker/.build.yml

pipeline:
build:
image: debian:stable-slim
commands:
- echo building
- sleep 5

.woodpecker/.deploy.yml

pipeline:
deploy:
image: debian:stable-slim
commands:
- echo deploying

depends_on:
- lint
- build
- test

.woodpecker/.test.yml

pipeline:
test:
image: debian:stable-slim
commands:
- echo testing
- sleep 5

depends_on:
- build

.woodpecker/.lint.yml

pipeline:
lint:
image: debian:stable-slim
commands:
- echo linting
- sleep 5

Status lines

Each pipeline has its own status line on GitHub.

Flow control

The pipelines run in parallel on separate agents and share nothing.

Dependencies between pipelines can be set with the depends_on element. A pipeline doesn't execute until its dependencies did not complete successfully.

The name for a depends_on entry is the filename without the path, leading dots and without the file extension .yml. If the project config for example uses .woodpecker/ as path for ci files with a file named .woodpecker/.lint.yml the corresponding depends_on entry would be lint.

pipeline:
deploy:
image: debian:stable-slim
commands:
- echo deploying

+depends_on:
+ - lint
+ - build
+ - test

Pipelines that need to run even on failures should set the run_on tag.

pipeline:
notify:
image: debian:stable-slim
commands:
- echo notifying

depends_on:
- deploy

+run_on: [ success, failure ]

Some pipelines don't need the source code, set the skip_clone tag to skip cloning:


pipeline:
notify:
image: debian:stable-slim
commands:
- echo notifying

depends_on:
- deploy

run_on: [ success, failure ]
+skip_clone: true