README

This package provides the ability to integrate the Telegram messaging service with GitHub and GitLab. With this package, you can create a Telegram bot to receive notifications from GitHub or GitLab events and manage customization through messages and buttons on Telegram.

📋 Requirements

• PHP ^8.4|^8.5
• Composer
• Telegram Bot

🔧 Installation

You can install this package via Composer:

composer require cslant/telegram-git-notifier

✨ Features

• Platform Enum: Type-safe GitHub/GitLab platform handling
• ChatTarget DTO: Structured chat ID parsing with thread support
• In-Memory Caching: Config files cached in memory with dirty flag for efficient I/O
• PSR-3 Logger: Standardized logging interface support
• API Retry Logic: Exponential backoff for Telegram API rate limits (HTTP 429)
• Safe Template Rendering: Closure-isolated scope for view templates
• Strict Types: Full type safety with readonly properties and explicit nullable params

🧪 Testing

composer test

📖 Official Documentation

Please see the Telegram Git Notifier Documentation for more information.

📦 Changelog

Please see CHANGELOG for more information on what has changed recently.

License

The MIT License (MIT). Please see License File for more information.