Интеграция с таск-трекером GitHub
Интеграция с таск-трекером GitHub (GitHub Issues) позволяет добавлять ссылки на задачи GitHub в тест-кейсы и запуски ТестОпс (см. Ссылки на задачи из таск-трекеров).
Примечание
Чтобы настроить или удалить интеграцию в ТестОпс, вы должны иметь доступ к разделам:
- Администрирование — необходимы права администратора инстанса;
- Настройки в конкретном проекте — необходима роль владельца этого проекта.
Если ранее вы настроили интеграцию с CI-системой GitHub (GitHub Actions) и планируете дополнительно подключить таск-трекер GitHub:
Проверьте тип токена, который используется для текущей интеграции:
Если используется токена типа fine-grained, создайте и укажите новый токен с правами доступа:
- Repository access → All repositories или Only select repositories — настройте интеграцию для всех или определенных репозиториев. Репозитории должны содержать workflow и задачи, которые вы планируете использовать.
- Permissions — добавьте разрешения Issues и Actions и укажите для них уровень доступа Access: Read and write.
Если используется токена типа classic, убедитесь, что он имеет права доступа repo и workflow. При необходимости создайте и укажите новый токен с этими правами доступа.
В настройках вашей текущей интеграции укажите репозитории GitHub с задачами, на которые вы планируете добавлять ссылки (см. Включите интеграцию для проекта ТестОпс).
Настройка интеграции
Чтобы настроить интеграцию с таск-трекером GitHub:
Создайте токен доступа в GitHub.
На уровне инстанса ТестОпс добавьте интеграцию с GitHub, указав:
- название интеграции;
- URL-адрес GitHub;
- URL-адрес GitHub API.
На уровне инстанса или проекта ТестОпс включите добавленную интеграцию для проекта, указав созданный токен доступа из GitHub.
1. Создайте токен доступа в GitHub
GitHub поддерживает два типа токенов доступа: fine-grained и classic (см. Managing your personal access tokens в документации GitHub). Для интеграции с ТестОпс вы можете использовать любой тип токена.
В GitHub нажмите на ваш аватар и перейдите в раздел Settings.
В сайдбаре слева перейдите в раздел Developer settings.
В сайдбаре слева перейдите в раздел Personal access tokens → Fine-grained tokens.
Нажмите Generate new token.
Заполните поля:
- Token name — название, которое поможет вам распознать токен (например, Токен для ТестОпс).
- Expiration — срок действия токена. После указанной даты интеграция перестанет работать. Чтобы возобновить ее работу, вам нужно будет создать новый токен.
В секции Repository access выберите один из вариантов:
- All repositories — предоставить токену доступ ко всем репозиториям. Этот вариант подходит, если вы планируете настроить интеграцию для всего инстанса GitHub.
- Only select repositories — предоставить токену доступ только к определенным репозиториям. В появившемся выпадающем списке выберите репозитории, содержащие задачи, которые вы планируете использовать.
В секции Permissions нажмите + Add permissions.
В списке доступных разрешений поставьте галочку напротив Issues.
Чтобы закрыть список, нажмите вне его области.
В списке добавленных разрешений напротив Issues выберите уровень доступа Access: Read and write.
Нажмите Generate token.
В открывшемся окне подтверждения повторно нажмите Generate token.
После обновления страницы вы должны увидеть созданный токен.
Нажмите иконку Копировать рядом с токеном, чтобы скопировать его в буфер обмена.
Cохраните токен в безопасном месте, он понадобится для настройки интеграции в проекте ТестОпс.
2. Добавьте интеграцию с GitHub в ТестОпс
Перейдите в ваш инстанс ТестОпс.
Перейдите в раздел Администрирование → Интеграции.
Нажмите + Добавить интеграцию в правом верхнем углу страницы.
В появившемся окне выберите GitHub.
Заполните поля:
Название — название, которое поможет вам распознать интеграцию, например, GitHub production.
Endpoint — базовый URL-адрес GitHub:
- Для github.com используйте https://github.com.
- Для GitHub Enterprise Server используйте URL-адрес вашего инстанса GitHub.
Endpoint для вызовов API — URL-адрес GitHub API:
- Для github.com убедитесь, что указано https://api.github.com.
- Для GitHub Enterprise Server используйте ⟨URL-адрес вашего инстанса GitHub⟩/api/v3.
Если вы используете GitHub Enterprise Server с самоподписанным SSL-сертификатом, поставьте галочку напротив Отключить проверку сертификата.
Нажмите Добавить интеграцию.
3. Включите интеграцию для проекта ТестОпс
Чтобы включить интеграцию в нужном проекте ТестОпс, воспользуйтесь одним из способов:
Перейдите в раздел Администрирование → Интеграции.
В списке настроенных интеграций найдите и откройте вашу интеграцию с GitHub.
Перейдите на вкладку Проекты.
Справа от поля поиска нажмите
+.В выпадающем списке Проект выберите нужный проект ТестОпс.
В секции Настройки добавьте репозитории GitHub, задачи из которых вы планируете использовать:
- Нажмите + Добавить.
- В поле Владелец введите имя владельца репозитория.
- В поле Название репозитория введите название репозитория.
Например, для репозитория github.com/torvalds/linux значение поля Владелец будет torvalds, а значение поля Название репозитория — linux.
В секции Секрет введите токен доступа GitHub, который вы сохранили на шаге 1.
Нажмите Добавить интеграцию.
Удаление интеграции
Вы можете удалить интеграцию с GitHub двумя способами — на уровне всего инстанса ТестОпс (через раздел Администрирование) или на уровне отдельного проекта (через настройки проекта).
Важно
Последствия удаления интеграции:
Удаление на уровне инстанса — все связи с задачами GitHub, которые относятся к интеграции, будут удалены из сущностей ТестОпс. Это действие необратимо — восстановить удаленные ссылки будет невозможно.
Удаление на уровне проекта — все связи с задачами GitHub, которые относятся к интеграции, будут сохранены в сущностях ТестОпс, но вы не сможете создавать новые связи для этого проекта.
Во время удаления интеграции с таск-трекером GitHub также будет удалена интеграция с CI-системой GitHub. Подробнее о последствиях см. Интеграция с CI-системой GitHub → Удаление интеграции.
Перейдите в раздел Администрирование → Интеграции.
В списке настроенных интеграций найдите и откройте вашу интеграцию с GitHub.
Перейдите на вкладку Проекты и убедитесь, что интеграция не используется в проектах ТестОпс.
Если интеграция подключена к проектам, удалите ее из них. Для этого напротив названия каждого проекта нажмите иконку корзины → Удалять.
Перейдите на вкладку Конфигурация.
Нажмите Удалить интеграцию.
Нажмите Удалить.