kubk / labelbot

Telegram bot that notifies you whenever an issue is tagged with a specific label on GitHub / BitBucket / GitLab

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Labelbot Build Status

Labelbot is a Telegram bot that allows you to subscribe to a label (for example "good first issue" or "easy pick"). Whenever an issue is tagged with the label you subscribed to, you will get a notification. The main purpose of this project is to make a contribution to Open Source for newcomers a little bit easier.

Features

  • GitHub / BitBucket / GitLab support
  • Email / Telegram notifications
  • Labelbot can communicate with a user in multiple languages

Technology stack

  • Symfony 4
  • BotMan
  • Enqueue with RabbitMQ transport
  • Redis is used for persisting ETag headers in order to prevent reaching the X-Rate-Limit imposed by GitHub

Requirements

  • docker
  • docker-compose

Installation

  1. git clone
  2. docker-compose -f docker/docker-compose.dev.yml up
  3. docker exec -it labelbot_php composer install
  4. docker exec -it labelbot_php bin/console doctrine:database:create
  5. docker exec -it labelbot_php bin/console doctrine:migrations:migrate

Configure Telegram webhook

The easiest way is to use Ngrok:

  1. ngrok http 80
  2. bin/console app:webhook --url=<ngrok_url_with_https>

To delete webhook use bin/console app:webhook --delete

Testing

  1. make prepare-test-env
  2. make test

About

Telegram bot that notifies you whenever an issue is tagged with a specific label on GitHub / BitBucket / GitLab


Languages

Language:PHP 98.5%Language:Shell 0.7%Language:Dockerfile 0.5%Language:Makefile 0.4%