이제 웹후크의 기본 사항을 이해했으므로 웹후크 기반 통합을 빌드하는 과정을 살펴보겠습니다. 이 자습서에서는 하루에 리포지토리가 수신되는 이슈 개수에 따라 리포지토리의 인기도를 나열하는 리포지토리 웹후크를 만듭니다.
웹후크 만들기는 2단계 프로세스입니다. 먼저 웹후크가 수신 대기해야 하는 이벤트를 설정해야 합니다. 그런 다음 페이로드를 받고 관리하도록 서버를 설정합니다.
REST API를 사용하여 리포지토리, 조직 및 앱 웹후크를 관리할 수 있습니다. 웹후크에 대한 웹후크 배달을 나열하거나 외부 앱 또는 서비스에 통합할 수 있는 웹후크에 대한 개별 배달을 가져와서 다시 배달할 수 있습니다. REST API를 사용하여 웹후크의 구성을 변경할 수도 있습니다. 예를 들어 페이로드 URL, 콘텐츠 형식, SSL 확인 및 비밀을 수정할 수 있습니다. 자세한 내용은 다음을 참조하세요.
인터넷에 localhost 노출
이 자습서에서는 로컬 서버를 사용하여 GitHub에서 웹후크 이벤트를 수신합니다.
우선 GitHub에서 이벤트를 제공할 수 있도록 로컬 개발 환경을 인터넷에 노출해야 합니다. 이 작업을 수행하는 데 사용합니다 ngrok .
ngrok 는 모든 주요 운영 체제에 대해 무료로 사용할 수 있습니다. 자세한 내용은 ngrok 다운로드 페이지를 참조하세요.
ngrok를 설치한 후 명령줄에서 ./ngrok http 4567을 실행하여 localhost를 노출할 수 있습니다. 4567 는 서버가 메시지를 수신 대기할 포트 번호입니다. 다음과 같은 줄이 표시됩니다.
$ Forwarding http://7e9ea9dc.ngrok.io -> 127.0.0.1:4567*.ngrok.io URL을 기록해 둡니다. 이 URL은 웹후크를 설정하는 데 사용합니다.
웹후크 설정
조직 또는 특정 리포지토리에 웹후크를 설치할 수 있습니다.
웹후크를 설정하려면 리포지토리 또는 조직의 설정 페이지로 이동합니다. 여기에서 웹후크를 클릭한 다음 웹후크 추가를 클릭합니다.
또는 웹후크 API를 통해 웹후크를 빌드 및 관리하도록 선택할 수 있습니다.
사용하기 전에 웹후크에는 몇 가지 구성 옵션이 필요합니다. 이러한 각 설정은 아래에서 살펴봅니다.
페이로드 URL
참고: GitHub 웹후크는 현재 IPv6을 지원하지 않지만 향후 지원될 예정입니다. REST API 엔드포인트는 /meta IPv6 범위를 반환하여 해당 전환을 사용하도록 설정합니다.
페이로드 URL은 웹후크 POST 요청을 수신하는 서버의 URL입니다.
자습서를 위해 로컬로 개발 중이므로 *.ngrok.io URL로 설정하고 그 뒤에 /payload가 따라오도록 합니다. 예: http://7e9ea9dc.ngrok.io/payload.
내용 유형
다양한 콘텐츠 형식을 사용하여 웹후크를 전달할 수 있습니다.
application/json콘텐츠 형식은 JSON 페이로드를POST요청의 본문으로 직접 전달합니다.application/x-www-form-urlencoded콘텐츠 형식은 JSON 페이로드를payload라는 양식 매개 변수로 전송합니다.
요구에 가장 적합한 설정을 선택합니다. 이 자습서에서는 기본 콘텐츠 형식인 application/json이면 적절합니다.
비밀
웹후크 비밀을 설정하면 페이로드 URL로 전송된 POST 요청이 GitHub Enterprise Server에서 전송되었는지 확인할 수 있습니다. 비밀을 설정하면 웹후크 POST 요청에서 X-Hub-Signature 및 X-Hub-Signature-256 헤더를 받게 됩니다. 서명 헤더와 함께 비밀을 사용하여 웹후크 페이로드를 보호하는 방법에 대한 자세한 내용은 "웹후크 보안"을 참조하세요.
SSL 확인
“페이로드 URL”이 보안 사이트(HTTPS)인 경우 SSL 확인 설정을 구성하는 옵션이 있습니다. “페이로드 URL”이 안전하지 않은 경우(HTTP) GitHub는 이 옵션을 표시하지 않습니다. 기본적으로 GitHub는 웹후크 페이로드를 제공할 때 웹 사이트의 SSL 인증서를 확인합니다. SSL 확인은 후크 페이로드가 URL 엔드포인트에 안전하게 전달되도록 하는 데 도움이 됩니다. SSL을 사용하지 않도록 설정하는 옵션이 있지만 SSL 확인 사용을 선택된 상태로 유지하는 것이 좋습니다.
Active
기본적으로 웹후크는 “활성”으로 제공됩니다. “활성”을 선택 취소하여 웹후크 페이로드의 제공을 사용하지 않도록 선택할 수 있습니다.
이벤트
이벤트는 웹후크의 핵심입니다. 이러한 웹후크는 서버의 페이로드 URL이 가로채고 작동하는 리포지토리에서 특정 작업을 수행할 때마다 발생합니다.
웹후크 이벤트의 전체 목록과 이러한 이벤트를 실행할 수 있는 경우는 웹후크 API 참조에서 확인할 수 있습니다.
웹후크가 리포지토리의 이슈를 처리하고 있으므로 개별 이벤트를 선택하겠습니다를 선택한 다음 이슈를 클릭합니다. 트리거된 웹후크에 대한 문제 이벤트를 수신하도록 활성이 선택되어 있는지 확인합니다. 기본 옵션을 사용하여 모든 이벤트를 선택할 수도 있습니다.
작업을 완료하면 웹후크 추가를 클릭합니다.
이제 웹후크를 만들었으므로 이제 웹후크를 테스트하도록 로컬 서버를 설정할 차례입니다. 이렇게 하는 방법을 알아보려면 서버 구성으로 이동하세요.
와일드카드 이벤트
모든 이벤트에 대해 웹후크를 구성하려면 와일드카드(*) 문자를 사용하여 웹후크 이벤트를 지정합니다. 와일드카드 이벤트를 추가하면 구성한 기존 이벤트를 와일드카드 이벤트로 바꾸고 지원되는 모든 이벤트에 대한 페이로드를 보냅니다. 또한 나중에 추가할 수 있는 새 이벤트도 자동으로 받게 됩니다.