Telegram-Bots/gitlab-notification
4
1
Fork 0
Code Issues 21 Pull Requests Packages Projects 2 Releases 1 Activity

Deployed 3703a19 to develop in gitlab-notification/ru with MkDocs 1.4.2 and mike 1.1.2
All checks were successful
continuous-integration/drone/push Build is passing
Details

Browse Source
This commit is contained in:
Struchkov Mark 2023-03-05 16:05:39 +00:00
parent 0092ff2356
commit 4a6db31bef
20 changed files with 1557 additions and 132 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
gitlab-notification/ru/develop/404.html
View File

@ -327,6 +327,8 @@
<li class="md-nav__item md-nav__item--section md-nav__item--nested"> <li class="md-nav__item md-nav__item--section md-nav__item--nested">
@ -402,7 +404,35 @@
<span class="md-ellipsis"> <span class="md-ellipsis">
Быстрые действия Взаимодействие с GitLab
</span>
</a>
</li>
<li class="md-nav__item">
<a href="/gitlab-notification/ru/develop/features/interaction-bot/" class="md-nav__link">
<span class="md-ellipsis">
<span class="md-typeset">
Взаимодействие с ботом
</span>

51
gitlab-notification/ru/develop/architecture/concept/index.html
View File

@ -364,6 +364,8 @@
<li class="md-nav__item md-nav__item--section md-nav__item--nested"> <li class="md-nav__item md-nav__item--section md-nav__item--nested">
@ -439,7 +441,35 @@
<span class="md-ellipsis"> <span class="md-ellipsis">
Быстрые действия Взаимодействие с GitLab
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../features/interaction-bot/" class="md-nav__link">
<span class="md-ellipsis">
<span class="md-typeset">
Взаимодействие с ботом
</span>
@ -776,19 +806,6 @@
</span> </span>
</a> </a>
</li>
<li class="md-nav__item">
<a href="#_2" class="md-nav__link">
<span class="md-ellipsis">
<span class="md-typeset">
Отслеживание репозиториев
</span>
</span>
</a>
</li> </li>
</ul> </ul>
@ -965,6 +982,10 @@
<h1 id="_1">Общая архитектура<a class="headerlink" href="#_1" title="Permanent link">⚓︎</a></h1> <h1 id="_1">Общая архитектура<a class="headerlink" href="#_1" title="Permanent link">⚓︎</a></h1>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Данный раздел находится в процессе написания</p>
</div>
<p>Поддерживается два режима работы: периодические запуски на ПК и запуск на сервере в режиме 24/7.</p> <p>Поддерживается два режима работы: периодические запуски на ПК и запуск на сервере в режиме 24/7.</p>
<h2 id="schema-database">Схема <abbr title="База данных">БД</abbr><a class="headerlink" href="#schema-database" title="Permanent link">⚓︎</a></h2> <h2 id="schema-database">Схема <abbr title="База данных">БД</abbr><a class="headerlink" href="#schema-database" title="Permanent link">⚓︎</a></h2>
<p>Приложение имеет <abbr title="База данных">БД</abbr>, которая используется для сохранения состояния отслеживаемых сущностей GitLab.</p> <p>Приложение имеет <abbr title="База данных">БД</abbr>, которая используется для сохранения состояния отслеживаемых сущностей GitLab.</p>
@ -982,8 +1003,6 @@
<p>Не везде имется возможность установить произвольные Webhook. Например, вряд ли кто-то позволит вам установить Webhook из корпоративного GitLab во внешнюю сеть. Переодическое обращение к GitLab API можно выполнять прямо с рабочей машины.</p> <p>Не везде имется возможность установить произвольные Webhook. Например, вряд ли кто-то позволит вам установить Webhook из корпоративного GitLab во внешнюю сеть. Переодическое обращение к GitLab API можно выполнять прямо с рабочей машины.</p>
<p>В будущем планирую добавить поддержку и Webhook.</p> <p>В будущем планирую добавить поддержку и Webhook.</p>
</div> </div>
<h2 id="_2">Отслеживание репозиториев<a class="headerlink" href="#_2" title="Permanent link">⚓︎</a></h2>
<p>Ключевым (рутовым) элементом являются репозитории.</p>

BIN
gitlab-notification/ru/develop/assets/images/social/features/interaction-bot.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 27 KiB

BIN
gitlab-notification/ru/develop/assets/images/social/features/interaction-gitlab.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 23 KiB

After

Width:  |  Height:  |  Size: 27 KiB

32
gitlab-notification/ru/develop/changelog/index.html
View File

@ -364,6 +364,8 @@
<li class="md-nav__item md-nav__item--section md-nav__item--nested"> <li class="md-nav__item md-nav__item--section md-nav__item--nested">
@ -439,7 +441,35 @@
<span class="md-ellipsis"> <span class="md-ellipsis">
Быстрые действия Взаимодействие с GitLab
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../features/interaction-bot/" class="md-nav__link">
<span class="md-ellipsis">
<span class="md-typeset">
Взаимодействие с ботом
</span>

BIN
gitlab-notification/ru/develop/features/img/gitlab-thread-answer.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 86 KiB

BIN
gitlab-notification/ru/develop/features/img/telegram-thread-answer.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 244 KiB

1096
gitlab-notification/ru/develop/features/interaction-bot/index.html Normal file
View File

File diff suppressed because it is too large Load Diff

72
gitlab-notification/ru/develop/features/interaction-gitlab/index.html
View File

@ -14,7 +14,7 @@
<link rel="prev" href="../notify/"> <link rel="prev" href="../notify/">
<link rel="next" href="../../getting-started/create-gitlab-token/"> <link rel="next" href="../interaction-bot/">
@ -25,7 +25,7 @@
<title>Быстрые действия - GitLab Notification</title> <title>Взаимодействие с GitLab - GitLab Notification</title>
@ -81,7 +81,7 @@
<meta property="og:type" content="website" > <meta property="og:type" content="website" >
<meta property="og:title" content="Быстрые действия - GitLab Notification" > <meta property="og:title" content="Взаимодействие с GitLab - GitLab Notification" >
<meta property="og:description" content="None" > <meta property="og:description" content="None" >
@ -97,7 +97,7 @@
<meta name="twitter:card" content="summary_large_image" > <meta name="twitter:card" content="summary_large_image" >
<meta name="twitter:title" content="Быстрые действия - GitLab Notification" > <meta name="twitter:title" content="Взаимодействие с GitLab - GitLab Notification" >
<meta name="twitter:description" content="None" > <meta name="twitter:description" content="None" >
@ -161,7 +161,7 @@
<div class="md-header__topic" data-md-component="header-topic"> <div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis"> <span class="md-ellipsis">
Быстрые действия Взаимодействие с GitLab
</span> </span>
</div> </div>
@ -364,6 +364,8 @@
@ -450,7 +452,7 @@
<span class="md-ellipsis"> <span class="md-ellipsis">
Быстрые действия Взаимодействие с GitLab
@ -467,7 +469,7 @@
<span class="md-ellipsis"> <span class="md-ellipsis">
Быстрые действия Взаимодействие с GitLab
@ -496,19 +498,6 @@
<li class="md-nav__item"> <li class="md-nav__item">
<a href="#_1" class="md-nav__link"> <a href="#_1" class="md-nav__link">
<span class="md-ellipsis">
<span class="md-typeset">
Добавить новый репозиторий
</span>
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#_2" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
<span class="md-typeset"> <span class="md-typeset">
@ -529,6 +518,34 @@
<li class="md-nav__item">
<a href="../interaction-bot/" class="md-nav__link">
<span class="md-ellipsis">
<span class="md-typeset">
Взаимодействие с ботом
</span>
</span>
</a>
</li>
</ul> </ul>
</nav> </nav>
@ -952,9 +969,16 @@
<h1 id="gitlab">Взаимодействие с GitLab<a class="headerlink" href="#gitlab" title="Permanent link">⚓︎</a></h1> <h1 id="gitlab">Взаимодействие с GitLab<a class="headerlink" href="#gitlab" title="Permanent link">⚓︎</a></h1>
<h2 id="_1">Добавить новый репозиторий<a class="headerlink" href="#_1" title="Permanent link">⚓︎</a></h2> <h2 id="_1">Ответ в треде<a class="headerlink" href="#_1" title="Permanent link">⚓︎</a></h2>
<h2 id="_2">Ответ в треде<a class="headerlink" href="#_2" title="Permanent link">⚓︎</a></h2>
<p>Допустим вас упомянули в обсуждении, сразу знаете что ответить? Не тратьте время, отвечайте прямо из телеграм. Для этого просто ответьте на сообщение и напишите ваш комментарий.</p> <p>Допустим вас упомянули в обсуждении, сразу знаете что ответить? Не тратьте время, отвечайте прямо из телеграм. Для этого просто ответьте на сообщение и напишите ваш комментарий.</p>
<p>Просто ответьте на сообщение уведомления:</p>
<figure>
<p><img align="left" alt="telegram-thread-answer.png" loading="lazy" src="../img/telegram-thread-answer.png" width="700" /></p>
</figure>
<p>Так это будет выглядеть в GitLab:</p>
<figure>
<p><img align="left" alt="gitlab-thread-answer.png" loading="lazy" src="../img/gitlab-thread-answer.png" width="700" /></p>
</figure>
@ -1014,13 +1038,13 @@
<a href="../../getting-started/create-gitlab-token/" class="md-footer__link md-footer__link--next" aria-label="Вперед: Создание токена GitLab" rel="next"> <a href="../interaction-bot/" class="md-footer__link md-footer__link--next" aria-label="Вперед: Взаимодействие с ботом" rel="next">
<div class="md-footer__title"> <div class="md-footer__title">
<div class="md-ellipsis"> <div class="md-ellipsis">
<span class="md-footer__direction"> <span class="md-footer__direction">
Вперед Вперед
</span> </span>
Создание токена GitLab Взаимодействие с ботом
</div> </div>
</div> </div>
<div class="md-footer__button md-icon"> <div class="md-footer__button md-icon">

58
gitlab-notification/ru/develop/features/notify/index.html
View File

@ -364,6 +364,8 @@
@ -602,17 +604,6 @@
</span> </span>
</a> </a>
</li>
<li class="md-nav__item">
<a href="#-" class="md-nav__link">
<span class="md-ellipsis">
- Предыдущий статус пайплайна и новый
</span>
</a>
</li> </li>
</ul> </ul>
@ -636,7 +627,35 @@
<span class="md-ellipsis"> <span class="md-ellipsis">
Быстрые действия Взаимодействие с GitLab
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../interaction-bot/" class="md-nav__link">
<span class="md-ellipsis">
<span class="md-typeset">
Взаимодействие с ботом
</span>
@ -1247,11 +1266,20 @@
<h2 id="_4">Уведомление о решенном треде<a class="headerlink" href="#_4" title="Permanent link">⚓︎</a></h2> <h2 id="_4">Уведомление о решенном треде<a class="headerlink" href="#_4" title="Permanent link">⚓︎</a></h2>
<h2 id="_5">Уведомление о пайплайне<a class="headerlink" href="#_5" title="Permanent link">⚓︎</a></h2> <h2 id="_5">Уведомление о пайплайне<a class="headerlink" href="#_5" title="Permanent link">⚓︎</a></h2>
<p>Полезно сразу узнавать, что сборка закончилась успешно или упала.</p> <p>Полезно сразу узнавать, что сборка закончилась успешно или упала.</p>
<div class="admonition question">
<p class="admonition-title">Я буду получать уведомление обо всех пайплайнах?</p>
<p>Нет. Вы будете получать уведомление только о тех пайплайнах, в которых выступили инициатором. Напримр, запустили CI руками из GitLab, или нажали кнопку Merge в <abbr title="Merge Request">MR</abbr>.</p>
</div>
<figure> <figure>
<p><img alt="notify about new pipeline" loading="lazy" src="../img/notify-new-pipeline.png" width="500" /></p> <p><img alt="notify about new pipeline" loading="lazy" src="../img/notify-new-pipeline.png" width="500" /></p>
</figure> </figure>
<p>Уведомление содержит:</p> <p>Уведомление содержит:</p>
<h2 id="-">- Предыдущий статус пайплайна и новый<a class="headerlink" href="#-" title="Permanent link">⚓︎</a></h2> <ul>
<li>Предыдущий статус пайплайна и новый статус</li>
<li>Номер пайплайна</li>
<li>Название репозитория</li>
<li>Ветка, для которой запускалась сборка</li>
</ul>
<p>Доступные быстрые действия:</p> <p>Доступные быстрые действия:</p>
<ul> <ul>
<li><img alt="👀" class="twemoji" src="https://cdnjs.cloudflare.com/ajax/libs/twemoji/14.0.2/svg/1f440.svg" title=":eyes:" /> — прочитано. Удаляет сообщение.</li> <li><img alt="👀" class="twemoji" src="https://cdnjs.cloudflare.com/ajax/libs/twemoji/14.0.2/svg/1f440.svg" title=":eyes:" /> — прочитано. Удаляет сообщение.</li>
@ -1316,13 +1344,13 @@
<a href="../interaction-gitlab/" class="md-footer__link md-footer__link--next" aria-label="Вперед: Быстрые действия" rel="next"> <a href="../interaction-gitlab/" class="md-footer__link md-footer__link--next" aria-label="Вперед: Взаимодействие с GitLab" rel="next">
<div class="md-footer__title"> <div class="md-footer__title">
<div class="md-ellipsis"> <div class="md-ellipsis">
<span class="md-footer__direction"> <span class="md-footer__direction">
Вперед Вперед
</span> </span>
Быстрые действия Взаимодействие с GitLab
</div> </div>
</div> </div>
<div class="md-footer__button md-icon"> <div class="md-footer__button md-icon">

79
gitlab-notification/ru/develop/getting-started/configuration/index.html
View File

@ -364,6 +364,8 @@
<li class="md-nav__item md-nav__item--section md-nav__item--nested"> <li class="md-nav__item md-nav__item--section md-nav__item--nested">
@ -439,7 +441,35 @@
<span class="md-ellipsis"> <span class="md-ellipsis">
Быстрые действия Взаимодействие с GitLab
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../features/interaction-bot/" class="md-nav__link">
<span class="md-ellipsis">
<span class="md-typeset">
Взаимодействие с ботом
</span>
@ -680,32 +710,6 @@
</span> </span>
</a> </a>
</li>
<li class="md-nav__item">
<a href="#idea" class="md-nav__link">
<span class="md-ellipsis">
<span class="md-typeset">
Запуск в IDEA
</span>
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#jar" class="md-nav__link">
<span class="md-ellipsis">
<span class="md-typeset">
Запуск JAR релиза
</span>
</span>
</a>
</li> </li>
</ul> </ul>
@ -994,9 +998,13 @@
<h1 id="_1">Первый запуск ассистента<a class="headerlink" href="#_1" title="Permanent link">⚓︎</a></h1> <h1 id="_1">Первый запуск ассистента<a class="headerlink" href="#_1" title="Permanent link">⚓︎</a></h1>
<p>Есть несколько способов запустить бота-помощника. Бот был спроектирован таким образом, чтобы работать локально на вашем ПК, но вы можете запустить его на сервере в режиме 24/4.</p> <p>Есть несколько способов запустить бота-помощника. Бот был спроектирован таким образом, чтобы работать локально на вашем ПК, но вы можете запустить его на сервере в режиме 24/4.</p>
<p>Первым делом вам предложат ввести имя для бота.</p> <p>Для начала выполните эти действия:</p>
<ol>
<li><a href="../creating-telegram-bot/">Создание бота в Telegram</a></li>
<li><a href="../create-gitlab-token/">Получение персонального токена в GitLab</a></li>
</ol>
<h2 id="_2">Конфигурация<a class="headerlink" href="#_2" title="Permanent link">⚓︎</a></h2> <h2 id="_2">Конфигурация<a class="headerlink" href="#_2" title="Permanent link">⚓︎</a></h2>
<p>Несмотря на то, какой вариант запуска вы вберете, необходимо указать следующие переменные среды:</p> <p>Вне зависимости от того, какой способ вы выберете, необходимо будет указать данные переменные среды:</p>
<ul> <ul>
<li><code>TELEGRAM_BOT_TOKEN</code> — токен, который вы получили при <a href="../creating-telegram-bot/">создании бота</a>.</li> <li><code>TELEGRAM_BOT_TOKEN</code> — токен, который вы получили при <a href="../creating-telegram-bot/">создании бота</a>.</li>
<li><code>TELEGRAM_BOT_USERNAME</code> — название, которое вы дали боту. Оканчивается на bot.</li> <li><code>TELEGRAM_BOT_USERNAME</code> — название, которое вы дали боту. Оканчивается на bot.</li>
@ -1083,19 +1091,6 @@
</span><span id="__span-3-9"><a id="__codelineno-3-9" name="__codelineno-3-9" href="#__codelineno-3-9"></a><span class="w"> </span>--env<span class="w"> </span><span class="nv">DATASOURCE_PASSWORD</span><span class="o">=</span>value<span class="w"> </span><span class="se">\</span> </span><span id="__span-3-9"><a id="__codelineno-3-9" name="__codelineno-3-9" href="#__codelineno-3-9"></a><span class="w"> </span>--env<span class="w"> </span><span class="nv">DATASOURCE_PASSWORD</span><span class="o">=</span>value<span class="w"> </span><span class="se">\</span>
</span><span id="__span-3-10"><a id="__codelineno-3-10" name="__codelineno-3-10" href="#__codelineno-3-10"></a><span class="w"> </span>--network<span class="o">=</span><span class="s2">&quot;host&quot;</span><span class="w"> </span>upagge/gitlab-telegram-notify:latest </span><span id="__span-3-10"><a id="__codelineno-3-10" name="__codelineno-3-10" href="#__codelineno-3-10"></a><span class="w"> </span>--network<span class="o">=</span><span class="s2">&quot;host&quot;</span><span class="w"> </span>upagge/gitlab-telegram-notify:latest
</span></code></pre></div> </span></code></pre></div>
<h2 id="idea">Запуск в IDEA<a class="headerlink" href="#idea" title="Permanent link">⚓︎</a></h2>
<h2 id="jar">Запуск JAR релиза<a class="headerlink" href="#jar" title="Permanent link">⚓︎</a></h2>
<p>Скачать актуальный jar-файл всегда можно на странице релизов GitHub.</p>
<div class="language-shell highlight"><pre><span></span><code><span id="__span-4-1"><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>java<span class="w"> </span>-DTELEGRAM_BOT_USERNAME<span class="o">=</span>value<span class="w"> </span><span class="se">\</span>
</span><span id="__span-4-2"><a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a><span class="w"> </span>-DTELEGRAM_BOT_TOKEN<span class="o">=</span>value<span class="w"> </span><span class="se">\</span>
</span><span id="__span-4-3"><a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a><span class="w"> </span>-DTELEGRAM_PERSON_ID<span class="o">=</span>value<span class="w"> </span><span class="se">\</span>
</span><span id="__span-4-4"><a id="__codelineno-4-4" name="__codelineno-4-4" href="#__codelineno-4-4"></a><span class="w"> </span>-DDATASOURCE_URL<span class="o">=</span>value<span class="w"> </span><span class="se">\</span>
</span><span id="__span-4-5"><a id="__codelineno-4-5" name="__codelineno-4-5" href="#__codelineno-4-5"></a><span class="w"> </span>-DDATASOURCE_PASSWORD<span class="o">=</span>value<span class="w"> </span><span class="se">\</span>
</span><span id="__span-4-6"><a id="__codelineno-4-6" name="__codelineno-4-6" href="#__codelineno-4-6"></a><span class="w"> </span>-DDATASOURCE_USERNAME<span class="o">=</span>value<span class="w"> </span><span class="se">\</span>
</span><span id="__span-4-7"><a id="__codelineno-4-7" name="__codelineno-4-7" href="#__codelineno-4-7"></a><span class="w"> </span>-DGITLAB_PERSONAL_TOKEN<span class="o">=</span>value<span class="w"> </span><span class="se">\</span>
</span><span id="__span-4-8"><a id="__codelineno-4-8" name="__codelineno-4-8" href="#__codelineno-4-8"></a><span class="w"> </span>-DGITLAB_URL<span class="o">=</span>value<span class="w"> </span><span class="se">\</span>
</span><span id="__span-4-9"><a id="__codelineno-4-9" name="__codelineno-4-9" href="#__codelineno-4-9"></a><span class="w"> </span>-jar<span class="w"> </span>gitlab-notification.jar<span class="w"> </span>
</span></code></pre></div>

56
gitlab-notification/ru/develop/getting-started/create-gitlab-token/index.html
View File

@ -11,7 +11,7 @@
<link rel="canonical" href="https://docs.struchkov.dev/gitlab-notification/ru/develop/getting-started/create-gitlab-token/"> <link rel="canonical" href="https://docs.struchkov.dev/gitlab-notification/ru/develop/getting-started/create-gitlab-token/">
<link rel="prev" href="../../features/interaction-gitlab/"> <link rel="prev" href="../../features/interaction-bot/">
<link rel="next" href="../creating-telegram-bot/"> <link rel="next" href="../creating-telegram-bot/">
@ -364,6 +364,8 @@
<li class="md-nav__item md-nav__item--section md-nav__item--nested"> <li class="md-nav__item md-nav__item--section md-nav__item--nested">
@ -439,7 +441,35 @@
<span class="md-ellipsis"> <span class="md-ellipsis">
Быстрые действия Взаимодействие с GitLab
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../features/interaction-bot/" class="md-nav__link">
<span class="md-ellipsis">
<span class="md-typeset">
Взаимодействие с ботом
</span>
@ -888,6 +918,24 @@
<h1 id="gitlab">Создание токена GitLab<a class="headerlink" href="#gitlab" title="Permanent link">⚓︎</a></h1> <h1 id="gitlab">Создание токена GitLab<a class="headerlink" href="#gitlab" title="Permanent link">⚓︎</a></h1>
<p>Для взаимодействия с GitLab необходим персональный токен доступа.</p>
<p>Чтобы его получить перейдите по адресу: <a href="https://gitlab.com/-/profile/personal_access_tokens">https://gitlab.com/-/profile/personal_access_tokens</a></p>
<div class="admonition tip">
<p class="admonition-title">Корпоративный GitLab</p>
<p>Замените <code>https://gitlab.com/</code> на адрес своего GitLab, если вы используете self-host решение.</p>
</div>
<ul>
<li>Придумайте название токену, например, <code>GitLab Notify</code>. </li>
<li>Выдайте права на чтение - <code>read_api</code></li>
</ul>
<div class="admonition info">
<p class="admonition-title">Уровень разрешений</p>
<p>Выберете уровень разрешения <code>api</code>, если планируете пользоваться такими функциями, как: <a href="../../features/interaction-gitlab/#ответ-в-треде">ответ в треде</a></p>
</div>
<ul>
<li>Нажмите кнопку <code>Create personal access token</code>.</li>
<li>Сохраните полученный токен.</li>
</ul>
@ -931,7 +979,7 @@
<nav class="md-footer__inner md-grid" aria-label="Нижний колонтитул" > <nav class="md-footer__inner md-grid" aria-label="Нижний колонтитул" >
<a href="../../features/interaction-gitlab/" class="md-footer__link md-footer__link--prev" aria-label="Назад: Быстрые действия" rel="prev"> <a href="../../features/interaction-bot/" class="md-footer__link md-footer__link--prev" aria-label="Назад: Взаимодействие с ботом" rel="prev">
<div class="md-footer__button md-icon"> <div class="md-footer__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
</div> </div>
@ -940,7 +988,7 @@
<span class="md-footer__direction"> <span class="md-footer__direction">
Назад Назад
</span> </span>
Быстрые действия Взаимодействие с ботом
</div> </div>
</div> </div>
</a> </a>

34
gitlab-notification/ru/develop/getting-started/creating-telegram-bot/index.html
View File

@ -364,6 +364,8 @@
<li class="md-nav__item md-nav__item--section md-nav__item--nested"> <li class="md-nav__item md-nav__item--section md-nav__item--nested">
@ -439,7 +441,35 @@
<span class="md-ellipsis"> <span class="md-ellipsis">
Быстрые действия Взаимодействие с GitLab
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../features/interaction-bot/" class="md-nav__link">
<span class="md-ellipsis">
<span class="md-typeset">
Взаимодействие с ботом
</span>
@ -892,7 +922,7 @@
<div class="admonition warning"> <div class="admonition warning">
<p class="admonition-title">Имя бота</p> <p class="admonition-title">Имя бота</p>
<p>Первые два пункта диалогового меню будет про название бота. Учтите, что это называние общедоступно и случайноы пользователь Telegram сможет найти вашего бота.</p> <p>Первые два пункта диалогового меню будет про название бота. Учтите, что это называние общедоступно и случайноы пользователь Telegram сможет найти вашего бота.</p>
<p>Не переживайте, приложение имеет встроенную защиту от несанкционарованного доступа к боту. Но не смотря на это, <mark>не рекомендуется использовать в названии бота название организации, или вашу фамилию. Лучше использовать случайное имя.</mark></p> <p>Не переживайте, приложение имеет встроенную <a href="../../privacy/#access-control">защиту от несанкционарованного доступа к боту</a>. Но не смотря на это, <mark>не рекомендуется использовать в названии бота название организации, или вашу фамилию. Лучше использовать случайное имя.</mark></p>
</div> </div>
<p>После регистрации вам будет выдан токен доступа. Он будет использоваться при запуске ассистента.</p> <p>После регистрации вам будет выдан токен доступа. Он будет использоваться при запуске ассистента.</p>
<p>Видео процесса:</p> <p>Видео процесса:</p>

33
gitlab-notification/ru/develop/getting-started/first-start/index.html
View File

@ -364,6 +364,8 @@
<li class="md-nav__item md-nav__item--section md-nav__item--nested"> <li class="md-nav__item md-nav__item--section md-nav__item--nested">
@ -439,7 +441,35 @@
<span class="md-ellipsis"> <span class="md-ellipsis">
Быстрые действия Взаимодействие с GitLab
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../features/interaction-bot/" class="md-nav__link">
<span class="md-ellipsis">
<span class="md-typeset">
Взаимодействие с ботом
</span>
@ -888,6 +918,7 @@
<h1 id="_1">Инициализация бота<a class="headerlink" href="#_1" title="Permanent link">⚓︎</a></h1> <h1 id="_1">Инициализация бота<a class="headerlink" href="#_1" title="Permanent link">⚓︎</a></h1>
<p>В данном видео демонстрируется процесс первичной настройки бота, чтобы вы знали, чего ожидать:</p>
<video controls> <video controls>
<source id="mp4" src="../mp4/init-start.mp4" type="video/mp4"> <source id="mp4" src="../mp4/init-start.mp4" type="video/mp4">
</videos> </videos>

36
gitlab-notification/ru/develop/index.html
View File

@ -425,6 +425,8 @@
<li class="md-nav__item md-nav__item--section md-nav__item--nested"> <li class="md-nav__item md-nav__item--section md-nav__item--nested">
@ -500,7 +502,35 @@
<span class="md-ellipsis"> <span class="md-ellipsis">
Быстрые действия Взаимодействие с GitLab
</span>
</a>
</li>
<li class="md-nav__item">
<a href="features/interaction-bot/" class="md-nav__link">
<span class="md-ellipsis">
<span class="md-typeset">
Взаимодействие с ботом
</span>
@ -939,8 +969,8 @@
<h1 id="gitlab-notification-telegram-gitlab">GitLab Notification – Персональный Telegram бот для GitLab<a class="headerlink" href="#gitlab-notification-telegram-gitlab" title="Permanent link">⚓︎</a></h1> <h1 id="gitlab-notification-telegram-gitlab">GitLab Notification – Персональный Telegram бот для GitLab<a class="headerlink" href="#gitlab-notification-telegram-gitlab" title="Permanent link">⚓︎</a></h1>
<p>Персональный ассистент для упрощения работы с GitLab. Получайте персональные уведомления о событиях в GitLab: новый <abbr title="Merge Request">MR</abbr> на ревью, новый ответ в треде и многое другое.</p> <p>Персональный ассистент призван упростить работу с GitLab. Получайте персональные уведомления о событиях в GitLab, ничего не пропустите и не забудьте.</p>
<p>Бота можно запустить как для облачного GitLab, так и для Self-host решений.</p> <p>Бота-ассистента можно запустить как для облачного GitLab, так и для Self-host решений.</p>
<div class="admonition info"> <div class="admonition info">
<p class="admonition-title">GodFather Telegram</p> <p class="admonition-title">GodFather Telegram</p>
<p>Данный проект использует другой мой проект GodFather Telegram для создания Tlegram ботов различной сложности.</p> <p>Данный проект использует другой мой проект GodFather Telegram для создания Tlegram ботов различной сложности.</p>

44
gitlab-notification/ru/develop/privacy/index.html
View File

@ -429,7 +429,7 @@
</li> </li>
<li class="md-nav__item"> <li class="md-nav__item">
<a href="#_4" class="md-nav__link"> <a href="#access-control" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
<span class="md-typeset"> <span class="md-typeset">
@ -464,6 +464,8 @@
<li class="md-nav__item md-nav__item--section md-nav__item--nested"> <li class="md-nav__item md-nav__item--section md-nav__item--nested">
@ -539,7 +541,35 @@
<span class="md-ellipsis"> <span class="md-ellipsis">
Быстрые действия Взаимодействие с GitLab
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../features/interaction-bot/" class="md-nav__link">
<span class="md-ellipsis">
<span class="md-typeset">
Взаимодействие с ботом
</span>
@ -979,18 +1009,22 @@
<p>Я разработчик, и это приложение должно помогать мне работать, оптимизируя мое время взаимодействия с GitLab. В какой-то момент я решил подлиться своими наработками со всеми желающими. Часто в GitLab содержится множество конфиденциальной информации, которую не хотелось бы раскрывать. Эта страница пытается ответить на все вопросы, которые могут вас смущать.</p> <p>Я разработчик, и это приложение должно помогать мне работать, оптимизируя мое время взаимодействия с GitLab. В какой-то момент я решил подлиться своими наработками со всеми желающими. Часто в GitLab содержится множество конфиденциальной информации, которую не хотелось бы раскрывать. Эта страница пытается ответить на все вопросы, которые могут вас смущать.</p>
<div class="admonition tip"> <div class="admonition tip">
<p class="admonition-title">Доверие</p> <p class="admonition-title">Доверие</p>
<p>Вы не должны верить мне на слово. Вы можете <a href="https://github.com/uPagge/gitlab-notification">самостоятельно изучить код, он открыт и не сложен.</a> После проверки можно самостоятельно собрать jar и упаковать его в Docker. Либо запускать код прямо из <abbr title="IDE IntelliJ IDEA">Idea</abbr>.</p> <p>Вы не должны верить мне на слово. Вы можете <a href="https://github.com/uPagge/gitlab-notification">самостоятельно изучить код, он открыт и не сложен.</a> После проверки можно самостоятельно собрать jar и <a href="https://github.com/uPagge/gitlab-notification/blob/master/Dockerfile">упаковать его в Docker</a>. Либо запускать код прямо из <abbr title="IDE IntelliJ IDEA">Idea</abbr>.</p>
</div> </div>
<h2 id="gitlab">Защита токена GitLab<a class="headerlink" href="#gitlab" title="Permanent link">⚓︎</a></h2> <h2 id="gitlab">Защита токена GitLab<a class="headerlink" href="#gitlab" title="Permanent link">⚓︎</a></h2>
<p>Для работы ассистента необходим персональный токен GitLab. Он указывается в переменные среды и нигде дополнительно не дублируется. Таким образом токен не попадает в Telegram и хранится только у вас на компьютере и в контейнере приложения.</p> <p>Для работы ассистента необходим персональный токен GitLab. Он указывается в переменные среды и нигде дополнительно не хранится и не передается. Таким образом токен не попадает в Telegram и хранится только у вас на компьютере и в контейнере приложения.</p>
<p>Токен используется только при обращении к указанному GitLab, и только для выполнения описанных в документации возможностей. Никакой скрытой работы не выполняется, по возможности обо всех взаимодействиях с GitLab дополнительно сообщается во время настройки.</p> <p>Токен используется только при обращении к указанному GitLab, и только для выполнения описанных в документации возможностей. Никакой скрытой работы не выполняется, по возможности обо всех взаимодействиях с GitLab дополнительно сообщается во время настройки.</p>
<div class="admonition question">
<p class="admonition-title">А что, если ты заполучишь токен?</p>
<p>Ну начнем с того, что мне ваш токен даром не нужен. Изучайте код, если мне не верите, или не пользуйтесь моим ботом. Эта страница призвана ответить на возникающие вопросы безопаности решения, не более этого. Дополнительно убеждать никого не собираюсь.</p>
</div>
<h2 id="_2">Уровни конфиденциальности<a class="headerlink" href="#_2" title="Permanent link">⚓︎</a></h2> <h2 id="_2">Уровни конфиденциальности<a class="headerlink" href="#_2" title="Permanent link">⚓︎</a></h2>
<p>Некоторые уведомления могут содержать множество чувствительной информации. Например, уведомления о новых сообщениях в тредах. Возможно вы не захотите раскрывать столько информации о вашей разработке телеграму, ведь через него идет получение уведомлений. Специально для таких случаев предусмотрены уровни конфиденциальности разных типов уведомлений.</p> <p>Некоторые уведомления могут содержать множество чувствительной информации. Например, уведомления о новых сообщениях в тредах. Возможно вы не захотите раскрывать столько информации о вашей разработке телеграму, ведь через него идет получение уведомлений. Специально для таких случаев предусмотрены уровни конфиденциальности разных типов уведомлений.</p>
<p>Возьмем для примера уведомление о новом сообщении в треде. При минимальном уровне конфиденциальности вы получите уведомление с текстом комментария и сможете сразу ответить на него в телеграм, а при максимальном уровне конфиденциальности будет сообщаться только о факте нового комментария, без содержания. Все это настраивается при первом запуске.</p> <p>Возьмем для примера уведомление о новом сообщении в треде. При минимальном уровне конфиденциальности вы получите уведомление с текстом комментария и сможете сразу ответить на него в телеграм, а при максимальном уровне конфиденциальности будет сообщаться только о факте нового комментария, без содержания. Все это настраивается при первом запуске.</p>
<h2 id="_3">Сохранение в <abbr title="База данных">БД</abbr><a class="headerlink" href="#_3" title="Permanent link">⚓︎</a></h2> <h2 id="_3">Сохранение в <abbr title="База данных">БД</abbr><a class="headerlink" href="#_3" title="Permanent link">⚓︎</a></h2>
<p>Для работы ассистента ему нужно сохранять предыдущее состояние GitLab сущностей. Для этого используется <abbr title="База данных">БД</abbr>. Приложение старается не хранить в <abbr title="База данных">БД</abbr> больше данных, чем необходимо. Как только необходимость в данных теряется, например <abbr title="Merge Request">MR</abbr> мержится, данные из <abbr title="База данных">БД</abbr> удаляются.</p> <p>Для работы ассистента ему нужно сохранять предыдущее состояние GitLab сущностей. Для этого используется <abbr title="База данных">БД</abbr>. Приложение старается не хранить в <abbr title="База данных">БД</abbr> больше данных, чем необходимо. Как только необходимость в данных теряется, например <abbr title="Merge Request">MR</abbr> мержится, данные из <abbr title="База данных">БД</abbr> удаляются.</p>
<p>Прочитать подробнее можно в разделе: <a href="../architecture/concept/#schema-database">Работа с базой данных</a></p> <p>Прочитать подробнее можно в разделе: <a href="../architecture/concept/#schema-database">Работа с базой данных</a></p>
<h2 id="_4">Несанкционированный доступ<a class="headerlink" href="#_4" title="Permanent link">⚓︎</a></h2> <h2 id="access-control">Несанкционированный доступ<a class="headerlink" href="#access-control" title="Permanent link">⚓︎</a></h2>
<p><mark>Все боты в Telegram являются публичными.</mark> Это значит, что ваш бот может быть найден через поиск в Telegram. Поэтому <mark>не рекомендуется давать название боту, которое может раскрыть его предназначение.</mark></p> <p><mark>Все боты в Telegram являются публичными.</mark> Это значит, что ваш бот может быть найден через поиск в Telegram. Поэтому <mark>не рекомендуется давать название боту, которое может раскрыть его предназначение.</mark></p>
<p>Даже если кто-то случайно напишет вашему боту ничего не случится. <mark>В боте встроена проверка прав доступа.</mark> Вот как она работает:</p> <p>Даже если кто-то случайно напишет вашему боту ничего не случится. <mark>В боте встроена проверка прав доступа.</mark> Вот как она работает:</p>
<ol> <ol>

2
gitlab-notification/ru/develop/search/search_index.json
View File

File diff suppressed because one or more lines are too long

32
gitlab-notification/ru/develop/sitemap.xml
View File

@ -2,62 +2,62 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"> <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url> <url>
<loc>https://docs.struchkov.dev/gitlab-notification/ru/develop/</loc> <loc>https://docs.struchkov.dev/gitlab-notification/ru/develop/</loc>
<lastmod>2023-03-03</lastmod> <lastmod>2023-03-05</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://docs.struchkov.dev/gitlab-notification/ru/develop/architecture/concept/</loc> <loc>https://docs.struchkov.dev/gitlab-notification/ru/develop/architecture/concept/</loc>
<lastmod>2023-03-03</lastmod> <lastmod>2023-03-05</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://docs.struchkov.dev/gitlab-notification/ru/develop/changelog/</loc> <loc>https://docs.struchkov.dev/gitlab-notification/ru/develop/changelog/</loc>
<lastmod>2023-03-03</lastmod> <lastmod>2023-03-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.struchkov.dev/gitlab-notification/ru/develop/features/interaction-bot/</loc>
<lastmod>2023-03-05</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://docs.struchkov.dev/gitlab-notification/ru/develop/features/interaction-gitlab/</loc> <loc>https://docs.struchkov.dev/gitlab-notification/ru/develop/features/interaction-gitlab/</loc>
<lastmod>2023-03-03</lastmod> <lastmod>2023-03-05</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://docs.struchkov.dev/gitlab-notification/ru/develop/features/notify/</loc> <loc>https://docs.struchkov.dev/gitlab-notification/ru/develop/features/notify/</loc>
<lastmod>2023-03-03</lastmod> <lastmod>2023-03-05</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://docs.struchkov.dev/gitlab-notification/ru/develop/getting-started/configuration/</loc> <loc>https://docs.struchkov.dev/gitlab-notification/ru/develop/getting-started/configuration/</loc>
<lastmod>2023-03-03</lastmod> <lastmod>2023-03-05</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://docs.struchkov.dev/gitlab-notification/ru/develop/getting-started/create-gitlab-token/</loc> <loc>https://docs.struchkov.dev/gitlab-notification/ru/develop/getting-started/create-gitlab-token/</loc>
<lastmod>2023-03-03</lastmod> <lastmod>2023-03-05</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://docs.struchkov.dev/gitlab-notification/ru/develop/getting-started/creating-telegram-bot/</loc> <loc>https://docs.struchkov.dev/gitlab-notification/ru/develop/getting-started/creating-telegram-bot/</loc>
<lastmod>2023-03-03</lastmod> <lastmod>2023-03-05</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://docs.struchkov.dev/gitlab-notification/ru/develop/getting-started/first-start/</loc> <loc>https://docs.struchkov.dev/gitlab-notification/ru/develop/getting-started/first-start/</loc>
<lastmod>2023-03-03</lastmod> <lastmod>2023-03-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.struchkov.dev/gitlab-notification/ru/develop/guides/</loc>
<lastmod>2023-03-03</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://docs.struchkov.dev/gitlab-notification/ru/develop/privacy/</loc> <loc>https://docs.struchkov.dev/gitlab-notification/ru/develop/privacy/</loc>
<lastmod>2023-03-03</lastmod> <lastmod>2023-03-05</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://docs.struchkov.dev/gitlab-notification/ru/develop/support-development/</loc> <loc>https://docs.struchkov.dev/gitlab-notification/ru/develop/support-development/</loc>
<lastmod>2023-03-03</lastmod> <lastmod>2023-03-05</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
</urlset> </urlset>

BIN
gitlab-notification/ru/develop/sitemap.xml.gz
View File

Binary file not shown.

32
gitlab-notification/ru/develop/support-development/index.html
View File

@ -368,6 +368,8 @@
<li class="md-nav__item md-nav__item--section md-nav__item--nested"> <li class="md-nav__item md-nav__item--section md-nav__item--nested">
@ -443,7 +445,35 @@
<span class="md-ellipsis"> <span class="md-ellipsis">
Быстрые действия Взаимодействие с GitLab
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../features/interaction-bot/" class="md-nav__link">
<span class="md-ellipsis">
<span class="md-typeset">
Взаимодействие с ботом
</span>