chore: upgrade base image to version 1.4.0

- Update the base image version from 1.3.9 to 1.4.0

Signed-off-by: appleboy <appleboy.tw@gmail.com>

.github/workflows/ci.yml

@@ -6,54 +6,106 @@ jobs:
     name: Build
     runs-on: ubuntu-latest
     steps:
-
+    - uses: actions/checkout@master
     - name: send custom message with args
-      uses: appleboy/telegram-action@master
+      uses: ./
-      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.
 
-    - name: send message useing with
+    - name: send message using with
-      uses: appleboy/telegram-action@master
+      uses: ./
-      env:
-        TELEGRAM_TOKEN: ${{ secrets.TELEGRAM_TOKEN }}
-        TELEGRAM_TO: ${{ secrets.TELEGRAM_TO }}
       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
+      uses: ./
-      env:
+      with:
-        TELEGRAM_TOKEN: ${{ secrets.TELEGRAM_TOKEN }}
+        to: ${{ secrets.TELEGRAM_TO }}
-        TELEGRAM_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
+      uses: ./
-      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.
+
+    - 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

Dockerfile

@@ -1,6 +1,6 @@
-FROM appleboy/drone-telegram:1.3.1-linux-amd64
+FROM appleboy/drone-telegram:1.4.0
 
-ADD entrypoint.sh /entrypoint.sh
+COPY entrypoint.sh /entrypoint.sh
 RUN chmod +x /entrypoint.sh
 
 WORKDIR /github/workspace

README.md

@@ -1,23 +1,38 @@
 # 🚀 Telegram for GitHub Actions
 
-[GitHub Action](https://developer.github.com/actions/) for sending a Telegram notification message.
+[GitHub Action](https://github.com/features/actions) for sending a Telegram notification message.
 
 ![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)
+[![Actions Status](https://github.com/appleboy/telegram-action/workflows/telegram%20message/badge.svg)](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: send custom message
+name: telegram message
-  uses: appleboy/telegram-action@master
+on: [push]
-  env:
+jobs:
-    TELEGRAM_TOKEN: ${{ secrets.TELEGRAM_TOKEN }}
+
-    TELEGRAM_TO: ${{ secrets.TELEGRAM_TO }}
+  build:
-  with:
+    name: Build
-    args: The ${{ github.event_name }} event triggered first step.
+    runs-on: ubuntu-latest
+    steps:
+      - name: send telegram message on push
+        uses: appleboy/telegram-action@master
+        with:
+          to: ${{ secrets.TELEGRAM_TO }}
+          token: ${{ secrets.TELEGRAM_TOKEN }}
+          message: |
+            ${{ github.actor }} created commit:
+            Commit message: ${{ github.event.commits[0].message }}
+            
+            Repository: ${{ github.repository }}
+            
+            See changes: https://github.com/${{ github.repository }}/commit/${{github.sha}}
 ```
 
 Remove `args` to send the default message.
@@ -25,15 +40,16 @@ Remove `args` to send the default message.
 ```yml
 - name: send default message
   uses: appleboy/telegram-action@master
-  env:
+  with:
-    TELEGRAM_TOKEN: ${{ secrets.TELEGRAM_TOKEN }}
+    to: ${{ secrets.TELEGRAM_TO }}
-    TELEGRAM_TO: ${{ secrets.TELEGRAM_TO }}
+    token: ${{ secrets.TELEGRAM_TOKEN }}
 ```
 
 ![workflow](./images/telegram-workflow.png)
 
 ## Input variables
 
+* socks5 - optional. support socks5 proxy URL
 * photo - optional. photo message
 * document - optional. document message
 * sticker - optional. sticker message
@@ -43,22 +59,26 @@ 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:
 
 ```yml
+- uses: actions/checkout@master
 - 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:
@@ -67,33 +87,30 @@ 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:
+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 custom message
+- name: send message using socks5 proxy URL
   uses: appleboy/telegram-action@master
-  env:
-    TELEGRAM_TOKEN: ${{ secrets.TELEGRAM_TOKEN }}
-    TELEGRAM_TO: ${{ secrets.TELEGRAM_TO }}
   with:
-    message: |
+    to: ${{ secrets.TELEGRAM_TO }}
-      The ${{ github.event_name }} event triggered final step.
+    token: ${{ secrets.TELEGRAM_TOKEN }}
-      echo This event is a pull request that had an assignee removed.
+    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.
+* `token`: Telegram authorization token.
-* `TELEGRAM_TO`: Unique identifier for this chat.
+* `to`: Unique identifier for this chat.
 
 How to get unique identifier from telegram api:
 

action.yml

@@ -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'

tests/message.txt

@@ -0,0 +1,3 @@
+Sample message loaded from file.
+
+Commit msg:  {{commit.message}}