Интеграция с таск-трекером GitHub

Интеграция с таск-трекером GitHub (GitHub Issues) позволяет добавлять ссылки на задачи GitHub в тест-кейсы и запуски ТестОпс (см. Ссылки на задачи из таск-трекеров).

Примечание

Чтобы настроить или удалить любую интеграцию ТестОпс с внешней системой, необходима глобальная роль «Администратор» в инстансе ТестОпс и, как правило, права администратора инстанса внешней системы.

Если ранее вы настроили интеграцию с CI-системой GitHub (GitHub Actions) и планируете дополнительно подключить таск-трекер GitHub:

1. Проверьте тип токена, который используется для текущей интеграции:

   • Если используется токена типа fine-grained, создайте и укажите новый токен с правами доступа:

     • Repository access → All repositories или Only select repositories — настройте интеграцию для всех или определенных репозиториев. Репозитории должны содержать workflow и задачи, которые вы планируете использовать.
     • Permissions — добавьте разрешения Issues и Actions и укажите для них уровень доступа Access: Read and write.

   • Если используется токена типа classic, убедитесь, что он имеет права доступа repo и workflow. При необходимости создайте и укажите новый токен с этими правами доступа.

2. В настройках вашего текущего подключения к GitHub укажите репозитории GitHub с задачами, на которые вы планируете добавлять ссылки (см. Добавьте настроенное подключение к GitHub в проект ТестОпс).

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

Чтобы настроить интеграцию с таск-трекером GitHub:

1. Создайте токен доступа в GitHub.
2. Подключите интеграцию с GitHub на уровне инстанса ТестОпс.
3. Добавьте настроенное подключение к GitHub в проект ТестОпс.

1. Создайте токен доступа в GitHub

GitHub поддерживает два типа токенов доступа: fine-grained и classic (см. Managing your personal access tokens в документации GitHub). Для интеграции с ТестОпс вы можете использовать любой тип токена.

1. Перейдите в ваш инстанс GitHub.

2. Нажмите на ваш аватар и перейдите в раздел Settings.

3. В сайдбаре слева перейдите в раздел Developer settings.

4. В сайдбаре слева перейдите в раздел Personal access tokens → Fine-grained tokens.

5. Нажмите Generate new token.

6. Заполните поля:

   • Token name — введите название токена, которое поможет вам распознать интеграцию (например, Токен для ТестОпс).
   • Expiration — введите срок действия токена. После указанной даты интеграция перестанет работать. Чтобы возобновить ее работу, вам нужно будет создать новый токен.

7. В секции Repository access выберите один из вариантов:

   • All repositories — предоставить токену доступ ко всем репозиториям. Этот вариант подходит, если вы планируете настроить интеграцию для всего инстанса GitHub.
   • Only select repositories — предоставить токену доступ только к определенным репозиториям. В появившемся выпадающем списке выберите репозитории, содержащие задачи, которые вы планируете использовать.

8. В секции Permissions нажмите + Add permissions.

9. В списке доступных разрешений поставьте галочку напротив Issues.

   Чтобы закрыть список, нажмите вне его области.

10. В списке добавленных разрешений напротив Issues выберите уровень доступа Access: Read and write.

11. Нажмите Generate token.

12. В открывшемся окне подтверждения повторно нажмите Generate token.

    После обновления страницы вы должны увидеть созданный токен.

13. Нажмите иконку Копировать рядом с токеном, чтобы скопировать его в буфер обмена.

    Cохраните токен в безопасном месте, он понадобится для подключения интеграции с GitHub в ТестОпс.

2. Подключите интеграцию с GitHub на уровне инстанса ТестОпс

1. Перейдите в ваш инстанс ТестОпс.

2. Перейдите в раздел Администрирование → Интеграции.

3. Нажмите Добавить интеграцию.

4. В списке доступных интеграций выберите GitHub.

5. Заполните поля:

   • Название подключения — введите название, которое поможет вам распознать интеграцию (например, 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, который будет поддерживать интеграция:

     • Все (глобальные и проектные) — интеграция может работать как с глобальными, так и с проектными учетными данными;
     • Только глобальные — интеграция может работать только с глобальными учетными данными;
     • Только проектные — интеграция может работать только с проектными учетными данными.

     Примечание

     Подробнее о поддерживаемых типах учетных данных см. Интеграции с внешними системами → Глобальные и проектные учетные данные

6. Если вы используете GitHub Enterprise Server с самоподписанным SSL-сертификатом, уберите галочку напротив Проверка SSL-сертификата.

7. В секции Репозитории добавьте репозитории GitHub, задачи из которых вы планируете использовать:

   1. Нажмите + Добавить.
   2. В поле Владелец репозитория введите имя владельца репозитория.
   3. В поле Название репозитория введите название репозитория.
   Пример

   Например, для репозитория github.com/torvalds/linux значение поля Владелец репозитория будет torvalds, а значение поля Название репозитория — linux.

8. Если интеграция может работать с глобальными учетными данными GitHub, в секции Глобальные учетные данные введите токен доступа GitHub, который вы сохранили на шаге 1.

9. Нажмите Добавить подключение.

3. Добавьте настроенное подключение к GitHub в проект ТестОпс

Чтобы добавить настроенное подключение к GitHub в нужный проект ТестОпс, воспользуйтесь одним из способов:

1. В ТестОпс перейдите в раздел Администрирование → Интеграции.

2. В списке настроенных интеграций найдите и откройте интеграцию с GitHub.

3. В списке настроенных подключений найдите и откройте ваше подключение к GitHub.

4. Нажмите Добавить в проект.

5. В списке доступных проектов выберите нужный проект ТестОпс.

6. Если интеграция может работать и с глобальными, и с проектными учетными данными GitHub, в поле Тип учетных данных нажмите на выпадающий список и выберите вариант, который будет использоваться в проекте:

   • Проектные — использовать проектные учетные данные для подключения к GitHub;
   • Глобальные — использовать глобальные учетные данные для подключения к GitHub.

7. Если интеграция будет работать с проектными учетными данными GitHub, в секции Проектные учетные данные введите токен доступа GitHub, который вы сохранили на шаге 1.

8. Нажмите Добавить в проект.

Удаление интеграции

Вы можете удалить интеграцию с GitHub двумя способами — на уровне всего инстанса ТестОпс (через раздел Администрирование) или на уровне отдельного проекта (через настройки проекта).

Важно

Последствия удаления интеграции:

• Удаление на уровне инстанса — все связи с задачами GitHub, которые относятся к интеграции, будут удалены из сущностей ТестОпс. Это действие необратимо — восстановить удаленные ссылки будет невозможно.

• Удаление на уровне проекта — все связи с задачами GitHub, которые относятся к интеграции, будут сохранены в сущностях ТестОпс, но вы не сможете создавать новые связи для этого проекта.

Во время удаления интеграции с таск-трекером GitHub также будет удалена интеграция с CI-системой GitHub. Подробнее о последствиях см. Интеграция с CI-системой GitHub → Удаление интеграции.

1. В ТестОпс перейдите в раздел Администрирование → Интеграции.

2. В списке настроенных интеграций найдите и откройте интеграцию с GitHub.

3. В списке настроенных подключений найдите ваше подключение к GitHub и убедитесь, что оно не используется в проектах ТестОпс.

   Если интеграция подключена к проектам, удалите ее из них. Для этого откройте карточку подключения к GitHub и напротив названия каждого проекта нажмите ⋯ → Удалить из проекта → Да, удалить.

4. Напротив нужного подключения к GitHub нажмите ⋯ → Удалить → Да, удалить.