GitHub CLI 2.105.0 научился ждать событий pull request через Event Streams
Локальный инструмент может получать уведомления рецензирования и проверок по открытому соединению. Доступ к предварительной версии выдаётся по списку ожидания.

Ожидание следующего изменения
18 ноября GitHub добавила поддержку Event Streams в версию 2.105.0 консольной утилиты GitHub CLI. Ранее команда, которая ждёт следующего отзыва или прохождения проверки, могла регулярно запрашивать состояние pull request. Теперь утилита умеет открыть поток для конкретного запроса на слияние, ждать нужного события и передать результат следующему шагу. Серверный компонент в предварительной версии был анонсирован днём ранее, 17 ноября. Ноябрьское обновление даёт ему штатный клиент для терминала.
Отдельный публичный адрес для приёма вебхуков в такой схеме не требуется. Клиент инициирует долгое соединение с GitHub.com, а сервис отправляет сообщения о событиях через него. Для разработчика, который ждёт рецензию с рабочего ноутбука, это снимает необходимость держать отдельный сервер только для получения сигнала. Командам, которые уже поддерживают вебхуки для десятков репозиториев, важнее сопоставить эту возможность с имеющейся схемой: текущая подписка охватывает один pull request.
Что передаётся через поток
Справочник перечисляет пять типов событий: отправка рецензии, смена состояния запроса, изменение его головной ветки, возникновение конфликта слияния и завершение отдельного набора автоматических проверок. Обычные комментарии во вкладке разговора пока не поддерживаются. Это влияет на выбор уведомления: если команда привыкла оставлять решения в обычном комментарии, поток о рецензиях может не отразить такое сообщение.
Команда выводит каждое событие отдельной строкой JSON, а служебные сообщения отправляет в отдельный поток ошибок. По умолчанию она заканчивает работу после первого подходящего события. Режимы непрерывного ожидания, ограничения числа событий и тайм-аут предусмотрены отдельно. Полученное сообщение описывает изменение и может содержать ссылку на объект API. Полное текущее состояние при необходимости запрашивается отдельно. Так сценарий отличается от периодического запроса всех данных: чтение становится реакцией на новое событие.
Почему важно перепроверять состояние
События, прошедшие до подключения клиента или во время обрыва, не воспроизводятся после восстановления соединения. Документация рекомендует прочитать актуальное состояние запроса после открытия потока. Кроме того, сообщения могут дублироваться или приходить не по порядку. Если от них зависит действие команды, например разрешение следующего этапа сборки, окончательное решение лучше основывать на текущем состоянии объекта, а не на порядке строк в терминале.
Есть отдельная оговорка для непрерывной интеграции. У одного запроса может быть несколько наборов проверок, и сообщение о завершении одного набора не говорит, что остальные тоже завершились. Если сценарий ждёт результатов всего набора проверок, после очередного сигнала важно посмотреть их сводное состояние. Это позволяет быстрее получить уведомление, но сохраняет проверку полноты результата.
Границы предварительного доступа
Команды доступны только в предварительной версии Event Streams на GitHub.com. Для начала работы владельцу учётной записи нужно получить доступ после заявки в список ожидания. На GitHub Enterprise Server и GHE.com команды сейчас не получают эти события. Подписки действуют 24 часа, поэтому они рассчитаны на ограниченный период наблюдения. Для долгого процесса нужно учитывать срок подписки и актуальное состояние запроса при возобновлении ожидания.

