GitHub deposu için bir web kancası ayarlama

  • 4 dakika

GitHub'da web kancaları bir kuruluş veya belirli bir depo için ayarlanabilir. Bir veya daha fazla abone olunan olay gerçekleştiğinde bir web kancası tetikleniyor. Örneğin Gollum olayı, özellikle wiki sayfası oluşturma ve güncelleştirmeleri olmak üzere wiki güncelleştirmelerini dinlemenizi sağlar.

Bu ünitede, şirketinizin GitHub wiki'sinden değişiklik olayını dinleyen bir web kancası ayarlamayı öğreneceksiniz.

Web kancası ayarlama

Web kancası ayarlama işlemi iki adımdan oluşur. İlk olarak, GitHub'da web kancanızın nasıl davranmasını istediğinizi ve hangi olayları dinleyeceğini belirtirsiniz. İkincisi, web kancasından alınan yükü almak ve yönetmek için işlevinizi Azure İşlevleri'de ayarlarsınız. Örnek senaryoda, belirli bir depo için bir web kancası ayarlıyoruz.

Web kancasını ayarlamak için GitHub portalında üst menü çubuğundan Ayarlar seçin. Ayarlar sayfası, deponuzun adıyla birlikte görüntülenir. Sol menüde Web kancaları'nı ve ardından Web kancası ekle'yi seçin. Ayrıca, bu modülde ele alınmayan Web Kancaları API'si aracılığıyla bir web kancası derleyebilir ve yönetebilirsiniz.

Web kancalarını kullanabilmek için tamamlamanız gereken birkaç yapılandırma seçeneği vardır. Şimdi bu ayarları inceleyeceğiz.

Yük URL'si

Yük URL'si, web kancasının POST isteklerini alacak olan sunucunun URL'sidir.

Her olay türünün belirli bir yük biçimi vardır. Bu yük, web kancasını tetikleyen olayla ilgili bilgileri içerir.

Content type

Web kancaları iki farklı içerik türüyle teslim edilebilir:

  • Application/json içerik türü, JSON yükünü doğrudan post isteğinin gövdesi olarak teslim eder.
  • application/x-www-form-urlencoded içerik türü JSON yükünü payload adlı bir form parametresi olarak gönderir.

Dekont

Web kancası ekle sayfasında Gizli Dizi kullanarak web kancası tarafından gönderilen bilgileri koruyabilirsiniz. Bu konu, modülün ilerleyen bölümlerinde anlatılacaktır.

Ekinlikler

Olaylar, web kancalarının en önemli bölümüdür. Olaylar, depoda eylem uygulandığında gerçekleşir. Olay gerçekleştiğinde, web kancası tetikler ve belirttiğiniz URL'yi çağırır ve yük ve olay bilgilerini URL'nize gönderir. Örneğin, bir depoda her sorun olduğunda yanıt vermek için Tek tek olayları seçmeme izin ver'i ve ardından Sorunlar onay kutusunu seçin. Tetiklenen web kancaları için sorun olaylarını almak için Etkin onay kutusunu seçtiğinizden emin olun. Ardından tetikleyiciyi etkinleştirmek için Web kancası ekle'yi seçin.

Depodaki wiki güncelleştirmelerini dinlemek için Wiki onay kutusunu seçin. Bu olay, daha önce bahsedilen Gollum olayıdır. Seçtiğiniz tüm olayları tek tek kaydetmek için Web kancası ekle'yi seçin.

Web kancası olaylarının tam listesini ve ne zaman çalıştırabileceklerini GitHub Web Kancaları Olayları sayfasını ziyaret ederek bulabilirsiniz.

Bir sonraki alıştırmada, bir GitHub deposu için web kancası ayarlama işlemini ele alacağız.