woodpecker/docs/versioned_docs/version-2.1/20-usage/51-plugins/10-plugins.md
2023-12-26 19:49:12 +01:00

1.3 KiB

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.

Example pipeline using the Docker and Slack plugins:

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

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

  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.

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.

:::

Creating a plugin

See a detailed plugin example.