Подключение репозитория GitHub

Before Orbit can deploy anything from GitHub you install the Kapsule Orbit GitHub App on your GitHub account or organisation and choose which repositories it can see. This guide walks through the…

Перед тем как Orbit может развернуть что-либо из GitHub, вы установите приложение Kapsule Orbit GitHub App на свою учетную запись GitHub или организацию и выберете, какие репозитории оно может видеть. Это руководство проходит через установку, выбор репозитория, создание проекта и что делать, когда репозиторий, который вы ожидаете, не появляется.

Перед началом

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

Шаг 1: Установка приложения Kapsule Orbit GitHub App

В KPanel нажмите Orbit на левой боковой панели.
Нажмите New project (Новый проект).
Оставьте режим установленным на Import Git Repo (Импортировать репозиторий Git).
На шаге 1 нажмите Connect GitHub (Подключить GitHub).

Вас отправляют на GitHub для установки приложения Kapsule Orbit. GitHub спрашивает, где его установить (на вашу личную учетную запись или в организацию), а затем предлагает выбрать All repositories (Все репозитории) или Only select repositories (Только выбранные репозитории).

Выберите Only select repositories (Только выбранные репозитории) и отметьте только репозитории, которые вы планируете развернуть. Позже вы можете добавить еще репозитории из GitHub без отключения или воссоздания чего-либо в Orbit, и это держит радиус поражения интеграции небольшим.

Когда вы закончите, GitHub отправляет вас обратно в KPanel. Шаг 1 теперь показывает Just connected (Только что подключено), и ваши репозитории загружаются на шаг 2.

Шаг 2: Выбор репозитория

Ваши доступные репозитории появляются в виде списка. Нажмите Select (Выбрать) на том, который вы хотите развернуть. Приватные репозитории содержат значок Private (Приватный); Orbit развертывает как общедоступные, так и приватные репозитории.

После выбора репозиторий показывает значок Selected (Выбранно), и ссылка Change (Изменить) позволяет вам выбрать другой.

Если репозиторий отсутствует

Orbit может отобразить только то, что может видеть приложение GitHub. Если репозитория, который вы ожидаете, нет там:

Нажмите Reconnect GitHub (Переподключить GitHub) на шаге 1, чтобы повторить процесс установки, или откройте github.com/settings/installations непосредственно.
Откройте установку Kapsule Orbit и добавьте отсутствующий репозиторий в разделе Repository access (Доступ к репозиториям).
Вернитесь в KPanel. Список обновится.

Если панель показывает No repos accessible (Нет доступных репозиториев), приложение установлено, но ему не были предоставлены никакие репозитории. Откройте настройки приложения GitHub и предоставьте доступ как минимум к одному.

Другие частые причины:

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

Шаг 3: Конфигурация вашего проекта

После выбора репозитория шаг 3 запрашивает два поля:

Поле	Что оно делает
Project Name (Имя проекта)	Отображаемое имя в KPanel, например `my-app`
Deploy URL (URL развертывания)	Поддомен под `kaps.run`, поэтому `my-app` становится `my-app.kaps.run`

Нажмите Create project (Создать проект). Orbit клонирует репозиторий, поставит в очередь вашу первую сборку и перенесет вас на обзор проекта, где вы сможете смотреть поток журнала.

Слаг Deploy URL устанавливается один раз при создании и не может быть изменен после этого. Если вам позже нужна другая общедоступная адресация, присоедините пользовательский домен, а не пытайтесь переименовать слаг. См. Adding a Custom Domain to Your Project (Добавление пользовательского домена к вашему проекту).

Что Orbit устанавливает автоматически

Создание проекта настраивает push-to-deploy для вас. Нет необходимости вручную конфигурировать webhook:

Pushes в вашу ветку production ставят в очередь развертывание production.
Если Branch previews (Предпросмотры веток) включены, pushes в любую другую ветку создают изолированный предпросмотр в branch-<branch-name>.kaps.run. См. Branch Preview Deployments in Orbit (Развертывания предпросмотра ветки в Orbit).
Активность pull request отслеживается, поэтому развертывание предпросмотра показывает номер PR, к которому оно относится.
Закрытие или слияние pull request останавливает его предпросмотр, и хранилище восстанавливается примерно через день.

Развертывание на основе GitHub Actions

Если вы запускаете тесты в GitHub Actions, вы можете заставить Orbit дождаться их. В Settings (Параметры), затем CI required checks (Требуемые проверки CI), введите точные имена заданий Actions, разделенные запятыми, например build,test,lint. Все названные проверки должны пройти, прежде чем развертывание production, инициированное push, продолжится. Ошибка CI отменяет развертывание Orbit автоматически.

Это применяется только к ветке production.

Переподключение или изменение вашей установки

Чтобы изменить, какие репозитории может видеть Orbit:

Нажмите Orbit, затем New project (Новый проект).
На шаге 1 нажмите Reconnect (Переподключить), чтобы повторить процесс установки приложения GitHub.

Или управляйте установкой напрямую на github.com/settings/installations. Изменения там будут подобраны в следующий раз, когда Orbit будет перечислять ваши репозитории.

Отключение GitHub

На шаге 1 New project (Новый проект) нажмите Disconnect (Отключить).

Отключение удаляет связь между вашей учетной записью Kapsule и GitHub. Ваши проекты и их история развертывания сохраняются, и текущее развернутое развертывание продолжает обслуживать трафик, но развертывания, инициированные push, останавливаются, пока вы не переподключитесь. Хуки развертывания продолжают работать, потому что они получают ветку head через подключение поставщика: если подключение отсутствует, вызов hook завершается с ошибкой, а не развертывает устаревший код.

Дополнительное чтение

Deploying Your Project (Развертывание вашего проекта) для полного цикла развертывания и шлюзов, которые его контролируют
Configuring Your Build Command and Output Directory (Конфигурация вашей команды сборки и выходного каталога), если первая сборка не удалась или выдает неправильное содержимое
Connecting a GitLab Repo (Подключение репозитория GitLab) и Connecting a Bitbucket Repo (Подключение репозитория Bitbucket) для других поставщиков