Octokit.Webhooks 2.2.3

Octokit.Webhooks

用于在 .NET 应用程序中处理 GitHub Webhooks 的库。

用法

ASP.NET Core

1. dotnet add package Octokit.Webhooks.AspNetCore

2. 创建一个继承自 WebhookEventProcessor 的类，并覆盖任何虚拟方法以处理来自 GitHub 的 Webhooks。例如，要处理拉取请求 Webhooks

   public sealed class MyWebhookEventProcessor : WebhookEventProcessor
   {
       protected override Task ProcessPullRequestWebhookAsync(WebhookHeaders headers, PullRequestEvent pullRequestEvent, PullRequestAction action) {
           ...
       }
   }
   

3. 注册你的 WebhookEventProcessor 实现

   builder.Services.AddSingleton<WebhookEventProcessor, MyWebhookEventProcessor>();
   

4. 映射 Webhook 端点

   app.UseEndpoints(endpoints =>
   {
       ...
       endpoints.MapGitHubWebhooks();
       ...
   });
   

MapGitHubWebhooks() 拥有两个可选参数

• path。默认为 /api/github/webhooks，GitHub 的端点 URL。
• secret。如果你已配置，这是你的 GitHub 中的密钥。

Azure Functions

注意：仅提供对 隔离过程 Azure Functions 的支持。

1. dotnet add package Octokit.Webhooks.AzureFunctions

2. 创建一个继承自 WebhookEventProcessor 的类，并覆盖任何虚拟方法以处理来自 GitHub 的 Webhooks。例如，要处理拉取请求 Webhooks

   public sealed class MyWebhookEventProcessor : WebhookEventProcessor
   {
       protected override Task ProcessPullRequestWebhookAsync(WebhookHeaders headers, PullRequestEvent pullRequestEvent, PullRequestAction action) {
           ...
       }
   }
   

3. 注册你的 WebhookEventProcessor 实现

   .ConfigureServices(collection =>
   {
       ...
       collection.AddSingleton<WebhookEventProcessor, MyWebhookEventProcessor>();
       ...
   })
   

4. 配置 Webhook 函数

   new HostBuilder()
   ...
   .ConfigureGitHubWebhooks()
   ...
   .Build();
   

ConfigureGitHubWebhooks() 拥有一个可选参数

• secret。如果你已配置，这是你的 GitHub 中的密钥。

该函数在 /api/github/webhooks 端点可用。

感谢

• octokit/webhooks
• terrajobst/Terrajobst.GitHubEvents
• Dotnet-Boxed/Templates

许可证

本仓库中所有包均使用MIT许可证授权。