mirror of
https://github.com/woodpecker-ci/woodpecker.git
synced 2024-12-16 13:36:33 +00:00
49 lines
1.3 KiB
Markdown
49 lines
1.3 KiB
Markdown
|
# 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:
|
||
|
|
|
||
|
|
```yaml
|
||
|
|
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:
|
||
|
|
|
||
|
|
- [Official Woodpecker Plugins](https://woodpecker-ci.org/plugins)
|
||
|
|
|
||
|
|
:::tip
|
||
|
|
There are also other plugin lists with additional plugins. Keep in mind that [Drone](https://www.drone.io/) plugins are generally supported, but could need some adjustments and tweaking.
|
||
|
|
|
||
|
|
- [Drone Plugins](http://plugins.drone.io)
|
||
|
|
- [The Geek Lab Drone Plugins](https://drone-plugin-index.geekdocs.de/plugins/drone-matrix/)
|
||
|
|
:::
|
||
|
|
|
||
|
|
## Creating a plugin
|
||
|
|
|
||
|
|
See a [detailed plugin example](./20-sample-plugin.md).
|