diff --git a/documentation/ru/docs/architecture/concept.md b/documentation/ru/docs/architecture/concept.md index 8064d3f..0fd356c 100644 --- a/documentation/ru/docs/architecture/concept.md +++ b/documentation/ru/docs/architecture/concept.md @@ -1,5 +1,9 @@ # Общая архитектура +!!! warning + + Данный раздел находится в процессе написания + Поддерживается два режима работы: периодические запуски на ПК и запуск на сервере в режиме 24/7. ## Схема БД { id="schema-database" } @@ -22,7 +26,4 @@ Не везде имется возможность установить произвольные Webhook. Например, вряд ли кто-то позволит вам установить Webhook из корпоративного GitLab во внешнюю сеть. Переодическое обращение к GitLab API можно выполнять прямо с рабочей машины. - В будущем планирую добавить поддержку и Webhook. - -## Отслеживание репозиториев -Ключевым (рутовым) элементом являются репозитории. \ No newline at end of file + В будущем планирую добавить поддержку и Webhook. \ No newline at end of file diff --git a/documentation/ru/docs/features/img/gitlab-thread-answer.png b/documentation/ru/docs/features/img/gitlab-thread-answer.png new file mode 100644 index 0000000..dfbec4e Binary files /dev/null and b/documentation/ru/docs/features/img/gitlab-thread-answer.png differ diff --git a/documentation/ru/docs/features/img/telegram-thread-answer.png b/documentation/ru/docs/features/img/telegram-thread-answer.png new file mode 100644 index 0000000..d18a90e Binary files /dev/null and b/documentation/ru/docs/features/img/telegram-thread-answer.png differ diff --git a/documentation/ru/docs/features/interaction-bot.md b/documentation/ru/docs/features/interaction-bot.md new file mode 100644 index 0000000..75a0e93 --- /dev/null +++ b/documentation/ru/docs/features/interaction-bot.md @@ -0,0 +1,30 @@ +# Взаимодействие с ботом + +Главное меню бота вызывается с помощью команды `/start` + +!!! note + + На данный момент главное меню содержит только пункт: "Добавить новый репозиторий". В будущем функционал существенно расширится. + +## Добавить новый репозиторий + +Если во время первичной инициализации не стали добавлять все доступные репозитории, или не включили автоматическое отслеживание появления новых репозиториев, то вы можете добавлять репозитории самостоятельно. + +Для этого: + +* Вызовите главное меню командой `/start` +* Выберете пункт `Add repository`, который позволяет поставить репозиторий на отслеживание +* Скопируйте ссылку на репозиторий из адресной строки браузера и отправьте ее боту. +* Если все пройдет успешно, то вы получите уведомление `👍 Projects added successfully!` + +Это позволит вам получать все уведомления репозитория и его сущностей, таких как MR, пайплайны и так далее. + +!!! tip "Массовое добавление" + + Если вы хотите добавить множество репозиториев разом, то вы можете это сделать. Сформируйте сообщение с несколькими ссылками, где каждая ссылка на репозиторий будет на новой строке: + + ``` + https://gitlab.com/groupname/projectname1/repositoryname1 + https://gitlab.com/groupname/projectname1/repositoryname2 + https://gitlab.com/groupname/projectname2/repositoryname3 + ``` diff --git a/documentation/ru/docs/features/interaction-gitlab.md b/documentation/ru/docs/features/interaction-gitlab.md index 730ed16..143c899 100644 --- a/documentation/ru/docs/features/interaction-gitlab.md +++ b/documentation/ru/docs/features/interaction-gitlab.md @@ -1,6 +1,16 @@ # Взаимодействие с GitLab -## Добавить новый репозиторий - ## Ответ в треде -Допустим вас упомянули в обсуждении, сразу знаете что ответить? Не тратьте время, отвечайте прямо из телеграм. Для этого просто ответьте на сообщение и напишите ваш комментарий. \ No newline at end of file +Допустим вас упомянули в обсуждении, сразу знаете что ответить? Не тратьте время, отвечайте прямо из телеграм. Для этого просто ответьте на сообщение и напишите ваш комментарий. + +Просто ответьте на сообщение уведомления: + +
+ ![telegram-thread-answer.png](img/telegram-thread-answer.png){ loading=lazy align=left width="700" } +
+ +Так это будет выглядеть в GitLab: + +
+ ![gitlab-thread-answer.png](img/gitlab-thread-answer.png){ loading=lazy align=left width="700" } +
\ No newline at end of file diff --git a/documentation/ru/docs/features/notify.md b/documentation/ru/docs/features/notify.md index 7eb98ed..36cd31d 100644 --- a/documentation/ru/docs/features/notify.md +++ b/documentation/ru/docs/features/notify.md @@ -190,14 +190,20 @@ ## Уведомление о пайплайне Полезно сразу узнавать, что сборка закончилась успешно или упала. +!!! question "Я буду получать уведомление обо всех пайплайнах?" + + Нет. Вы будете получать уведомление только о тех пайплайнах, в которых выступили инициатором. Напримр, запустили CI руками из GitLab, или нажали кнопку Merge в MR. +
![notify about new pipeline](img/notify-new-pipeline.png){ loading=lazy width="500" }
Уведомление содержит: -- Предыдущий статус пайплайна и новый -- +- Предыдущий статус пайплайна и новый статус +- Номер пайплайна +- Название репозитория +- Ветка, для которой запускалась сборка Доступные быстрые действия: diff --git a/documentation/ru/docs/getting-started/configuration.md b/documentation/ru/docs/getting-started/configuration.md index 6281fbf..0772d72 100644 --- a/documentation/ru/docs/getting-started/configuration.md +++ b/documentation/ru/docs/getting-started/configuration.md @@ -2,10 +2,13 @@ Есть несколько способов запустить бота-помощника. Бот был спроектирован таким образом, чтобы работать локально на вашем ПК, но вы можете запустить его на сервере в режиме 24/4. -Первым делом вам предложат ввести имя для бота. +Для начала выполните эти действия: + +1. [Создание бота в Telegram](creating-telegram-bot.md) +2. [Получение персонального токена в GitLab](create-gitlab-token.md) ## Конфигурация -Несмотря на то, какой вариант запуска вы вберете, необходимо указать следующие переменные среды: +Вне зависимости от того, какой способ вы выберете, необходимо будет указать данные переменные среды: * `TELEGRAM_BOT_TOKEN` — токен, который вы получили при [создании бота](creating-telegram-bot.md). * `TELEGRAM_BOT_USERNAME` — название, которое вы дали боту. Оканчивается на bot. @@ -98,22 +101,4 @@ docker run --name gitlab-notify \ --env DATASOURCE_USERNAME=postgres \ --env DATASOURCE_PASSWORD=value \ --network="host" upagge/gitlab-telegram-notify:latest -``` - -## Запуск в IDEA - -## Запуск JAR релиза - -Скачать актуальный jar-файл всегда можно на странице релизов GitHub. - -``` shell -java -DTELEGRAM_BOT_USERNAME=value \ - -DTELEGRAM_BOT_TOKEN=value \ - -DTELEGRAM_PERSON_ID=value \ - -DDATASOURCE_URL=value \ - -DDATASOURCE_PASSWORD=value \ - -DDATASOURCE_USERNAME=value \ - -DGITLAB_PERSONAL_TOKEN=value \ - -DGITLAB_URL=value \ - -jar gitlab-notification.jar ``` \ No newline at end of file diff --git a/documentation/ru/docs/getting-started/create-gitlab-token.md b/documentation/ru/docs/getting-started/create-gitlab-token.md index 5dccdb1..e9978b8 100644 --- a/documentation/ru/docs/getting-started/create-gitlab-token.md +++ b/documentation/ru/docs/getting-started/create-gitlab-token.md @@ -1 +1,19 @@ -# Создание токена GitLab \ No newline at end of file +# Создание токена GitLab + +Для взаимодействия с GitLab необходим персональный токен доступа. + +Чтобы его получить перейдите по адресу: [https://gitlab.com/-/profile/personal_access_tokens](https://gitlab.com/-/profile/personal_access_tokens) + +!!! tip "Корпоративный GitLab" + + Замените `https://gitlab.com/` на адрес своего GitLab, если вы используете self-host решение. + +* Придумайте название токену, например, `GitLab Notify`. +* Выдайте права на чтение - `read_api` + +!!! info "Уровень разрешений" + + Выберете уровень разрешения `api`, если планируете пользоваться такими функциями, как: [ответ в треде](../features/interaction-gitlab.md#ответ-в-треде) + +* Нажмите кнопку `Create personal access token`. +* Сохраните полученный токен. \ No newline at end of file diff --git a/documentation/ru/docs/getting-started/creating-telegram-bot.md b/documentation/ru/docs/getting-started/creating-telegram-bot.md index e6f9592..848d16f 100644 --- a/documentation/ru/docs/getting-started/creating-telegram-bot.md +++ b/documentation/ru/docs/getting-started/creating-telegram-bot.md @@ -6,7 +6,7 @@ Первые два пункта диалогового меню будет про название бота. Учтите, что это называние общедоступно и случайноы пользователь Telegram сможет найти вашего бота. - Не переживайте, приложение имеет встроенную защиту от несанкционарованного доступа к боту. Но не смотря на это, ==не рекомендуется использовать в названии бота название организации, или вашу фамилию. Лучше использовать случайное имя.== + Не переживайте, приложение имеет встроенную [защиту от несанкционарованного доступа к боту](../privacy/index.md#access-control). Но не смотря на это, ==не рекомендуется использовать в названии бота название организации, или вашу фамилию. Лучше использовать случайное имя.== После регистрации вам будет выдан токен доступа. Он будет использоваться при запуске ассистента. diff --git a/documentation/ru/docs/getting-started/first-start.md b/documentation/ru/docs/getting-started/first-start.md index 466703b..5085855 100644 --- a/documentation/ru/docs/getting-started/first-start.md +++ b/documentation/ru/docs/getting-started/first-start.md @@ -1,5 +1,7 @@ # Инициализация бота +В данном видео демонстрируется процесс первичной настройки бота, чтобы вы знали, чего ожидать: +