29 Commits

Author SHA1 Message Date
Bo-Yi Wu 040616c1f8 chore: add drone telegram version 2019-09-25 22:39:32 +08:00
Bo-Yi Wu a10dfd2766 docs: add custom message 2019-09-25 22:12:11 +08:00
Bo-Yi Wu c83985c531 add custom message
Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
2019-09-25 22:09:04 +08:00
Bo-Yi Wu 2b5a500551 docs: add photo and location message 2019-09-25 22:04:09 +08:00
Bo-Yi Wu fdf386abfa docs: update location message 2019-09-25 22:02:38 +08:00
Bo-Yi Wu 4e83d473fc update
Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
2019-09-25 22:01:27 +08:00
Bo-Yi Wu a14c43a7be chore: add location message 2019-09-25 21:28:25 +08:00
Bo-Yi Wu 82f08879c5 docs: add location message 2019-09-25 21:22:36 +08:00
Bo-Yi Wu f622f39b03 chore: add location message 2019-09-25 21:21:38 +08:00
Bo-Yi Wu 89073d4db2 update
Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
2019-09-25 19:28:57 +08:00
Bo-Yi Wu 7952082356 update
Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
2019-09-25 19:27:38 +08:00
Bo-Yi Wu 4dbe08d34a update
Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
2019-09-25 19:25:53 +08:00
Bo-Yi Wu ffc52f02f2 update
Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
2019-09-25 19:23:28 +08:00
Bo-Yi Wu 8920bdffe3 update
Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
2019-09-25 19:20:36 +08:00
Bo-Yi Wu d1f5f0e4e9 add workspace
Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
2019-09-25 19:15:08 +08:00
Bo-Yi Wu cba7edda6f update
Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
2019-09-25 19:13:06 +08:00
Bo-Yi Wu 868c74871e add workdir
Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
2019-09-25 19:08:49 +08:00
Bo-Yi Wu 3fb31034d1 initial ci
Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
2019-09-25 18:59:58 +08:00
Bo-Yi Wu d753c01b96 update readme
Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
2019-09-25 18:58:09 +08:00
Bo-Yi Wu 6399a5ed49 upgrade github actions
Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
2019-09-25 18:53:47 +08:00
Bo-Yi Wu 0e92df9a00 add action yaml file.
Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
2019-09-25 18:41:37 +08:00
Bo-Yi Wu 2df95b048f fixed Template typo (#3)
fixed Template typo
2019-04-26 09:46:49 +08:00
0xflotus bd94f12bb6 fixed Template typo 2019-04-24 18:09:13 +02:00
Bo-Yi Wu 827b11092f docs: update doc 2019-04-05 07:20:52 +08:00
Bo-Yi Wu dcd986dc36 Merge pull request #2 from appleboy/doc
docs: add Template variable
2019-04-05 07:14:33 +08:00
Bo-Yi Wu 27dde9c826 docs: add Template variable 2019-04-05 07:10:58 +08:00
Bo-Yi Wu cc178efb9f chore: add commit.sha in example 2019-04-05 06:48:58 +08:00
Bo-Yi Wu 8b27ddeb0a docs: add FORMAT env info 2019-02-28 15:09:39 +08:00
Bo-Yi Wu 1274de63b5 chore(workflow): add test message 2019-02-20 00:23:44 +08:00
5 changed files with 178 additions and 93 deletions
-38
View File
@@ -1,38 +0,0 @@
workflow "Send Notification" {
on = "push"
resolves = [
"Send Custom Message",
"Send Default Message",
"Send Photo Message",
]
}
action "Send Custom Message" {
uses = "appleboy/telegram-action@master"
secrets = [
"TELEGRAM_TOKEN",
"TELEGRAM_TO",
]
args = "A new commit has been pushed."
}
action "Send Default Message" {
uses = "appleboy/telegram-action@master"
secrets = [
"TELEGRAM_TOKEN",
"TELEGRAM_TO",
]
}
action "Send Photo Message" {
uses = "appleboy/telegram-action@master"
env = {
PHOTO = "tests/github.png"
DOCUMENT = "tests/gophercolor.png"
}
secrets = [
"TELEGRAM_TOKEN",
"TELEGRAM_TO",
]
args = "send photo message."
}
+59
View File
@@ -0,0 +1,59 @@
name: telegram message
on: [push]
jobs:
build:
name: Build
runs-on: ubuntu-latest
steps:
- name: send custom message with args
uses: appleboy/telegram-action@master
env:
TELEGRAM_TOKEN: ${{ secrets.TELEGRAM_TOKEN }}
TELEGRAM_TO: ${{ secrets.TELEGRAM_TO }}
with:
args: The ${{ github.event_name }} event triggered first step.
- name: send message useing with
uses: appleboy/telegram-action@master
env:
TELEGRAM_TOKEN: ${{ secrets.TELEGRAM_TOKEN }}
TELEGRAM_TO: ${{ secrets.TELEGRAM_TO }}
with:
message: The ${{ github.event_name }} event triggered second step.
- name: send default message
uses: appleboy/telegram-action@master
env:
TELEGRAM_TOKEN: ${{ secrets.TELEGRAM_TOKEN }}
TELEGRAM_TO: ${{ secrets.TELEGRAM_TO }}
- name: send photo message
uses: appleboy/telegram-action@master
with:
message: send photo message
photo: './tests/github.png'
document: './tests/gophercolor.png'
env:
TELEGRAM_TOKEN: ${{ secrets.TELEGRAM_TOKEN }}
TELEGRAM_TO: ${{ secrets.TELEGRAM_TO }}
- name: send location message
uses: appleboy/telegram-action@master
with:
location: '24.9163213 121.1424972'
venue: '35.661777 139.704051 竹北體育館 新竹縣竹北市'
env:
TELEGRAM_TOKEN: ${{ secrets.TELEGRAM_TOKEN }}
TELEGRAM_TO: ${{ secrets.TELEGRAM_TO }}
- name: send custom message
uses: appleboy/telegram-action@master
env:
TELEGRAM_TOKEN: ${{ secrets.TELEGRAM_TOKEN }}
TELEGRAM_TO: ${{ secrets.TELEGRAM_TO }}
with:
message: |
The ${{ github.event_name }} event triggered final step.
echo This event is a pull request that had an assignee removed.
+4 -12
View File
@@ -1,16 +1,8 @@
FROM appleboy/drone-telegram:1.4.2-linux-amd64 FROM appleboy/drone-telegram:1.3.1-linux-amd64
# Github labels
LABEL "com.github.actions.name"="Telegram Notify"
LABEL "com.github.actions.description"="Sending a Telegram message"
LABEL "com.github.actions.icon"="message-square"
LABEL "com.github.actions.color"="blue"
LABEL "repository"="https://github.com/appleboy/telegram-action"
LABEL "homepage"="https://github.com/appleboy"
LABEL "maintainer"="Bo-Yi Wu <appleboy.tw@gmail.com>"
LABEL "version"="0.0.2"
ADD entrypoint.sh /entrypoint.sh ADD entrypoint.sh /entrypoint.sh
RUN chmod +x /entrypoint.sh RUN chmod +x /entrypoint.sh
WORKDIR /github/workspace
ENTRYPOINT ["/entrypoint.sh"] ENTRYPOINT ["/entrypoint.sh"]
+84 -43
View File
@@ -2,63 +2,90 @@
[GitHub Action](https://developer.github.com/actions/) for sending a Telegram notification message. [GitHub Action](https://developer.github.com/actions/) for sending a Telegram notification message.
<img src="./images/telegram-notification.png"> ![notification](./images/telegram-notification.png)
[![Actions Status](https://github.com/appleboy/facebook-telegram/workflows/telegram%20message/badge.svg)](https://github.com/appleboy/facebook-action/actions)
## Usage ## Usage
Send custom message as blow Send custom message and see the custom variable as blow.
``` ```yml
action "Send Custom Message" { - name: send custom message
uses = "appleboy/telegram-action@master" uses: appleboy/telegram-action@master
secrets = [ env:
"TELEGRAM_TOKEN", TELEGRAM_TOKEN: ${{ secrets.TELEGRAM_TOKEN }}
"TELEGRAM_TO", TELEGRAM_TO: ${{ secrets.TELEGRAM_TO }}
] with:
args = "A new commit has been pushed." args: The ${{ github.event_name }} event triggered first step.
}
``` ```
Remove `args` to send the default message. Remove `args` to send the default message.
``` ```yml
action "Send Default Message" { - name: send default message
uses = "appleboy/telegram-action@master" uses: appleboy/telegram-action@master
secrets = [ env:
"TELEGRAM_TOKEN", TELEGRAM_TOKEN: ${{ secrets.TELEGRAM_TOKEN }}
"TELEGRAM_TO", TELEGRAM_TO: ${{ secrets.TELEGRAM_TO }}
]
}
``` ```
<img src="images/telegram-workflow.png"> ![workflow](./images/telegram-workflow.png)
## Environment variables ## Input variables
* PHOTO - Optional. photo message * photo - optional. photo message
* DOCUMENT - Optional. document message * document - optional. document message
* STICKER - Optional. sticker message * sticker - optional. sticker message
* AUDIO - Optional. audio message * audio - optional. audio message
* VOICE - Optional. voice message * voice - optional. voice message
* LOCATION - Optional. location message * location - optional. location message
* VENUE - Optional. venue message * venue - optional. venue message
* VIDEO - Optional. video message * video - optional. video message
* DEBUG - Optional. enable debug mode * debug - optional. enable debug mode
* format - optional. `markdown` or `html`
### Example ### Example
send photo message:
```yml
- name: send photo message
uses: appleboy/telegram-action@master
with:
message: send photo message
photo: tests/github.png
document: tests/gophercolor.png
env:
TELEGRAM_TOKEN: ${{ secrets.TELEGRAM_TOKEN }}
TELEGRAM_TO: ${{ secrets.TELEGRAM_TO }}
``` ```
action "Send photo message" {
uses = "appleboy/telegram-action@master" send location message:
secrets = [
"TELEGRAM_TOKEN", ```yml
"TELEGRAM_TO", - name: send location message
] uses: appleboy/telegram-action@master
env = { with:
PHOTO = "tests/github.png" location: '24.9163213 121.1424972'
} venue: '35.661777 139.704051 竹北體育館 新竹縣竹北市'
args = "A new commit has been pushed." env:
} TELEGRAM_TOKEN: ${{ secrets.TELEGRAM_TOKEN }}
TELEGRAM_TO: ${{ secrets.TELEGRAM_TO }}
```
send custom message:
```yml
- name: send custom message
uses: appleboy/telegram-action@master
env:
TELEGRAM_TOKEN: ${{ secrets.TELEGRAM_TOKEN }}
TELEGRAM_TO: ${{ secrets.TELEGRAM_TO }}
with:
message: |
The ${{ github.event_name }} event triggered final step.
echo This event is a pull request that had an assignee removed.
``` ```
## Secrets ## Secrets
@@ -70,8 +97,8 @@ Getting started with [Telegram Bot API](https://core.telegram.org/bots/api).
How to get unique identifier from telegram api: How to get unique identifier from telegram api:
``` ```bash
$ curl https://api.telegram.org/bot<token>/getUpdates curl https://api.telegram.org/bot<token>/getUpdates
``` ```
See the result: (get chat id like `65382999`) See the result: (get chat id like `65382999`)
@@ -106,3 +133,17 @@ See the result: (get chat id like `65382999`)
] ]
} }
``` ```
## Template variable
| Github Variable | Telegram Template Variable |
|-------------------|----------------------------|
| GITHUB_REPOSITORY | repo |
| GITHUB_ACTOR | repo.namespace |
| GITHUB_SHA | commit.sha |
| GITHUB_REF | commit.ref |
| GITHUB_WORKFLOW | github.workflow |
| GITHUB_ACTION | github.action |
| GITHUB_EVENT_NAME | github.event.name |
| GITHUB_EVENT_PATH | github.event.path |
| GITHUB_WORKSPACE | github.workspace |
+31
View File
@@ -0,0 +1,31 @@
name: 'Telegram Message Notify'
description: 'Sending a Telegram message'
author: 'Bo-Yi Wu'
inputs:
photo:
description: 'send the photo message.'
document:
description: 'send the document message.'
sticker:
description: 'send the sticker message.'
audio:
description: 'send the audio message.'
voice:
description: 'send the voice message.'
location:
description: 'send the location message.'
venue:
description: 'send the venue message.'
video:
description: 'send the video message.'
debug:
description: 'enable debug mode.'
format:
description: 'message format: markdown or html'
runs:
using: 'docker'
image: 'Dockerfile'
branding:
icon: 'message-square'
color: 'blue'