Octokit.Webhooks.AspNetCore 2.2.3

Octokit.Webhooks

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

用法

ASP.NET Core

1. dotnet add package Octokit.Webhooks.AspNetCore

2. 创建一个从WebhookEventProcessor派生的类，并重写任何虚拟方法以处理来自GitHub的webhooks。例如，要处理Pull Request 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。如果你设置了此选项，则为此配置的密钥。

Azure Functions

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

1. dotnet add package Octokit.Webhooks.AzureFunctions

2. 创建一个从WebhookEventProcessor派生的类，并重写任何虚拟方法以处理来自GitHub的webhooks。例如，要处理Pull Request 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。如果你设置了此选项，则为此配置的密钥。

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

感谢

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

许可证

此仓库中的所有包都许可在 MIT 许可证 下。