nikto_b/action-telegram-notify
1
0
Fork 0
mirror of https://github.com/chapvic/action-telegram-notify.git synced 2026-01-11 08:51:37 +03:00
Code Issues Packages Projects Releases Wiki Activity

Initial commit

Browse Source
This commit is contained in:
Victor Chapaev
2024-06-29 19:44:51 +03:00
commit 0fc0deba1a
10 changed files with 398 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
README_RU.md Normal file
View File

@@ -0,0 +1,44 @@
# Отправка уведомлений в Телеграм
[![Build](https://github.com/chapvic/telegram-notify/actions/workflows/build.yml/badge.svg)](https://github.com/chapvic/telegram-notify/actions/workflows/build.yml)
Отправляет уведомления о состоянии выполнения рабочих потоков в ваш Телеграм-бот с поддержкой различных Git-серверов, таких как Gitea, Gogs.
## Использование
Сначала необходимо создать Телеграм-бот с помощью [@BotFather](https://t.me/botfather). Смотрите официальное руководство: https://core.telegram.org/bots#6-botfather
Если вам необходимо получать уведомления в личный чат с помощью бота, то необходимо определить свой ID пользователя, например через бота [@jsondumpbot](https://t.me/jsondumpbot).
Также вы можете использовать каналы для уведомлений, указав название канала в формате `@channelname`.
Добавить токен вашего бота, ID пользователя (или названия Телеграм-канала) в раздел "Секреты" вашего репозитория.
Добавить следующий шаг последним в ваш рабочий поток:
```yaml
- name: Send notification to Telegram
uses: chapvic/telegram-notify@master
if: always()
with:
token: ${{ secrets.TELEGRAM_BOT_TOKEN }} # Токен доступа к вашему боту
chat: ${{ secrets.TELEGRAM_CHAT_ID }} # ID пользователя или название канала
status: ${{ job.status }} # Не изменяйте это значение !!!
```
Вы можете указать необязательные аргументы в вашем рабочем потоке:
```yaml
- name: Send notification to Telegram
uses: chapvic/telegram-notify@master
if: always()
with:
token: ${{ secrets.TELEGRAM_BOT_TOKEN }} # Токен доступа к вашему боту
chat: ${{ secrets.TELEGRAM_CHAT_ID }} # ID пользователя или название канала
status: ${{ job.status }} # Не изменяйте это значение !!!
title: Заголовок вашего сообщения
message: Основное сообщение
footer: Подпись вашего сообщения
```
Все передваемые дополнительные аргуменеты должны содержать текст в формате Markdown