Skip to content

A GitHub action step that send a notification about your action runs

Notifications You must be signed in to change notification settings

haishanh/actions-telegram-notification

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

actions-telegram-notification

build-test

This action send a notification about your action runs.

Telegram Notification Screenshots

Usage

See action.yml

Basic:

- uses: haishanh/actions-telegram-notification@v1
  if: ${{ always() }}
  with:
    notification-token: ${{ secrets.NOTIFICATION_TOKEN }}
    job-status: ${{ job.status }}

You can obtain a NOTIFICATION_TOKEN by sending the command /token to the GitHub Actions Notification bot. After you get the token, goto your repo "Settings" page, select "Secrets" and add it as a secret environment variables there.

Note that GitHub Actions Notification bot is not a GitHub official one, the source code of the bot API is here. And it's running on vercel.

Development

# install deps
yarn

Smoke Test

create a .env file with content like below:

JWT="The NOTIFICATION_TOKEN you grab from the bot"
# if you want to use your own bot
BOT_TOKEN="your BOT_TOKEN"
CHAT_ID="your chat id"
yarn do ./src/local.ts

About

A GitHub action step that send a notification about your action runs

Resources

Stars

Watchers

Forks

Packages

No packages published