разработкаCI/CD

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

Синхронизируйте конфигурацию маршрутов шлюза и типы SDK с репозиторием — изменения применяются автоматически при пуше в основную ветку.

Что делает интеграция

После подключения GitHub App к репозиторию Hexly отслеживает файл hexly.config.yaml в корне проекта. Каждый пуш в основную ветку запускает валидацию конфигурации и, при успешной проверке, применяет изменения к маршрутам шлюза без ручного шага деплоя.

Настройка

  1. В дашборде Hexly откройте раздел Настройки проекта → Интеграции и нажмите «Подключить GitHub».
  2. Выберите репозиторий и предоставьте доступ на чтение содержимого и запись статусов проверки коммитов.
  3. Добавьте файл hexly.config.yaml в корень репозитория — пример конфигурации есть в разделе документации «Быстрый старт».
  4. Сделайте пуш — в интерфейсе GitHub появится статус проверки от Hexly с результатом валидации.
i

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

Пример конфигурации

hexly.config.yaml
routes:
  - path: /v1/orders
    upstream: https://api.internal/orders
    rate_limit: 1000/min
  - path: /v1/users
    upstream: https://api.internal/users
    auth: required

Готовы подключить репозиторий?

Настройка занимает около 10 минут вместе с первым тестовым деплоем.