actions/telegram-action
1
0
Fork 0
mirror of https://github.com/appleboy/telegram-action.git synced 2026-10-09 04:30:43 +09:00
Code Issues Packages Projects Releases Wiki Activity

docs(readme): pin examples to v1.1.0 and sync input tables

Browse Source 
- Replace mutable @master references with the v1.1.0 tag
- Add required to/token rows to all input tables
- Add missing message_thread_id row to both Chinese translations
- Reword the default-message note to reference message instead of the
  removed args mechanism
This commit is contained in:
Bo-Yi Wu
2026-08-16 10:33:52 +08:00
parent 6753faf1d2
commit c18c95644a
3 changed files with 24 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+10 -8
View File
@@ -24,7 +24,7 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: send telegram message on push - name: send telegram message on push
uses: appleboy/telegram-action@master uses: appleboy/telegram-action@v1.1.0
with: with:
to: ${{ secrets.TELEGRAM_TO }} to: ${{ secrets.TELEGRAM_TO }}
token: ${{ secrets.TELEGRAM_TOKEN }} token: ${{ secrets.TELEGRAM_TOKEN }}
@@ -37,11 +37,11 @@ jobs:
See changes: https://github.com/${{ github.repository }}/commit/${{github.sha}} See changes: https://github.com/${{ github.repository }}/commit/${{github.sha}}
``` ```
Remove `args` to send the default message. Remove the `message` input to send the default message.
```yml ```yml
- name: send default message - name: send default message
uses: appleboy/telegram-action@master uses: appleboy/telegram-action@v1.1.0
with: with:
to: ${{ secrets.TELEGRAM_TO }} to: ${{ secrets.TELEGRAM_TO }}
token: ${{ secrets.TELEGRAM_TOKEN }} token: ${{ secrets.TELEGRAM_TOKEN }}
@@ -53,6 +53,8 @@ Remove `args` to send the default message.
| Variable | Description | | Variable | Description |
| ------------------------ | ----------------------------------------------------------------------------------------------------------------------- | | ------------------------ | ----------------------------------------------------------------------------------------------------------------------- |
| to | **required**. Unique identifier for the target chat. |
| token | **required**. Telegram authorization token. |
| socks5 | optional. Support socks5 proxy URL | | socks5 | optional. Support socks5 proxy URL |
| photo | optional. Photo message | | photo | optional. Photo message |
| document | optional. Document message | | document | optional. Document message |
@@ -75,9 +77,9 @@ Remove `args` to send the default message.
Send photo message: Send photo message:
```yml ```yml
- uses: actions/checkout@master - uses: actions/checkout@v7
- name: send photo message - name: send photo message
uses: appleboy/telegram-action@master uses: appleboy/telegram-action@v1.1.0
with: with:
to: ${{ secrets.TELEGRAM_TO }} to: ${{ secrets.TELEGRAM_TO }}
token: ${{ secrets.TELEGRAM_TOKEN }} token: ${{ secrets.TELEGRAM_TOKEN }}
@@ -90,7 +92,7 @@ Send location message:
```yml ```yml
- name: send location message - name: send location message
uses: appleboy/telegram-action@master uses: appleboy/telegram-action@v1.1.0
with: with:
to: ${{ secrets.TELEGRAM_TO }} to: ${{ secrets.TELEGRAM_TO }}
token: ${{ secrets.TELEGRAM_TOKEN }} token: ${{ secrets.TELEGRAM_TOKEN }}
@@ -102,7 +104,7 @@ Send a message to a specific forum topic (thread):
```yml ```yml
- name: send message to forum topic - name: send message to forum topic
uses: appleboy/telegram-action@master uses: appleboy/telegram-action@v1.1.0
with: with:
to: ${{ secrets.TELEGRAM_TO }} to: ${{ secrets.TELEGRAM_TO }}
token: ${{ secrets.TELEGRAM_TOKEN }} token: ${{ secrets.TELEGRAM_TOKEN }}
@@ -114,7 +116,7 @@ Send message using custom proxy (support `http`, `https`, and `socks5`) like `so
```yml ```yml
- name: send message using socks5 proxy URL - name: send message using socks5 proxy URL
uses: appleboy/telegram-action@master uses: appleboy/telegram-action@v1.1.0
with: with:
to: ${{ secrets.TELEGRAM_TO }} to: ${{ secrets.TELEGRAM_TO }}
token: ${{ secrets.TELEGRAM_TOKEN }} token: ${{ secrets.TELEGRAM_TOKEN }}
README.zh-cn.md
+7 -4
View File
@@ -16,6 +16,8 @@
| 变量 | 描述 | | 变量 | 描述 |
| ------------------------ | ------------------------------------------------------------------------------------------------------- | | ------------------------ | ------------------------------------------------------------------------------------------------------- |
| to | **必填**。目标聊天的唯一标识符 |
| token | **必填**。Telegram 授权令牌 |
| socks5 | 可选。支持 socks5 代理 URL | | socks5 | 可选。支持 socks5 代理 URL |
| photo | 可选。照片消息 | | photo | 可选。照片消息 |
| document | 可选。文档消息 | | document | 可选。文档消息 |
@@ -29,6 +31,7 @@
| format | 可选。`markdown` 或 `html`。参见 [MarkdownV2 样式](https://core.telegram.org/bots/api#markdownv2-style) | | format | 可选。`markdown` 或 `html`。参见 [MarkdownV2 样式](https://core.telegram.org/bots/api#markdownv2-style) |
| message | 可选。自定义消息 | | message | 可选。自定义消息 |
| message_file | 可选。用指定文件的内容覆盖默认消息模板。 | | message_file | 可选。用指定文件的内容覆盖默认消息模板。 |
| message_thread_id | 可选。论坛目标消息串（主题）的唯一标识符，仅适用于论坛超级群组。 |
| disable_web_page_preview | 可选。禁用此消息中链接的预览。默认值为 `false`。 | | disable_web_page_preview | 可选。禁用此消息中链接的预览。默认值为 `false`。 |
| disable_notification | 可选。禁用此消息的通知，支持发送无通知的消息。默认值为 `false`。 | | disable_notification | 可选。禁用此消息的通知，支持发送无通知的消息。默认值为 `false`。 |
@@ -37,9 +40,9 @@
发送照片消息： 发送照片消息：
```yml ```yml
- uses: actions/checkout@master - uses: actions/checkout@v7
- name: send photo message - name: send photo message
uses: appleboy/telegram-action@master uses: appleboy/telegram-action@v1.1.0
with: with:
to: ${{ secrets.TELEGRAM_TO }} to: ${{ secrets.TELEGRAM_TO }}
token: ${{ secrets.TELEGRAM_TOKEN }} token: ${{ secrets.TELEGRAM_TOKEN }}
@@ -52,7 +55,7 @@
```yml ```yml
- name: send location message - name: send location message
uses: appleboy/telegram-action@master uses: appleboy/telegram-action@v1.1.0
with: with:
to: ${{ secrets.TELEGRAM_TO }} to: ${{ secrets.TELEGRAM_TO }}
token: ${{ secrets.TELEGRAM_TOKEN }} token: ${{ secrets.TELEGRAM_TOKEN }}
@@ -64,7 +67,7 @@
```yml ```yml
- name: send message using socks5 proxy URL - name: send message using socks5 proxy URL
uses: appleboy/telegram-action@master uses: appleboy/telegram-action@v1.1.0
with: with:
to: ${{ secrets.TELEGRAM_TO }} to: ${{ secrets.TELEGRAM_TO }}
token: ${{ secrets.TELEGRAM_TOKEN }} token: ${{ secrets.TELEGRAM_TOKEN }}
README.zh-tw.md
+7 -4
View File
@@ -16,6 +16,8 @@
| 變數 | 說明 | | 變數 | 說明 |
| ------------------------ | ------------------------------------------------------------------------------------------------------- | | ------------------------ | ------------------------------------------------------------------------------------------------------- |
| to | **必填**。目標聊天的唯一標識符 |
| token | **必填**。Telegram 授權令牌 |
| socks5 | 選填。支援 socks5 代理 URL | | socks5 | 選填。支援 socks5 代理 URL |
| photo | 選填。圖片訊息 | | photo | 選填。圖片訊息 |
| document | 選填。文件訊息 | | document | 選填。文件訊息 |
@@ -29,6 +31,7 @@
| format | 選填。`markdown` 或 `html`。參見 [MarkdownV2 格式](https://core.telegram.org/bots/api#markdownv2-style) | | format | 選填。`markdown` 或 `html`。參見 [MarkdownV2 格式](https://core.telegram.org/bots/api#markdownv2-style) |
| message | 選填。自訂訊息 | | message | 選填。自訂訊息 |
| message_file | 選填。使用指定檔案的內容覆蓋預設訊息模板 | | message_file | 選填。使用指定檔案的內容覆蓋預設訊息模板 |
| message_thread_id | 選填。論壇目標訊息串（主題）的唯一標識符，僅適用於論壇超級群組 |
| disable_web_page_preview | 選填。停用此訊息中連結的預覽。預設為 `false` | | disable_web_page_preview | 選填。停用此訊息中連結的預覽。預設為 `false` |
| disable_notification | 選填。停用此訊息的通知，支援發送無通知的訊息。預設為 `false` | | disable_notification | 選填。停用此訊息的通知，支援發送無通知的訊息。預設為 `false` |
@@ -37,9 +40,9 @@
發送圖片訊息： 發送圖片訊息：
```yml ```yml
- uses: actions/checkout@master - uses: actions/checkout@v7
- name: send photo message - name: send photo message
uses: appleboy/telegram-action@master uses: appleboy/telegram-action@v1.1.0
with: with:
to: ${{ secrets.TELEGRAM_TO }} to: ${{ secrets.TELEGRAM_TO }}
token: ${{ secrets.TELEGRAM_TOKEN }} token: ${{ secrets.TELEGRAM_TOKEN }}
@@ -52,7 +55,7 @@
```yml ```yml
- name: send location message - name: send location message
uses: appleboy/telegram-action@master uses: appleboy/telegram-action@v1.1.0
with: with:
to: ${{ secrets.TELEGRAM_TO }} to: ${{ secrets.TELEGRAM_TO }}
token: ${{ secrets.TELEGRAM_TOKEN }} token: ${{ secrets.TELEGRAM_TOKEN }}
@@ -64,7 +67,7 @@
```yml ```yml
- name: send message using socks5 proxy URL - name: send message using socks5 proxy URL
uses: appleboy/telegram-action@master uses: appleboy/telegram-action@v1.1.0
with: with:
to: ${{ secrets.TELEGRAM_TO }} to: ${{ secrets.TELEGRAM_TO }}
token: ${{ secrets.TELEGRAM_TOKEN }} token: ${{ secrets.TELEGRAM_TOKEN }}