Go to file

Bo-Yi Wu 24f5558e9e chore: update go module Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>		2021-07-03 12:46:31 +08:00
docker	chore: replace ADD with COPY	2019-11-23 21:51:46 +08:00
images	switch glide to govendor (#43 )	2017-07-03 23:11:48 -05:00
tests	chore: upgrade drone template (#103 )	2021-07-03 11:56:16 +08:00
.appveyor.yml	chore: update appveyor for windows build	2019-11-23 21:48:06 +08:00
.drone.jsonnet	refactor drone pipeline config	2019-02-22 10:33:19 +08:00
.drone.yml	chore: revert to go1.15	2021-04-03 07:08:13 +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	add disable_notification parameter (#99 )	2021-04-03 06:38:16 +08:00
go.mod	chore: update go module	2021-07-03 12:46:31 +08:00
go.sum	Fix can't call duration helper func (#104 )	2021-07-03 12:39:54 +08:00
LICENSE	Initial commit	2016-10-04 17:02:45 +08:00
main.go	add disable_notification parameter (#99 )	2021-04-03 06:38:16 +08:00
Makefile	chore(makefile): change gofmt toll to gofumpt	2021-01-14 21:15:06 +08:00
pipeline.libsonnet	chore: revert to go1.15	2021-04-03 07:08:13 +08:00
plugin_test.go	Fix can't call duration helper func (#104 )	2021-07-03 12:39:54 +08:00
plugin.go	Fix can't call duration helper func (#104 )	2021-07-03 12:39:54 +08:00
README.md	chore: move load .env file to top. (#94 )	2020-07-01 06:40:04 +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

Usage

Execute from the working directory:

docker run --rm \
  -e PLUGIN_TOKEN=xxxxxxx \
  -e PLUGIN_TO=xxxxxxx \
  -e PLUGIN_MESSAGE=test \
  -e PLUGIN_MESSAGE_FILE=testmessage.md \  
  -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 PLUGIN_ENV_FILE=your_env_file_path \
  -v $(pwd):$(pwd) \
  -w $(pwd) \
  appleboy/drone-telegram