🚀 Telegram for GitHub Actions

GitHub Action for sending a Telegram notification message.

Usage

Send custom message and see the custom variable as blow.

- name: send custom message
  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.

Remove args to send the default message.

- name: send default message
  uses: appleboy/telegram-action@master
  env:
    TELEGRAM_TOKEN: ${{ secrets.TELEGRAM_TOKEN }}
    TELEGRAM_TO: ${{ secrets.TELEGRAM_TO }}

Environment variables

• photo - optional. photo message
• document - optional. document message
• sticker - optional. sticker message
• audio - optional. audio message
• voice - optional. voice message
• location - optional. location message
• venue - optional. venue message
• video - optional. video message
• debug - optional. enable debug mode
• format - optional. markdown or html

Example

- 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 }}

Secrets

Getting started with Telegram Bot API.

• TELEGRAM_TOKEN: Telegram authorization token.
• TELEGRAM_TO: Unique identifier for this chat.

How to get unique identifier from telegram api:

curl https://api.telegram.org/bot<token>/getUpdates

See the result: (get chat id like 65382999)

{
  "ok": true,
  "result": [
    {
      "update_id": 664568113,
      "message": {
        "message_id": 8423,
        "from": {
          "id": 65382999,
          "is_bot": false,
          "first_name": "Bo-Yi",
          "last_name": "Wu (appleboy)",
          "username": "appleboy46",
          "language_code": "en"
        },
        "chat": {
          "id": 65382999,
          "first_name": "Bo-Yi",
          "last_name": "Wu (appleboy)",
          "username": "appleboy46",
          "type": "private"
        },
        "date": 1550333434,
        "text": "?"
      }
    }
  ]
}

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