Coder Social home page Coder Social logo

gitlab-telegram-bot's Introduction

TelegramBot для gitlab

Находит все ветки, подходящие по паттерну, в группе проектов в гитлабе и отправляет результат в телеграм

Один из usecase'ов

Пролог

Ваш проект состоит из 15 репозиториев в гитлабе и все они лежат в одной группе projectName
Вы сделали задачу, которая затронула 5 репозиториев. Bетка называется 666-is-my-favourite-number

Проблема

Вам нужно влить таск в тестовые ветки в каждом проекте, но вот незадача, вы совершенно не помните, какие проекты затронули

Решение

Отправляете боту сообщение /branches 666 и получаете список репозиториев с веткой, в названии которой есть 666

Getting Started

1. Добавляем в проект mvn dependency

<dependency>
  <groupId>tech.lisza</groupId>
  <artifactId>gitlab-telegram-bot</artifactId>
  <version>1.0.0-RELEASE</version>
</dependency>

2. Создаем бота и токен в гитлабе

Бот создается через @BotFather. После создания понадобится токен, имя бота и создать команду /branches
Токен для группы в гитлабе можно создать так

2. Определяем необходимые environment variables

Name Default value Description
gitlab.group.name empty Название группы в гитлабе (нужно для запроса в гитлаб)
gitlab.group.token empty Токен для получения инфы от гитлаба
gitlab.group.graphql_url empty URL для графкл запросов к гитлабу: https://<your-gitlab-site.com>/api/graphql
telegram.bot.name empty Имя бота после @
telegram.bot.token empty Токен от созданного бота
telegram.bot.allowed_chats empty массив id чатов, в которых разрешено использовать бота

Как работает

Бот реагирует на команды, которые заведены через @BotFather и обработка реализована в коде
За каждую команду отвечает свой handler, который должен наследоваться от CommandHandler
По дефолту реализована только команда /branches, которая обрабатывается BranchesHandler, но ничего не мешает вам написать свой хэндлер и реализовать новую команду

P.S. Лучше сделать так, чтобы у бота не было доступа к сообщениям в чате и он реагировал только на команды. Настраивается это через BotFather – privacy mode
P.P.S. Бот не работает в лс

gitlab-telegram-bot's People

Contributors

liszaa avatar

Stargazers

 avatar

Watchers

 avatar

Forkers

an1s9n

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.