Настройка веб-перехватчика для репозитория GitHub

  • 4 мин

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

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

Настройка веб-перехватчика

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

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

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

URL-адрес полезных данных

URL-адрес полезных данных — это URL-адрес сервера, который будет получать запросы POST веб-перехватчика.

Каждый тип событий имеет определенный формат полезных данных. Полезные данные содержат сведения о событии, активировавшем веб-перехватчик.

Content type

Веб-перехватчики могут доставляться с помощью двух разных типов содержимого:

  • Тип содержимого application/json предоставляет полезные данные JSON непосредственно в виде текста запроса POST.
  • Тип контента application/x-www-form-urlencoded отправляет полезные данные JSON в качестве параметра формы с именем полезных данных.

Примечание.

На странице Добавить веб-перехватчик также можно указать способ защиты сведений, отправленных веб-перехватчиком с помощью секрета. Эта тема рассматривается далее в этом модуле.

События

События — центральный компонент веб-перехватчиков. Они происходят каждый раз, когда в репозитории выполняются действия. При возникновении события веб-перехватчик срабатывает и обращается по указанному URL-адресу, отправляя по нему полезные данные и сведения о событии. Например, чтобы обеспечить реагирование на каждую проблему, возникшую в репозитории, щелкните Let me select individual events (Я выберу отдельные события), а затем установите флажок Проблемы. Обязательно установите флажок Активные, чтобы получать события проблем для активированных веб-перехватчиков. Затем выберите Добавить веб-перехватчик, чтобы активировать триггер.

Чтобы ожидать передачи данных обновления на вики-сайте для репозитория, установите флажок Вики-сайт. Это событие Gollum, которое упоминалось ранее. Выберите Добавить веб-перехватчик, чтобы сохранить все отдельные события, выбранные вами.

Полный список событий веб-перехватчика и условий, в которых они могут срабатывать, см. на странице События веб-перехватчика GitHub.

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