GitNotify - Мониторинг GitLab и Telegram-бот

Описание

GitNotify – это система мониторинга событий GitLab, которая состоит из двух основных компонентов:

1. gitlab_monitor.py
   Асинхронный скрипт для периодической проверки статусов CI/CD пайплайнов. При обнаружении изменения статуса скрипт может выполнять заданные действия (например, отправлять системные уведомления).

2. Telegram-бот (telegram_bot.py)
   Асинхронный бот, реализованный на основе библиотеки aiogram, который опрашивает события GitLab, такие как:

   • Изменения в статусах CI/CD пайплайнов,
   • Push-события (с информацией о ветке, количестве коммитов и авторе),
   • События merge request (создание, обновление, закрытие).

При обнаружении событий бот отправляет уведомления в Telegram согласно настройкам и шаблонам, заданным в файле конфигурации config.toml. Для формирования уведомлений используется название репозитория (project_name), а идентификатор может выводиться в скобках, если это необходимо.

Структура проекта

.
├── .gitignore
├── config.toml                # Файл конфигурации (настройки GitLab, Telegram и шаблоны уведомлений)
├── gitlab
│   ├── __init__.py
│   ├── api.py                 # Модуль для работы с API GitLab:
│   │         - Получение списка проектов, статусов пайплайнов и другой информации.
│   ├── events.py              # Модуль для опроса событий GitLab (CI/CD, push, merge request)
│   └── http_client.py         # Модуль для работы с HTTP запросами через aiohttp.
├── gitlab_monitor.py          # Скрипт для мониторинга CI/CD пайплайнов (с использованием aiohttp)
├── pyproject.toml             # Файл настроек проекта (при необходимости)
├── README.md                  # Документация проекта (этот файл)
└── telegram_bot.py            # Главный модуль Telegram-бота (опрашивает события и отправляет уведомления)

Установка

Для работы с проектом необходим Python 3.12. Рекомендуется использовать виртуальное окружение.

Установка зависимостей производится через утилиту uv:

uv sync

Конфигурация

Все настройки проекта задаются в файле config.toml. Пример конфигурации:

[gitlab]
url = "https://gitlab.com"
token = "YOUR_GITLAB_TOKEN"
poll_interval = 5

[telegram]
token = "YOUR_TELEGRAM_BOT_TOKEN"
default_chat = 123456789
message_thread_id = 0
message_template = """
<b>{event_type}</b>
Пользователь: {user}
Время: {timestamp}
Действие: {action}
Ссылка: <a href="{url}">{title}</a>
"""
pipeline_template = """
<b>CI/CD обновление</b>
Проект: <a href="{base_url}/projects/{project_id}">{project_name}</a>
Пользователь: GitLab
Время: {timestamp}
<b>{description}</b>

{ping}
"""
push_template = """
<b>Push событие</b>
Проект: <a href="{base_url}/projects/{project_id}">{project_name}</a>
Пользователь: {author}
Время: {timestamp}
Действие: Push в ветку {branch}, коммитов: {commit_count}
Ссылка: <a href="{base_url}/projects/{project_id}">{project_name}</a>

{ping}
"""
mr_template = """
<b>Merge Request #{iid}</b>
Проект: <a href="{base_url}/projects/{project_id}">{project_name}</a>
Пользователь: {author}
Время: {timestamp}
Действие: {title} (состояние: {state})

{ping}
"""

repo_mapping = { "@mention" = ["project_1", "project_2", "project_3"], "mention_2" = ["project_1"] }
}

Запуск

Для запуска системы необходимо выполнить два процесса:

1. GitLab мониторинг
   Запустите скрипт для проверки статусов пайплайнов:

python gitlab_monitor.py

2. Telegram-бот
   Запустите Telegram-бот:

python telegram_bot.py

При запуске оба процесса будут работать асинхронно, опрашивая GitLab и отправляя уведомления по событиям.