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

Подключите свой код

Подключите репозиторий GitHub или GitLab, чтобы Coroid мог считывать данные и создавать запросы на объединение.

Для начала работы Coroid требуется доступ к репозиторию. Подключение поставщика Управления исходным кодом осуществляется один раз на уровне организации, после чего отдельные репозитории привязываются к Проектам.

Подключения управляются в разделе Настройки → Подключения → Управление исходным кодом (/settings/connections/source-control).

Поддерживаемые поставщики

ПоставщикСпособ подключенияДоступность
GitHubУстановка приложения GitHub или использование персонального токена доступа.Доступно для всех пользователей.
GitLabПерсональный токен доступаЗакрытая предварительная версия.

GitHub: установка приложения или токен.

Для GitHub лучше выбрать установку приложения Coroid GitHub. Приложение предоставляет доступ к конкретному репозиторию, а не к конкретному пользователю, продолжает работать даже после ухода человека, настроившего его, и позволяет Coroid получать события вебхуков без опросов.

Если для установки приложения требуется одобрение администратора, которого у вас нет, выберите вариант с персональным токеном доступа.

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

Подключение с помощью персонального токена доступа

Создайте токен в вашем поставщике, затем вставьте его в Настройки → Подключения → Управление исходным кодом.

Токен должен иметь права на чтение содержимого репозитория, создание веток и запросов на объединение. В GitHub для классического токена это repo область прав; в GitLab — api.

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

Привязка репозитория к Проекту

Подключение делает репозитории доступными; Проект — это среда, в которой фактически работает Coroid. Создать его можно в разделе Проекты → Новый, выберите подключенный репозиторий, и Coroid проведет первичный анализ кода, чтобы определить используемые языки, команды сборки и тестирования.

Именно этот первичный анализ позволяет агентам собирать и тестировать ваш проект, поэтому стоит проверить его результаты. Все ошибочно определенные параметры можно исправить в настройках самого Проекта.

Из какой ветки работает Coroid

Coroid создает ветку на основе вашей ветки по умолчанию и открывает запросы на объединение обратно в неё. Если требуется слияние в другую ветку, базовую ветку для каждого Проекта можно изменить в настройках репозитория, если она отличается от main.

Проверка подключения

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

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

Далее

Как задача превращается в pull request — что происходит после описания работы.