mirror of
https://github.com/woodpecker-ci/woodpecker.git
synced 2024-10-23 10:33:58 +00:00
61 lines
1.4 KiB
Markdown
61 lines
1.4 KiB
Markdown
|
# Example plugin
|
||
|
|
|
||
|
|
This provides a brief tutorial for creating a Woodpecker webhook plugin, using simple shell scripting, to make an http requests during the build pipeline.
|
||
|
|
|
||
|
|
## What end users will see
|
||
|
|
|
||
|
|
The below example demonstrates how we might configure a webhook plugin in the YAML file:
|
||
|
|
|
||
|
|
```yaml
|
||
|
|
steps:
|
||
|
|
webhook:
|
||
|
|
image: foo/webhook
|
||
|
|
settings:
|
||
|
|
url: http://example.com
|
||
|
|
method: post
|
||
|
|
body: |
|
||
|
|
hello world
|
||
|
|
```
|
||
|
|
|
||
|
|
## Write the logic
|
||
|
|
|
||
|
|
Create a simple shell script that invokes curl using the YAML configuration parameters, which are passed to the script as environment variables in uppercase and prefixed with `PLUGIN_`.
|
||
|
|
|
||
|
|
```bash
|
||
|
|
#!/bin/sh
|
||
|
|
|
||
|
|
curl \
|
||
|
|
-X ${PLUGIN_METHOD} \
|
||
|
|
-d ${PLUGIN_BODY} \
|
||
|
|
${PLUGIN_URL}
|
||
|
|
```
|
||
|
|
|
||
|
|
## Package it
|
||
|
|
|
||
|
|
Create a Dockerfile that adds your shell script to the image, and configures the image to execute your shell script as the main entrypoint.
|
||
|
|
|
||
|
|
```dockerfile
|
||
|
|
FROM alpine
|
||
|
|
ADD script.sh /bin/
|
||
|
|
RUN chmod +x /bin/script.sh
|
||
|
|
RUN apk -Uuv add curl ca-certificates
|
||
|
|
ENTRYPOINT /bin/script.sh
|
||
|
|
```
|
||
|
|
|
||
|
|
Build and publish your plugin to the Docker registry. Once published your plugin can be shared with the broader Woodpecker community.
|
||
|
|
|
||
|
|
```nohighlight
|
||
|
|
docker build -t foo/webhook .
|
||
|
|
docker push foo/webhook
|
||
|
|
```
|
||
|
|
|
||
|
|
Execute your plugin locally from the command line to verify it is working:
|
||
|
|
|
||
|
|
```nohighlight
|
||
|
|
docker run --rm \
|
||
|
|
-e PLUGIN_METHOD=post \
|
||
|
|
-e PLUGIN_URL=http://example.com \
|
||
|
|
-e PLUGIN_BODY="hello world" \
|
||
|
|
foo/webhook
|
||
|
|
```
|