mirror of https://github.com/appleboy/telegram-action.git synced 2026-05-14 02:42:44 +00:00

Files

T

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

2.8 KiB

Raw Blame History

🚀 Telegram for GitHub Actions

GitHub Action for sending a Telegram notification message.

Usage

Send custom message and see the custom variable as blow.

action "Send Custom Message" {
  uses = "appleboy/telegram-action@master"
  secrets = [
    "TELEGRAM_TOKEN",
    "TELEGRAM_TO",
  ]
  args = "A new commit has been pushed. commit sha: {{ commit.sha }}"
}

Remove args to send the default message.

action "Send Default Message" {
  uses = "appleboy/telegram-action@master"
  secrets = [
    "TELEGRAM_TOKEN",
    "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

action "Send photo message" {
  uses = "appleboy/telegram-action@master"
  secrets = [
    "TELEGRAM_TOKEN",
    "TELEGRAM_TO",
  ]
  env = {
    PHOTO = "tests/github.png"
  }
  args = "A new commit has been pushed."
}

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

2.8 KiB Raw Blame History