woodpecker-email/README.md
Simon Vieille 3390cf2714
Some checks failed
ci/woodpecker/push/woodpecker Pipeline failed
docs(readme): update image name
2023-01-04 22:40:28 +01:00

53 lines
1.4 KiB
Markdown

# woodpecker-email
Woodpecker plugin to send build status notifications via Email. For the usage information and a listing of the available options please take a look at [the docs](DOCS.md).
## Binary
Build the binary with the following command:
```
go build
```
## Docker
Build the docker image with the following commands:
```
docker build -t deblan/woodpecker-email:latest .
```
This will create a Docker image called `deblan/woodpecker-email:latest`.
Please note incorrectly building the image for the correct x64 linux and with GCO disabled will result in an error when running the Docker image:
```
docker: Error response from daemon: Container command
'/bin/woodpecker-email' not found or does not exist..
```
### Example
Execute from the working directory:
```sh
docker run --rm \
-e PLUGIN_FROM.ADDRESS=drone@test.test \
-e PLUGIN_FROM.NAME="John Smith" \
-e PLUGIN_HOST=smtp.test.test \
-e PLUGIN_USERNAME=drone \
-e PLUGIN_PASSWORD=test \
-e CI_REPO_OWNER=octocat \
-e CI_REPO_NAME=hello-world \
-e CI_COMMIT_SHA=7fd1a60b01f91b314f59955a4e4d4e80d8edf11d \
-e CI_COMMIT_BRANCH=master \
-e CI_COMMIT_AUTHOR=octocat \
-e CI_COMMIT_AUTHOR_EMAIL=octocat@test.test \
-e CI_BUILD_NUMBER=1 \
-e CI_PIPELINE_STATUS=success \
-e CI_PIPELINE_LINK=http://github.com/octocat/hello-world \
-e CI_COMMIT_MESSAGE="Hello world!" \
-v $(pwd):$(pwd) \
-w $(pwd) \
deblan/woodpecker-email
```