78f99c9c7f
Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
76 lines
1.9 KiB
Markdown
76 lines
1.9 KiB
Markdown
# drone-telegram
|
|
|
|
[![Build Status](https://travis-ci.org/appleboy/drone-telegram.svg?branch=master)](https://travis-ci.org/appleboy/drone-telegram) [![codecov](https://codecov.io/gh/appleboy/drone-telegram/branch/master/graph/badge.svg)](https://codecov.io/gh/appleboy/drone-telegram) [![Go Report Card](https://goreportcard.com/badge/github.com/appleboy/drone-telegram)](https://goreportcard.com/report/github.com/appleboy/drone-telegram)
|
|
|
|
[Drone](https://github.com/drone/drone) plugin for sending telegram notifications.
|
|
|
|
## Feature
|
|
|
|
* [x] Send with Text Message. (`markdown` or `html` format)
|
|
* [x] Send with New Photo.
|
|
* [ ] Send with New Document.
|
|
* [ ] Send with New Audio.
|
|
* [ ] Send with New Voice.
|
|
* [ ] Send with New Contact.
|
|
* [ ] Send with New Location.
|
|
* [ ] Send with New Venue.
|
|
* [ ] Send with New Video.
|
|
* [ ] Send with New Sticker.
|
|
|
|
## Build
|
|
|
|
Build the binary with the following commands:
|
|
|
|
```
|
|
$ make build
|
|
```
|
|
|
|
## Testing
|
|
|
|
Test the package with the following command:
|
|
|
|
```
|
|
$ make test
|
|
```
|
|
|
|
## Docker
|
|
|
|
Build the docker image with the following commands:
|
|
|
|
```
|
|
$ make docker
|
|
```
|
|
|
|
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/drone-telegram' not found or does not exist..
|
|
```
|
|
|
|
## Usage
|
|
|
|
Execute from the working directory:
|
|
|
|
```
|
|
docker run --rm \
|
|
-e PLUGIN_TOKEN=xxxxxxx \
|
|
-e PLUGIN_TO=xxxxxxx \
|
|
-e PLUGIN_MESSAGE=test \
|
|
-e PLUGIN_PHOTO=tests/github.png \
|
|
-e PLUGIN_DEBUG=true \
|
|
-e PLUGIN_FORMAT=markdown \
|
|
-e DRONE_REPO_OWNER=appleboy \
|
|
-e DRONE_REPO_NAME=go-hello \
|
|
-e DRONE_COMMIT_SHA=e5e82b5eb3737205c25955dcc3dcacc839b7be52 \
|
|
-e DRONE_COMMIT_BRANCH=master \
|
|
-e DRONE_COMMIT_AUTHOR=appleboy \
|
|
-e DRONE_BUILD_NUMBER=1 \
|
|
-e DRONE_BUILD_STATUS=success \
|
|
-e DRONE_BUILD_LINK=http://github.com/appleboy/go-hello \
|
|
-v $(pwd):$(pwd) \
|
|
-w $(pwd) \
|
|
appleboy/drone-telegram
|
|
```
|