Интеграция с GitHub

Интеграция позволяет создавать ветки GitHub прямо из интерфейса METEOR.

Отображение в задаче

1. Вкладка "GitHub" - будет отображать следующие данные из gitHub:

• Все связанные Pull Requests с их статусами (Открыт, Объединен, Закрыт, Черновик);

• Статус GitHub Actions (success, queued, in_progress, action_required, failure, neutral, skipped, cancelled, timed_out);

• Связь между задачами и Pull Requests (отношение n:m, задача может быть связана с несколькими Pull Requests, а Pull Requests — с несколькими задачами).

2. Вкладка "История" - будет отображать изменения по PR (обновления статусов, изменение описания PR):

Настройка интеграции

METEOR

1. Создайте специальную роль, в которой будут как минимум два права:

   • "Просмотр задач";
   • "Добавление комментариев".

   (Администрирование -> Пользователи и права -> Роли -> Конкретная роль -> раздел "Задачи")

2. Создайте пользователя для интеграции

   • назначьте ему созданную роль;
   • добавьте этого пользователя во все проекты, где нужна интеграция с GitHub.

   (Администрирование -> Пользователи и права -> Пользователи)

3. Сгенерируйте API-токен для этого пользователя (он понадобится вам на стороне GitHub). Для генерации токена необходимо:
   • войдите в систему под учётной записью нового пользователя.
   • перейдите в Профиль (нажмите на аватарку в правом верхнем углу и выберите Профиль).
   • далее "Токены доступа".
   • нажмите на кнопку "+ Токен API".

4. Активируйте модуль GitHub в настройках проекта (Настройки проекта -> Модули).
5. Выдайте права на просмотр вкладки "GitHub" нужным ролям:
   • "Показывать содержимое GitHub".

Настройка GitHub

1. Создайте webhook для каждого репозитория:

• Content-Type: application/json
• URL: https://mycompany.u-meteor.ru/op/webhooks/github?key=ВАШ\_ТОКЕН
• События: "Send me everything"

Интеграция готова к использованию!

Использование интеграции с GitHub

Создание ветки

1. Откройте вкладку GitHub в карточке задачи;
2. Нажмите "Git-сниппеты";
3. Скопируйте имя ветки:

4. В Git-клиенте создайте ветку с этим именем:

Создание коммита

1. METEOR предлагает шаблон сообщения коммита на основе задачи:

2. В GitHub создайте коммит с этим описанием (Extended description):

Cоздание Pull Request

Для того, чтобы связать Pull Request с задачей METEOR, в описании Pull Request должна быть:

• ссылка на задачу, ранее скопированная из METEOR (при условии, что коммит только один);
• или укажите «МТ#ID», где ID - это идентификатор задачи METEOR, в описании. Например, MT#2197. Данные о PR подтянутся в METEOR и будут отображаться на вкладке "GitHub".

Если коммит не один, то при создании Pull Request необходимо в описание вручную указать данные из METEOR (MT#ID или ссылка на задачу, ранее скопированная из METEOR).

Статусы Pull Request на вкладке "GitHub" в METEOR обновляются автоматически.

Создать ветку с пустым коммитом

Из-за ограничения в один коммит или если есть необходимость создавать ветку как можно раньше, в меню «Git-сниппеты» можно создать пустой коммит. По кнопке «Создать ветку с пустым коммитом», который создаст ветку и добавит в неё пустой коммит с помощью одной команды.