Skip to main content
Мы публикуем частые обновления нашей документации, и перевод этой страницы может все еще выполняться. Актуальные сведения см. в документации на английском языке.
All products
Веб-перехватчики и события

Получение веб-перехватчиков с помощью GitHub CLI

В этой статье

GitHub CLI можно использовать для тестирования веб-перехватчиков в среде разработки без сложной переадресации портов или сторонних средств.

Сведения о получении веб-перехватчиков с помощью GitHub CLI

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

Примечание: Переадресация веб-перехватчиков в GitHub CLI работает только с веб-перехватчиками репозитория и организации. Если вы хотите протестировать спонсорские веб-перехватчики, веб-перехватчики GitHub App, enterprise или Marketplace локально, это необходимо сделать вручную. Дополнительные сведения см. в разделе Создание веб-перехватчиков.

Получение веб-перехватчиков с помощью GitHub CLI

Дополнительные сведения о GitHub CLI см. в разделе Сведения о GitHub CLI.

  1. Чтобы установить расширение GitHub CLI для включения переадресации веб-перехватчиков, используйте extension install подкоманду.

    gh extension install cli/gh-webhook

  2. Если вы хотите переадресовать веб-перехватчики организации, добавьте admin:org_hook область в имя входа GitHub CLI, чтобы у вас были необходимые разрешения.

    gh auth refresh --scopes admin:org_hook

  3. Запустите приложение локально и запишите URL-адрес, по которому оно ожидает получать веб-перехватчики. В этом руководстве предполагается, что приложение прослушивает события веб-перехватчика в http://localhost:3000/webhook.

  4. Чтобы настроить веб-перехватчики для доставки в приложение, выполните 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-адресу.