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