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

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

Примечание

Если вы уже настроили интеграцию с GitHub CI для вашего сервера GitHub, выполните шаги:

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

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

   • Repository permissions — укажите Read and write для Actions и Issues.
   • Repository access → Only select repositories — укажите репозитории, содержащие workflow и задачи, которые вы планируете использовать.

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

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

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

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

Создание токена доступа GitHub

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

1. В GitHub нажмите на ваш аватар и перейдите в настройки (Settings).

2. В меню слева нажмите Developer settings.

3. Перейдите в Personal access tokens → Fine-grained tokens.

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

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

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

6. В разделе Repository access нажмите Only select repositories. В появившемся выпадающем списке выберите репозитории, которые вы хотите использовать.

7. В разделе Permissions нажмите Repository permissions. В появившемся списке разрешений найдите Issues и выберите Read and write рядом с ним.

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

9. После обновления страницы вы должны увидеть созданный токен. Нажмите значок Копировать рядом с ним и сохраните токен в безопасном месте.

Добавление интеграции GitHub в ТестОпс

1. Войдите в ТестОпс, используя учетную запись администратора.

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

3. Нажмите + Добавить интеграцию в правом верхнем углу страницы.

4. В появившемся окне выберите GitHub.

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

   • Название — название, которое поможет вам распознать сервер GitHub (например, GitHub production).
   • Endpoint — базовый URL-адрес GitHub. Для github.com используйте https://github.com. Для GitHub Enterprise Server используйте URL-адрес вашего инстанса GitHub.
   • Endpoint for API calls — URL-адрес GitHub API. Для github.com используйте https://api.github.com. Для GitHub Enterprise Server используйте ⟨URL⟩/api/v3, где ⟨URL⟩ — URL-адрес вашего инстанса GitHub.

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

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

Включение интеграции для проекта ТестОпс

1. Откройте ваш проект в ТестОпс.

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

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

4. В разделе Настройки добавьте репозитории, задачи из которых вы планируете использовать.

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

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

5. В разделе Секрет введите ранее созданный токен доступа GitHub.

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

Добавление ссылок на задачи

После настройки интеграции с GitHub вы можете добавлять ссылки на задачи в ваши тест-кейсы и запуски.

Чтобы связать тест-кейс с задачей GitHub:

1. Перейдите в раздел Тест-кейсы.
2. Откройте тест-кейс, который вы хотите связать с задачей, и нажмите на значок карандаша в правой части страницы, напротив Связанные задачи из баг-трекера.
3. В появившемся окне нажмите + Добавить.
4. В поле Баг-трекер выберите вашу интеграцию с GitHub.
5. В поле Ключ введите часть названия задачи и затем выберите ее из списка.
6. Нажмите Отправить.

Чтобы связать запуск с задачей GitHub:

1. Перейдите в раздел Запуски.
2. Нажмите ⋯ справа от запуска, который вы хотите связать с задачей, и выберите Изменить.
3. В открывшемся окне нажмите + Добавить в разделе Связанные задачи из баг-трекера.
4. В поле Баг-трекер выберите вашу интеграцию с GitHub.
5. В поле Ключ введите часть названия задачи и затем выберите ее из списка.
6. Нажмите Отправить.