https://github.com/tanhongit/gh-action-telegram-notify
Telegram notification action for GitHub Actions. This action sends a message to a Telegram chat using a bot.
https://github.com/tanhongit/gh-action-telegram-notify
github-actions github-workflows notification-github-action notify-workflows telegram telegram-bot telegram-bots telegram-messages telegram-notifications telegram-notify telegrambot
Last synced: 7 months ago
JSON representation
Telegram notification action for GitHub Actions. This action sends a message to a Telegram chat using a bot.
- Host: GitHub
- URL: https://github.com/tanhongit/gh-action-telegram-notify
- Owner: tanhongit
- Created: 2023-06-21T09:52:40.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-31T07:45:26.000Z (over 1 year ago)
- Last Synced: 2025-01-28T01:21:58.214Z (9 months ago)
- Topics: github-actions, github-workflows, notification-github-action, notify-workflows, telegram, telegram-bot, telegram-bots, telegram-messages, telegram-notifications, telegram-notify, telegrambot
- Homepage:
- Size: 16.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# gh-action-telegram-notify
This repository contains a simple setup for sending Telegram notifications through GitHub Actions.
It allows you to stay informed about various events and activities related to your GitHub repository.
---
**Professional related project:** [**_cslant/laravel-telegram-git-notifier_**](https://github.com/cslant/laravel-telegram-git-notifier.git)
# Information
- This action sends a message to a Telegram chat using a bot.
- The bot must be created using [@BotFather](https://telegram.me/botfather).
- Using [appleboy/telegram-action](https://github.com/appleboy/telegram-action) as a base.
# How it works
The workflow in this repository is configured to trigger various events such as pushes,
pull requests, issue updates, releases, comments, and more.
When any of these events occur, a notification will be sent to your Telegram chat using a Telegram bot.
The notifications will provide relevant information about the event,
such as the event type, repository name, user who initiated the event,
commit SHA and other useful details.
This can help you keep track of activities and changes happening in your repository,
allowing for better collaboration and project management.
# Setup
## 1. Create a bot using [@BotFather](https://telegram.me/botfather).
Once all the details have been entered,
you'll receive the confirmation message for your bot along with the details of the token.
Copy the token key as we would be required later on.
(It would be in the ##########:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx format,
where # are numbers and x are alphanumeric characters)
After that, open the link of your bot in the message and press start. (There should be no response) This is to get the unique chat ID, which tells the telegram bot to notify only you.
Go to https://api.telegram.org/bot/getUpdates,
and replace with the token you copied earlier.
You should see a JSON response with a chat ID. Copy the chat ID.
## 2. Create Secret Variables
Go to your repository **Settings > Secrets and variables** and add the following environment variables:
- `TELEGRAM_TO`: The chat ID of the user to notify.
- `TELEGRAM_TOKEN`: The token of the bot created in the previous step.
## 3. Create a workflow
Create a `.github/workflows/telegram-notify.yml` file in your GitHub repo and add the following code:
```yml
name: Telegram Notification
on:
push:
branches:
- main
- develop
pull_request:
branches:
- main
- develop
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Send message to Telegram
uses: appleboy/telegram-action@master
with:
to: ${{ secrets.TELEGRAM_TO }}
token: ${{ secrets.TELEGRAM_TOKEN }}
message: | #https://help.github.com/en/actions/reference/contexts-and-expression-syntax-for-github-actions#github-context
${{ github.event_name }} commit in ${{ github.repository }} by "${{ github.actor }}". [${{github.sha}}@${{ github.ref }}]
```
> Visit https://help.github.com/en/actions/reference/context-and-expression-syntax-for-github-actions for more available environment variables.
**_You can also check my [workflow](https://github.com/tanhongit/gh-action-telegram-notify/blob/main/.github/workflows/telegram-notify.yml) for reference._**
## 4. Push a commit to your repo
```bash
git add .
git commit -m "add telegram notification"
git push origin main
```
## 5. Check the action tab
## 6. Check the telegram message
