GitHub подключается либо через Coroid GitHub App либо через персональный доступный токен. Настройте его в Настройки → Подключения → Управление исходным кодом.
Приложение или токен
Рекомендуем использовать приложение. Оно предоставляет доступ к конкретным репозиториям, а не к пользователям, продолжает работать даже после ухода человека, настроившего его, и получает события вебхуков без необходимости опроса.
Используйте токен, если для установки приложения требуется одобрение администратора организации, которого у вас нет.
| GitHub App | Персональный доступный токен | |
|---|---|---|
| Область доступа | На уровне репозитория | Все, что видит пользователь |
| Продолжает работать после ухода установщика | Да | Нет |
| События вебхуков | Да | Опрос |
| Привязка | Приложение | Владелец токена |
Установка приложения
Выберите GitHub в Настройки → Подключения → Управление исходным кодом и следуйте инструкциям по установке. GitHub спросит, какие репозитории предоставить доступ; позже вы сможете изменить это в собственных настройках GitHub.
Если при создании проекта репозиторий не отображается, скорее всего, приложению не был предоставлен доступ именно к этому репозиторию — это самая частая причина.
Использование токена
Создайте классический токен со repo областью доступа или точечный токен с правами чтения и записи для содержимого и запросов на объединение, затем вставьте его в настройки системы контроля версий.
Токены шифруются при хранении, никогда не возвращаются API и не включаются в экспорт настроек.
GitHub Issues
То же самое соединение позволяет импортировать задачи как рабочие элементы. См. Импорт рабочих элементов.
События, превращающиеся в рабочие элементы
При использовании приложения автоматизация событий может отправлять pull request, новую задачу или комментарий с упоминанием Coroid в модуль Qualification. См. Триггеры и назначения.
Квалифицированные рабочие элементы из этих событий начинают выполняться автоматически только если их автор имеет права записи, поддержки или администрирования в репозитории. Coroid запрашивает GitHub для каждого события. Для pull request автором является человек, открывший задачу, а не тот, кто её пометил или объединил. Рабочие элементы от других людей создаются и ждут, пока кто-то их запустит. Комментарий с упоминанием Coroid учитывается только если у его автора есть права записи.
Рецензирование запросов на объединение
При использовании приложения Coroid проверяет и рецензирует запросы на объединение, созданные людьми и другими инструментами, а не только собственные запросы Coroid. Модуль Quality Control Coroid запускает проверки проекта и публикует результат проверки Quality Control Coroid. Модуль Review Coroid оставляет комментарии к строкам кода, вызвавшим вопросы, и создает проверку под названием Review Coroid. Обе настройки задаются в Quality Control, в разделе «Запросы на объединение». См. Запросы на объединение.
Что делает Coroid в вашем репозитории
- читает код, чтобы понять его и изменить
- создает ветку для каждой задачи
- загружает эту ветку и открывает запрос на объединение pull request в вашу базовую ветку
Оно никогда не коммитит изменения в вашу ветку по умолчанию и не объединяет их самостоятельно. Объединение происходит только когда человек объединит pull request в GitHub или нажмет Утвердить и объединить в Coroid.
Проект, настроенный на Только локально , выполняет первое из этих действий и больше ничего: Coroid читает и извлекает данные, а ветки, проверки и рецензии хранятся внутри Coroid. Оно не загружает изменения, не открывает и не комментирует запросы на объединение, не публикует результаты проверок, даже если приложение или токен позволяют это делать. См. Синхронизировано или только локально.
Ваши правила защиты веток, обязательных проверок и рецензирования применяются без изменений. Утвердить и объединить также объединяет через pull request, поэтому успех операции определяется теми же правилами. См. Объединение.