Документация

GitHub

Подключите GitHub к приложению или персональному токену доступа и узнайте, какие права они предоставляют.

GitHub подключается либо через Coroid GitHub App либо персональный токен доступа. Настройте его в разделе Настройки → Подключения → Управление исходным кодом.

Приложение или токен

Рекомендуем использовать приложение. Оно предоставляет доступ к конкретным репозиториям, а не к пользователям, продолжает работать даже после ухода человека, настроившего его, и получает события вебхуков без необходимости опроса.

Используйте токен, если для установки приложения требуется разрешение администратора организации, которого у вас нет.

GitHub AppПерсональный токен доступа
Область доступаНа уровне конкретного репозиторияВсе, что видит пользователь
Продолжает работать после ухода установщикаДаНет
События вебхуковДаОпрос
АтрибуцияПриложениеВладелец токена

Установка приложения

Выберите GitHub в разделе Настройки → Подключения → Управление исходным кодом и следуйте инструкциям по установке. GitHub запросит, какие репозитории предоставить ему доступ; позже вы сможете изменить этот параметр в собственных настройках GitHub.

Если при создании проекта нужный репозиторий не отображается, скорее всего, приложению не предоставлен доступ именно к этому репозиторию — это самая распространенная причина.

Использование токена

Создайте классический токен со repo областью доступа или точечный токен с правами чтения и записи для содержимого и задач типа pull request, затем вставьте его в настройки управления исходным кодом.

Токены шифруются при хранении, никогда не возвращаются системой API и не включаются в экспорт настроек.

GitHub Issues

То же самое соединение позволяет импортировать задачи в виде рабочих элементов. Подробнее в статье Импорт рабочих элементов.

Что делает Coroid в вашем репозитории

  • читает код, чтобы понять его структуру и внести изменения
  • создает отдельную ветку для каждой задачи
  • загружает эту ветку и открывает в ней задачу pull request против вашей базовой ветки

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