Skip to content

jabardigitalservice/generate-report-webhook

Repository files navigation

Webhook Git Generate Report Telegram Bot

This git webhook includes gitlab and github, installed in git organization settings, so all repos can use this webhook with one configuration. helps to automatically report each time according to the main task of making code or as a peer to peer code

How to use

  1. Make a pull request/merge request
  2. Added evidence format in the description section
## Evidence
- title:
- project:
- participants:
- date: (Optional)
  1. do Merge
  2. The report will be sent directly by the Telegram bot, containing a screenshot of the pull request/merge request, title, project, participants, url
  3. Participants are taken from the Telegram username

Limitation

As for the limitations of this generated git webhook report for private repos, there is an additional process where this webhook feature will only send messages without screenshots, therefore it requires sending screenshots manually.

Architecture

image

Stack Technology

  • NodeJS
  • Express Framework
  • Redis (Message Broker)
  • Elastic (Logging)
  • API Telegram

Quick Start

Clone project and install dependencies:

git clone https://github.com/jabardigitalservice/generate-report-webhook.git
cd generate-report-webhook
cp .env.example .env

Run with Docker Compose

docker-compose up --build