Интеграция с таск-трекером 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:

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

2. На уровне инстанса ТестОпс добавьте интеграцию с GitHub, указав:

   • название интеграции;
   • URL-адрес GitHub;
   • URL-адрес GitHub API.

3. На уровне инстанса или проекта ТестОпс включите добавленную интеграцию для проекта, указав созданный токен доступа из GitHub.

1. Создайте токен доступа в 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. Нажмите значок Копировать рядом с токеном, чтобы скопировать его в буфер обмена.

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

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⟩/api/v3, где ⟨URL⟩ — URL-адрес вашего инстанса GitHub.

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

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

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

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

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

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

3. Перейдите на вкладку Проекты.

4. Нажмите + справа от поля поиска.

5. В выпадающем списке Проект выберите нужный проект.

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

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

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

7. В разделе Секрет введите токен доступа GitHub, который вы сохранили на шаге 1.

8. Нажмите Добавить интеграцию, чтобы сохранить настройки.

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

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

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

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

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

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

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

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

Важно

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

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

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

Чтобы удалить интеграцию на уровне инстанса ТестОпс, предварительно удалите ее из проектов, в которых она используется.

1. Перейдите в раздел Администрирование → Интеграции.
2. В списке настроенных интеграций найдите и откройте вашу интеграцию с GitHub.
3. На вкладке Конфигурация нажмите Удалить интеграцию.
4. Нажмите Удалить.