Перейти к содержанию

Часто задаваемые вопросы

👉 Что такое BeeCR?

BeeCR — это AI-ассистент для код-ревью в GitLab, разработанный CVisionLab. Он интегрируется с GitLab с помощью вебхуков или CI/CD для предоставления автоматических код-ревью.

👉 Какие языки программирования поддерживаются?

BeeCR поддерживает широкий спектр языков программирования, включая, но не ограничиваясь, Python, JavaScript, Java, Kotlin, Swift, C#, C++, Ruby и PHP.

👉 Могу ли я использовать BeeCR локально?

Да, BeeCR предлагается в двух моделях: SaaS и локально.

👉 Как BeeCR интегрируется с GitLab?

BeeCR интегрируется с GitLab через вебхуки или CI/CD (шаблон для старых версий GitLab или компонент для GitLab 17+).

👉 Как BeeCR получает доступ к моему проекту в GitLab?

BeeCR получает доступ к вашему проекту в GitLab с помощью Access Token. Вам нужно настроить токен проекта или группы с правами не ниже уровня разработчика и областью "api".

💡 Совет: Мы рекомендуем создавать токен проекта или группы с описательным именем, например, BeeCR Code Reviewer, так как комментарии код-ревью будут авторизованы от имени GitLab Bot с этим именем.

Способ передачи токена зависит от выбранного метода интеграции:

👉 Какие события должны вызывать вебхук BeeCR для ревью кода?

Вебхук BeeCR может быть вызван двумя типами событий в GitLab:

  • События Merge Request: Автоматически проверяет изменения, когда создается или обновляется Merge Request.
  • События комментариев: Проверяет изменения, когда добавляется комментарий с триггерным словом /beecr.

👉 Как я могу настроить вебхук BeeCR?

Вебхук BeeCR можно настроить несколькими способами:

  1. Через HTTP-заголовки в настройках вебхука.
  2. Через параметры запроса в URL вебхука.
  3. Через конфигурационный файл .beecr.yml в корне вашего репозитория.
  4. Через настройки сервера API BeeCR (если вы используете BeeCR локально).

Мы рекомендуем устанавливать все секреты (API-ключи и токены) через заголовки, а все остальные параметры через конфигурационный файл .beecr.yml.

👉 Как передать дополнительные инструкции BeeCR?

Вы можете передать дополнительные инструкции BeeCR двумя способами:

  • Конфигурационный файл: Добавьте ключ instructions в конфигурационный файл .beecr.yml в корне вашего репозитория. Например:
    .beecr.yml
    instructions: "Не фокусируйся на стиле кода, выделяйте только ошибки."
  • Комментарии в Merge Request: Включите ключевое слово /beecr в ваши комментарии вместе с дополнительными инструкциями. Например: 
    /beecr Проверий только проблемы безопасности.

👉 Какие файлы будут проверены?

BeeCR проверяет файлы, которые являются частью Merge Request в вашем проекте GitLab.

Файлы для проверки зависят от вашей конфигурации. Вы можете указать целевые файлы, используя регулярные выражения. По умолчанию BeeCR проверяет файлы, содержащие исходный код, написанный на популярных языках программирования, включая Python, C/C++, C#, Java, Kotlin, Swift, PHP, Go, Bash/Shell и JavaScript/TypeScript.

Для более подробной информации о конфигурации целевых файлов, смотрите:

👉 Что делать, если у меня self-hosted GitLab и фаервол?

Если у вас строгие правила фаервола, вам нужно добавить IP-адрес 34.88.129.98 в ваш белый список. BeeCR будет отправлять запросы с этого IP-адреса, поэтому добавление его в белый список обеспечит правильную связь.

👉 Как я могу установить BeeCR локально?

BeeCR можно установить локально тремя различными способами:

  1. Docker: Это самый простой метод, подходящий для большинства пользователей. Вы можете использовать Docker для запуска BeeCR локально. Этот метод включает использование Docker Compose для настройки и управления контейнерами BeeCR. Руководство по развертыванию локального сервера (через Docker) предоставляет полное руководство по этому процессу.
  2. Скрипт установки: Этот метод подходит для пользователей, которые не хотят использовать контейнеризированное развертывание по каким-либо причинам. Он включает запуск скрипта установки, который автоматизирует процесс настройки. Вы можете следовать пошаговому руководству в Руководстве по развертыванию локального сервера (через скрипт установки).
  3. Ручная настройка: Этот метод предназначен для опытных пользователей, которые хотят больше контроля над процессом установки и настройки. Он требует ручной настройки окружения и установки необходимых компонентов. Подробные инструкции можно найти в Руководстве по развертыванию локального сервера (вручную).

👉 Как я могу использовать кастомный адрес OpenAI?

Если вы используете локальную версию BeeCR, вы можете указать кастомный хост API OpenAI. Это полезно при использовании самохостинговой или корпоративной версии API OpenAI.

Вы можете переопределить хост OpenAI следующими способами:

  • Заголовок BEECR-OPENAI-HOST в настройках вебхука.
  • Параметр запроса openai-host в URL вебхука.
  • Свойство openai-host в YAML-конфигурационном файле .beecr.yml в корне вашего репозитория.
  • Через параметр OPENAI_HOST сервера API.

👉 Есть ли примеры ревью?

Да, мы предоставляем несколько примеров, демонстрирующих код-ревью, сгенерированные BeeCR непосредственно в интерфейсе GitLab. Вы можете найти эти примеры в нашем разделе Примеры.

👉 Как я могу связаться с поддержкой?

Вы можете связаться с командой поддержки BeeCR по электронной почте beecr@cvisionlab.com или через Telegram на @cvision_support_bot (отвечает живой человек 🙂).