cslant/laravel-telegram-git-notifier

Send notification from Gitlab and GitHub events to Telegram

v1.2.0 2024-05-23 13:29 UTC

Requires

• php: ^8.1
• cslant/telegram-git-notifier: ^v1.4

Requires (Dev)

• friendsofphp/php-cs-fixer: ^v3.0
• nunomaduro/collision: ^7.10
• nunomaduro/larastan: ^2.9
• orchestra/testbench: ^8.0
• pestphp/pest: ^2.0
• phpstan/extension-installer: ^1.3
• phpstan/phpstan-deprecation-rules: ^1.1
• phpstan/phpstan-phpunit: ^1.3

MIT

• Tan Nguyen

• notify
• telegram-bot
• git-webhook
• telegram-notifier
• github-notifier
• github-telegram-bot
• gitlab-notifier
• gitlab-telegram-bot
• telegram-bot-github-notify
• telegram-bot-gitlab-notify
• telegram-git-notifier
• cslant

README

📝 Introduction

Laravel Telegram Git Notifier is a Laravel package that allows you to create a Telegram bot to receive notifications from GitHub or GitLab events and manage customization through messages and buttons on Telegram.

• Send notifications of your GitHub/GitLab repositories to Telegram Bots, Groups, Super Groups (Multiple Topics), and Channels.
• The bot must be created using the BotFather

📋 Requirements

• PHP ^8.4|^8.5
• Laravel ^11.0|^12.0
• Composer
• Core: Telegram Git Notifier

🔧 Installation

You can install this package via Composer:

composer require cslant/laravel-telegram-git-notifier

✨ What's New in v2.0

New Features

• Webhook Security: VerifyWebhookSecret middleware with timing-safe hash_equals() comparison
• Webhook Status Command: Check webhook status via php artisan tg-notifier:webhook:status
• Deferrable Provider: Lazy-loaded service provider with singleton bindings for better performance
• API Retry Logic: Exponential backoff for Telegram API rate limits (HTTP 429)
• In-Memory Caching: Config files cached in memory with dirty flag
• Clean Template Format: Simplified emoji usage (single emoji per event type)

Improvements

• PHP 8.4+ support with readonly classes and properties
• Full type safety with explicit return types and nullable params
• match expressions instead of switch for cleaner code
• PSR-3 LoggerInterface support

Available Artisan Commands

Command	Description
tg-notifier:webhook:set	Set the webhook URL for your Telegram bot
tg-notifier:webhook:status	Check the current webhook status
tg-notifier:owner:config	Change owner for config JSON files

🚀 Usage

See the Usage - Telegram git notifier Documentation for a list of usage.

Please check and update some configurations in the documentation.

📖 Official Documentation

Please see the Telegram Git Notifier Documentation for more information.

✨ Supported events

GitHub Events Available

• Push

• Issues

• Issue Comment

• Pull Request

• Pull Request Review

• Fork

• Commit Comment

• Deployment

• Deployment Status

• Fork

• Workflow

• Watch

  ... and more events can be seen in the all GitHub events available

GitLab Events Available

• Push

• Tag Push

• Issue

• Merge Request

• Note

• Pipeline

• Wiki Page

• Build

• Deployment

• Release

  ... and more events can be seen in the all GitLab events available

License

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

📦 Changelog

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