Go to file

Bo-Yi Wu 197bad6faf docs: update build section Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>		2019-03-04 16:07:50 +08:00
docker	Fix manifest template helper	2019-02-26 09:22:27 +08:00
images	switch glide to govendor (#43 )	2017-07-03 23:11:48 -05:00
tests	Support Video Message.	2016-10-14 02:38:08 -05:00
.drone.jsonnet	refactor drone pipeline config	2019-02-22 10:33:19 +08:00
.drone.windows.yml	feat: replace vendor with go module	2019-02-16 23:39:20 +08:00
.drone.yml	chore: update golang to 1.12	2019-02-27 14:41:54 +08:00
.editorconfig	initial project.	2016-10-04 21:45:49 +08:00
.gitignore	chore(git): add release folder to ignore list.	2017-12-09 18:51:11 +08:00
.revive.toml	feat: add revive.toml	2019-02-16 23:41:11 +08:00
DOCS.md	Decouple 'commit' object and add commit.link (#51 )	2017-09-11 12:34:47 +08:00
go.mod	feat: replace vendor with go module	2019-02-16 23:39:20 +08:00
go.sum	feat: replace vendor with go module	2019-02-16 23:39:20 +08:00
LICENSE	Initial commit	2016-10-04 17:02:45 +08:00
main.go	feat(env): support multiple env	2019-02-19 22:07:32 +08:00
Makefile	feat: replace vendor with go module	2019-02-16 23:39:20 +08:00
pipeline.libsonnet	chore: update golang to 1.12	2019-02-27 14:41:54 +08:00
plugin_test.go	feat(GitHub): support default message	2019-02-17 16:03:10 +08:00
plugin.go	fix: hide token in CI/CD log (#70 )	2019-02-17 17:39:15 +08:00
README.md	docs: update build section	2019-03-04 16:07:50 +08:00

README.md

drone-telegram

Drone plugin for sending telegram notifications. For the usage information and a listing of the available options please take a look at the docs.

Feature

Send with Text Message. (markdown or html format)
Send with New Photo.
Send with New Document.
Send with New Audio.
Send with New Voice.
Send with New Location.
Send with New Venue.
Send with New Video.
Send with New Sticker.

Build or Download a binary

The pre-compiled binaries can be downloaded from release page. Support the following OS type.

Windows amd64/386
Linux arm/amd64/386
Darwin amd64/386

With Go installed

$ go get -u -v github.com/appleboy/drone-telegram

or build the binary with the following command:

$ export GOOS=linux
$ export GOARCH=amd64
$ export CGO_ENABLED=0
$ export GO111MODULE=on

$ go test -cover ./...

$ go build -v -a -tags netgo -o release/linux/amd64/drone-telegram .

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_DOCUMENT=tests/gophercolor.png \
  -e PLUGIN_STICKER=tests/github-logo.png \
  -e PLUGIN_AUDIO=tests/audio.mp3 \
  -e PLUGIN_VOICE=tests/voice.ogg \
  -e PLUGIN_LOCATION=24.9163213,121.1424972 \
  -e PLUGIN_VENUE=24.9163213,121.1424972,title,address \
  -e PLUGIN_VIDEO=tests/video.mp4 \
  -e PLUGIN_DEBUG=true \
  -e PLUGIN_ONLY_MATCH_EMAIL=false \
  -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_LINK=https://github.com/appleboy/go-hello/compare/master... \
  -e DRONE_COMMIT_AUTHOR=appleboy \
  -e DRONE_COMMIT_AUTHOR_EMAIL=appleboy@gmail.com \
  -e DRONE_BUILD_NUMBER=1 \
  -e DRONE_BUILD_STATUS=success \
  -e DRONE_BUILD_LINK=http://github.com/appleboy/go-hello \
  -e DRONE_TAG=1.0.0 \
  -e DRONE_JOB_STARTED=1477550550 \
  -e DRONE_JOB_FINISHED=1477550750 \
  -v $(pwd):$(pwd) \
  -w $(pwd) \
  appleboy/drone-telegram

Load all environments from file.

docker run --rm \
  -e ENV_FILE=your_env_file_path \
  -v $(pwd):$(pwd) \
  -w $(pwd) \
  appleboy/drone-telegram