mirror of
https://github.com/appleboy/telegram-action.git
synced 2026-05-14 10:52:51 +00:00
Compare commits
38 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 2efd23283a | |||
| a5d86cddbc | |||
| f384cb685b | |||
| ed144893ba | |||
| beaf02496b | |||
| 6ecbcc43b0 | |||
| dc870f34e9 | |||
| 6cdf58fd81 | |||
| 1ecd8d50e4 | |||
| 9e5e0be372 | |||
| 0e7bbc5ef7 | |||
| 3295af7b78 | |||
| 12a87fd2ec | |||
| ec18563cbb | |||
| d23549b68a | |||
| 18c4142dfa | |||
| c05923bdec | |||
| 50dd6d184f | |||
| 68616a84f7 | |||
| f501e27814 | |||
| 867844f8a4 | |||
| abd0142ad9 | |||
| 363157132e | |||
| d0bf9f621b | |||
| 1ac4b1171b | |||
| 845086369b | |||
| 268d7f7856 | |||
| 7ba2054f08 | |||
| d04c916137 | |||
| df78a5d925 | |||
| 94223af513 | |||
| deae8157b2 | |||
| 74d1289afd | |||
| 65a4c9fc42 | |||
| ee6f548104 | |||
| 62444e6582 | |||
| 406cbeb82a | |||
| a5e94a4245 |
+78
-26
@@ -8,52 +8,104 @@ jobs:
|
||||
steps:
|
||||
- uses: actions/checkout@master
|
||||
- name: send custom message with args
|
||||
uses: appleboy/telegram-action@master
|
||||
env:
|
||||
TELEGRAM_TOKEN: ${{ secrets.TELEGRAM_TOKEN }}
|
||||
TELEGRAM_TO: ${{ secrets.TELEGRAM_TO }}
|
||||
uses: ./
|
||||
with:
|
||||
to: ${{ secrets.TELEGRAM_TO }}
|
||||
token: ${{ secrets.TELEGRAM_TOKEN }}
|
||||
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 }}
|
||||
- name: send message using with
|
||||
uses: ./
|
||||
with:
|
||||
message: The ${{ github.event_name }} event triggered second step.
|
||||
to: ${{ secrets.TELEGRAM_TO }}
|
||||
token: ${{ secrets.TELEGRAM_TOKEN }}
|
||||
message: |
|
||||
The ${{ github.event_name }} event triggered second step.
|
||||
show the github variable ref: ${{ github.ref }}
|
||||
show the github variable commit: ${{ github.sha }}
|
||||
show the github variable ref: {{ commit.ref }}
|
||||
show the github variable commit: {{ commit.sha }}
|
||||
Commit Message: ${{ github.event.head_commit.message }}
|
||||
|
||||
- name: send default message
|
||||
uses: appleboy/telegram-action@master
|
||||
env:
|
||||
TELEGRAM_TOKEN: ${{ secrets.TELEGRAM_TOKEN }}
|
||||
TELEGRAM_TO: ${{ secrets.TELEGRAM_TO }}
|
||||
uses: ./
|
||||
with:
|
||||
to: ${{ secrets.TELEGRAM_TO }}
|
||||
token: ${{ secrets.TELEGRAM_TOKEN }}
|
||||
|
||||
- name: send photo message
|
||||
uses: appleboy/telegram-action@master
|
||||
uses: ./
|
||||
with:
|
||||
to: ${{ secrets.TELEGRAM_TO }}
|
||||
token: ${{ secrets.TELEGRAM_TOKEN }}
|
||||
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
|
||||
uses: ./
|
||||
with:
|
||||
to: ${{ secrets.TELEGRAM_TO }}
|
||||
token: ${{ secrets.TELEGRAM_TOKEN }}
|
||||
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 }}
|
||||
uses: ./
|
||||
with:
|
||||
to: ${{ secrets.TELEGRAM_TO }}
|
||||
token: ${{ secrets.TELEGRAM_TOKEN }}
|
||||
message: |
|
||||
The ${{ github.event_name }} event triggered final step.
|
||||
echo This event is a pull request that had an assignee removed.
|
||||
|
||||
- name: send message file
|
||||
uses: ./
|
||||
with:
|
||||
to: ${{ secrets.TELEGRAM_TO }}
|
||||
token: ${{ secrets.TELEGRAM_TOKEN }}
|
||||
message_file: tests/message.txt
|
||||
|
||||
# - name: send message using socks5 proxy URL
|
||||
# uses: appleboy/telegram-action@master
|
||||
# with:
|
||||
# to: ${{ secrets.TELEGRAM_TO }}
|
||||
# token: ${{ secrets.TELEGRAM_TOKEN }}
|
||||
# socks5: "http://222.124.154.19:23500"
|
||||
# message: Send message from socks5 proxy URL.
|
||||
|
||||
# - name: try multiple message
|
||||
# uses: appleboy/telegram-action@master
|
||||
# with:
|
||||
# to: ${{ secrets.TELEGRAM_TO }}
|
||||
# token: ${{ secrets.TELEGRAM_TOKEN }}
|
||||
# format: html
|
||||
# message: |
|
||||
# ⚡️ <a href="https://github.com/aszenz/repo/commit/${{ github.event.push.after }}">Commits</a> pushed to master by <em>${{ github.event.push.pusher.name }}</em> ⚡️
|
||||
# ${{ github.actor }}:${{ github.event.head_commit.message }}
|
||||
|
||||
- name: link preview
|
||||
uses: ./
|
||||
with:
|
||||
to: ${{ secrets.TELEGRAM_TO }}
|
||||
token: ${{ secrets.TELEGRAM_TOKEN }}
|
||||
message: |
|
||||
show link preview https://google.com.tw
|
||||
|
||||
- name: disable link preview
|
||||
uses: ./
|
||||
with:
|
||||
to: ${{ secrets.TELEGRAM_TO }}
|
||||
token: ${{ secrets.TELEGRAM_TOKEN }}
|
||||
disable_web_page_preview: true
|
||||
message: |
|
||||
disable link preview https://google.com.tw
|
||||
|
||||
- name: sending a message without notification
|
||||
uses: ./
|
||||
with:
|
||||
to: ${{ secrets.TELEGRAM_TO }}
|
||||
token: ${{ secrets.TELEGRAM_TOKEN }}
|
||||
disable_notification: true
|
||||
message: |
|
||||
disable link preview https://google.com.tw
|
||||
|
||||
+2
-2
@@ -1,6 +1,6 @@
|
||||
FROM appleboy/drone-telegram:1.3.2-linux-amd64
|
||||
FROM appleboy/drone-telegram:1.3.9-linux-amd64
|
||||
|
||||
ADD entrypoint.sh /entrypoint.sh
|
||||
COPY entrypoint.sh /entrypoint.sh
|
||||
RUN chmod +x /entrypoint.sh
|
||||
|
||||
WORKDIR /github/workspace
|
||||
|
||||
@@ -4,11 +4,13 @@
|
||||
|
||||

|
||||
|
||||
[](https://github.com/appleboy/facebook-action/actions)
|
||||
[](https://github.com/appleboy/telegram-action/actions)
|
||||
|
||||
## Usage
|
||||
|
||||
Send custom message and see the custom variable as blow.
|
||||
**NOTE**: If you are getting "Error: Chat not found", then you need to look at this stackoverflow's answer [here](https://stackoverflow.com/a/41291666).
|
||||
|
||||
Send custom message and see the custom variable as below.
|
||||
|
||||
```yml
|
||||
name: telegram message
|
||||
@@ -22,10 +24,9 @@ jobs:
|
||||
- uses: actions/checkout@master
|
||||
- name: send custom message with args
|
||||
uses: appleboy/telegram-action@master
|
||||
env:
|
||||
TELEGRAM_TOKEN: ${{ secrets.TELEGRAM_TOKEN }}
|
||||
TELEGRAM_TO: ${{ secrets.TELEGRAM_TO }}
|
||||
with:
|
||||
to: ${{ secrets.TELEGRAM_TO }}
|
||||
token: ${{ secrets.TELEGRAM_TOKEN }}
|
||||
args: The ${{ github.event_name }} event triggered first step.
|
||||
```
|
||||
|
||||
@@ -34,15 +35,16 @@ Remove `args` to send the default message.
|
||||
```yml
|
||||
- name: send default message
|
||||
uses: appleboy/telegram-action@master
|
||||
env:
|
||||
TELEGRAM_TOKEN: ${{ secrets.TELEGRAM_TOKEN }}
|
||||
TELEGRAM_TO: ${{ secrets.TELEGRAM_TO }}
|
||||
with:
|
||||
to: ${{ secrets.TELEGRAM_TO }}
|
||||
token: ${{ secrets.TELEGRAM_TOKEN }}
|
||||
```
|
||||
|
||||

|
||||
|
||||
## Input variables
|
||||
|
||||
* socks5 - optional. support socks5 proxy URL
|
||||
* photo - optional. photo message
|
||||
* document - optional. document message
|
||||
* sticker - optional. sticker message
|
||||
@@ -52,9 +54,13 @@ Remove `args` to send the default message.
|
||||
* venue - optional. venue message
|
||||
* video - optional. video message
|
||||
* debug - optional. enable debug mode
|
||||
* format - optional. `markdown` or `html`
|
||||
* format - optional. `markdown` or `html`. See [MarkdownV2 style](https://core.telegram.org/bots/api#markdownv2-style)
|
||||
* message - optional. custom message
|
||||
* message_file - optional. overwrite the default message template with the contents of the specified file.
|
||||
* disable_web_page_preview - optional. disables link previews for links in this message. default is `false`.
|
||||
* disable_notification - optional. disables notifications for this message, supports sending a message without notification. default is `false`.
|
||||
|
||||
### Example
|
||||
## Example
|
||||
|
||||
send photo message:
|
||||
|
||||
@@ -63,12 +69,11 @@ send photo message:
|
||||
- name: send photo message
|
||||
uses: appleboy/telegram-action@master
|
||||
with:
|
||||
to: ${{ secrets.TELEGRAM_TO }}
|
||||
token: ${{ secrets.TELEGRAM_TOKEN }}
|
||||
message: send photo message
|
||||
photo: tests/github.png
|
||||
document: tests/gophercolor.png
|
||||
env:
|
||||
TELEGRAM_TOKEN: ${{ secrets.TELEGRAM_TOKEN }}
|
||||
TELEGRAM_TO: ${{ secrets.TELEGRAM_TO }}
|
||||
```
|
||||
|
||||
send location message:
|
||||
@@ -77,11 +82,10 @@ send location message:
|
||||
- name: send location message
|
||||
uses: appleboy/telegram-action@master
|
||||
with:
|
||||
to: ${{ secrets.TELEGRAM_TO }}
|
||||
token: ${{ secrets.TELEGRAM_TOKEN }}
|
||||
location: '24.9163213 121.1424972'
|
||||
venue: '35.661777 139.704051 竹北體育館 新竹縣竹北市'
|
||||
env:
|
||||
TELEGRAM_TOKEN: ${{ secrets.TELEGRAM_TOKEN }}
|
||||
TELEGRAM_TO: ${{ secrets.TELEGRAM_TO }}
|
||||
```
|
||||
|
||||
send custom message:
|
||||
@@ -89,21 +93,32 @@ 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:
|
||||
to: ${{ secrets.TELEGRAM_TO }}
|
||||
token: ${{ secrets.TELEGRAM_TOKEN }}
|
||||
message: |
|
||||
The ${{ github.event_name }} event triggered final step.
|
||||
echo This event is a pull request that had an assignee removed.
|
||||
```
|
||||
|
||||
send message using custom proxy (support `http`, `https`, and `socks5`) like `socks5://127.0.0.1:1080` or `http://222.124.154.19:23500`
|
||||
|
||||
```yml
|
||||
- name: send message using socks5 proxy URL
|
||||
uses: appleboy/telegram-action@master
|
||||
with:
|
||||
to: ${{ secrets.TELEGRAM_TO }}
|
||||
token: ${{ secrets.TELEGRAM_TOKEN }}
|
||||
socks5: "http://222.124.154.19:23500"
|
||||
message: Send message from socks5 proxy URL.
|
||||
```
|
||||
|
||||
## Secrets
|
||||
|
||||
Getting started with [Telegram Bot API](https://core.telegram.org/bots/api).
|
||||
|
||||
* `TELEGRAM_TOKEN`: Telegram authorization token.
|
||||
* `TELEGRAM_TO`: Unique identifier for this chat.
|
||||
* `token`: Telegram authorization token.
|
||||
* `to`: Unique identifier for this chat.
|
||||
|
||||
How to get unique identifier from telegram api:
|
||||
|
||||
|
||||
+14
@@ -2,6 +2,16 @@ name: 'Telegram Message Notify'
|
||||
description: 'Sending a Telegram message'
|
||||
author: 'Bo-Yi Wu'
|
||||
inputs:
|
||||
to:
|
||||
description: 'telegram user'
|
||||
token:
|
||||
description: 'telegram token'
|
||||
message:
|
||||
description: 'telegram message'
|
||||
message_file:
|
||||
description: 'overwrite the default message template with the contents of the specified file'
|
||||
socks5:
|
||||
description: 'support socks5 proxy URL'
|
||||
photo:
|
||||
description: 'send the photo message.'
|
||||
document:
|
||||
@@ -22,6 +32,10 @@ inputs:
|
||||
description: 'enable debug mode.'
|
||||
format:
|
||||
description: 'message format: markdown or html'
|
||||
disable_web_page_preview:
|
||||
description: 'disables link previews for links in this message'
|
||||
disable_notification:
|
||||
description: 'disables notifications for this message, supports sending a message without notification,'
|
||||
runs:
|
||||
using: 'docker'
|
||||
image: 'Dockerfile'
|
||||
|
||||
@@ -0,0 +1,3 @@
|
||||
Sample message loaded from file.
|
||||
|
||||
Commit msg: {{commit.message}}
|
||||
Reference in New Issue
Block a user