Интеграция Codex с GitHub

Codex глубоко интегрируется с GitHub, позволяя проверять код прямо в пул-реквестах. В этом разделе подробно описано, как настроить и использовать интеграцию с GitHub.


Обзор возможностей

С интеграцией с GitHub вы можете:

  • Запросить проверку Codex прямо в комментарии к PR
  • Автоматически проверять каждый пул-реквест
  • Поручить Codex исправлять сбои CI
  • Просматривать изменения кода и давать предложения
Не покидая GitHub, Codex будет отвечать комментариями к ревью, как коллега.

Настройка интеграции с GitHub

Предварительные требования

  • Подписка Codex Cloud
  • Аккаунт GitHub

Шаги настройки

  1. НастройкиCodex Cloud
  2. Перейдите вНастройки Codex
  3. Включить для репозиторияРевью кодаФункции
  4. Авторизуйте Codex для доступа к вашим репозиториям
Вам нужно предоставить Codex разрешение на чтение репозиториев и создание пул-реквестов.

Запрос ревью кода

Ручной запуск ревью

Упомяните Codex в комментарии к пул-реквесту@codex review:

Запросить ревью

# Введите это в комментарий к PR
@codex review

# Или укажите фокус ревью
@codex review на предмет регрессий безопасности

Ответ Codex

Codex выполнит:

  1. Отреагировать на PR (👀)
  2. Проанализировать изменения кода
  3. Опубликовать комментарии к ревью
  4. Отметить найденные проблемы (P0 и P1)
Codex опубликует комментарии к ревью в PR точно так же, как это делает человек-ревьюер.

Автоматическое ревью

Включите в настройкахАвтоматические ревью:

  1. Перейдите вНастройки Codex
  2. ВключитьАвтоматические ревью
  3. Автоматически публиковать ревью при открытии нового PR

Настройка содержимого проверки

Настройка правил проверки репозитория

В репозиторииAGENTS.mdдобавьте правила проверки:

Добавить правила проверки

## Рекомендации по ревью

- Не логируйте PII (персонально идентифицируемая информация)
- Убедитесь, что промежуточное ПО аутентификации оборачивает каждый маршрут
- Проверьте на наличие уязвимостей SQL-инъекций
- Убедитесь, что сообщения об ошибках не раскрывают конфиденциальную информацию

Правила для конкретных модулей

Поместите более конкретные правила проверки в подкаталоги:

Правила для конкретных модулей

# src/payment/ правила проверки для конкретного модуля

## Ревью, специфичные для платежей
- Убедитесь, что обработка платежей соответствует требованиям PCI
- Проверьте корректность валидации суммы
- Обеспечьте логирование транзакций
Более конкретные правила автоматически применяются к изменениям кода в соответствующем модуле.

Фокус разового ревью

Укажите фокус ревью в комментарии:

Укажите фокус ревью

# Пример комментария
@codex review для проблем безопасности
@codex review для регрессий производительности
@codex review для полноты документации

Дайте Codex другие задачи

Упомяните Codex в комментарии@codex(не 'review') запускает облачную задачу:

Другие задачи

# Исправить сбои CI
@codex исправь сбои CI

# Добавить тесты
@codex добавь тесты для новых эндпоинтов API

# Рефакторинг кода
@codex отрефактори эту функцию чтобы использовать async/await
Использование других возможностей Codex так же просто, как @-упоминание его в комментарии.

Интеграция с GitHub Actions

Вы также можете использовать Codex в GitHub Actions:

Рабочий процесс GitHub Actions

span style="color: green;">
name: Ревью Codex

on
: [pull_request]

jobs
:
  codex-review
:
    runs-on
: ubuntu-latest
    steps
:
      - uses
: actions/checkout@v4

      - name
: Запуск ревью Codex
        run
: |
         codex exec "Review code changes in this PR" --output review.md

      - name
: Опубликовать ревью
        uses
: actions/github-script@v7
        with
:
          script
: |
           const fs = require('fs');
            const review = fs.readFileSync('review.md', 'utf8');
            github.rest.pulls.createReview({
              owner: context.repo.owner,
              repo: context.repo.repo,
              pull_number: context.issue.number,
              body: review,
              event: 'COMMENT'
            });

Интеграция Codex в ваш конвейер CI/CD может автоматизировать проверку кода.

Лучшие практики

Рекомендации по проверке

  • Чётко определите стандарты проверки в AGENTS.md.
  • Задайте конкретные правила для разных модулей
  • Указывайте приоритеты проблем (P0/P1)

Автоматизация

  • Включите автоматическую проверку для обычных PR
  • Используйте ручной запуск для крупных изменений
  • Используйте в сочетании с автоматизированными рабочими процессами
Хорошая конфигурация может сделать проверки Codex более точными и эффективными.

ЧАВО

Вопрос: Нужно ли платить за ревью Codex?

Для интеграции с GitHub требуется подписка Codex Cloud.

Вопрос: Может ли Codex получать доступ к приватным репозиториям?

Вам нужно авторизовать Codex для доступа к вашим приватным репозиториям.

Вопрос: Могу ли я ограничить, какие репозитории Codex может проверять?

Да, вы можете выборочно авторизовать репозитории в настройках.

Вопрос: Какие уровни проблем отмечает Codex?

По умолчанию проблемы отмечаются как P0 (критические) и P1 (значительные).

Другие расширения