Skip to main content
Version: Next 🚧

Plugins

Plugins are pipeline steps that perform pre-defined tasks and are configured as steps in your pipeline. Plugins can be used to deploy code, publish artifacts, send notification, and more.

They are automatically pulled from the default container registry the agent's have configured.

Dockerfile
FROM cloud/kubectl
COPY deploy /usr/local/deploy
ENTRYPOINT ["/usr/local/deploy"]
deploy
kubectl apply -f $PLUGIN_TEMPLATE
.woodpecker.yaml
steps:
  - name: deploy-to-k8s
    image: cloud/my-k8s-plugin
    settings:
      template: config/k8s/service.yaml

Example pipeline using the Docker and Slack plugins:

steps:
  - name: build
    image: golang
    commands:
      - go build
      - go test

  - name: publish
    image: plugins/docker
    settings:
      repo: foo/bar
      tags: latest

  - name: notify
    image: plugins/slack
    settings:
      channel: dev

Plugin Isolation​

Plugins are just pipeline steps. They share the build workspace, mounted as a volume, and therefore have access to your source tree. While normal steps are all about arbitrary code execution, plugins should only allow the functions intended by the plugin author.

So there are a few limitations, like the workspace base is always mounted at /woodpecker, but the working directory is dynamically adjusted accordingly. So as user of a plugin you should not have to care about this.

Also instead of using environment variables the plugin should only care about one prefixed with PLUGIN_ witch are the internal representation of the settings (read more).

Finding Plugins​

For official plugins, you can use the Woodpecker plugin index:

tip

There are also other plugin lists with additional plugins. Keep in mind that Drone plugins are generally supported, but could need some adjustments and tweaking.