Сведения о получении веб-перехватчиков с помощью GitHub CLI
При внесении изменений в код интеграции выполнение кода в локальной среде позволяет быстро тестировать и выполнять итерацию без развертывания кода. GitHub CLI можно использовать для пересылки веб-перехватчиков в локальную среду.
Примечание: Переадресация веб-перехватчиков в GitHub CLI работает только с веб-перехватчиками репозитория и организации. Если вы хотите протестировать спонсорские веб-перехватчики, веб-перехватчики GitHub App, enterprise или Marketplace локально, это необходимо сделать вручную. Дополнительные сведения см. в разделе Создание веб-перехватчиков.
Получение веб-перехватчиков с помощью GitHub CLI
Дополнительные сведения о GitHub CLI см. в разделе Сведения о GitHub CLI.
-
Чтобы установить расширение GitHub CLI для включения переадресации веб-перехватчиков, используйте
extension install
подкоманду.gh extension install cli/gh-webhook
-
Если вы хотите переадресовать веб-перехватчики организации, добавьте
admin:org_hook
область в имя входа GitHub CLI, чтобы у вас были необходимые разрешения.gh auth refresh --scopes admin:org_hook
-
Запустите приложение локально и запишите URL-адрес, по которому оно ожидает получать веб-перехватчики. В этом руководстве предполагается, что приложение прослушивает события веб-перехватчика в
http://localhost:3000/webhook
. -
Чтобы настроить веб-перехватчики для доставки в приложение, выполните
webhook forward
подкоманду. ЗаменитеREPOSITORY
именем репозитория. Например,monalisa/octocat
. ЗаменитеEVENTS
разделенным запятыми списком событий, которые вы хотите получить. Например,issues,pull_request
. ЗаменитеURL
локальным URL-адресом, по которому приложение ожидает получать веб-перехватчики. Например,"http://localhost:3000/webhook"
. Чтобы прослушивать веб-перехватчики организации, а не веб-перехватчики репозитория, замените--repo
флаг флагом--org
. Например,--org="octo-org"
.gh webhook forward --repo=REPOSITORY --events=EVENTS --url=URL
Оставьте команду запущенной в фоновом режиме. Он получит все указанные события для указанного репозитория и перенаправит их обработчику веб-перехватчика, работающему по указанному URL-адресу.