Toolverse
All skills

coderabbit-webhooks-events

by jeremylongshore

Implement CodeRabbit webhook signature validation and event handling.\nUse when setting up webhook endpoints, implementing signature verification,\nor handling CodeRabbit event notifications securely.\nTrigger with phrases like \

Installation

Pick a client and clone the repository into its skills directory.

Installation

Quick info

Category
Security

About this skill

Implement CodeRabbit webhook signature validation and event handling.\nUse when setting up webhook endpoints, implementing signature verification,\nor handling CodeRabbit event notifications securely.\nTrigger with phrases like \

How to use

  1. Upewnij się, że CodeRabbit jest zainstalowany w Twoim repozytorium GitHub lub GitLab oraz że webhook GitHub jest skonfigurowany do wysyłania zdarzeń pull request. Przygotuj token dostępu (GitHub App lub personal access token) i plik .coderabbit.yaml w katalogu głównym repozytorium.

  2. Skonfiguruj endpoint webhook na swoim serwerze, który będzie odbierać żądania POST od GitHub. Endpoint powinien być dostępny publicznie i obsługiwać nagłówek x-hub-signature-256 zawierający podpis HMAC-SHA256.

  3. Zaimplementuj walidację sygnatury webhook, porównując wartość z nagłówka x-hub-signature-256 z oczekiwaną sygnaturą obliczoną za pomocą tajnego klucza webhook (GITHUB_WEBHOOK_SECRET). Użyj algorytmu SHA256 do weryfikacji autentyczności żądania.

  4. Przetwarzaj zdarzenia CodeRabbit na podstawie ich typu: pull_request_review (recenzje zatwierdzone lub z żądaniem zmian), pull_request_review_comment (komentarze liniowe), check_run.completed (wyniki analizy), issue_comment.created (podsumowania) i pull_request.labeled (etykiety dodane przez CodeRabbit).

  5. Wyodrębnij dane z payload'u webhook (treść recenzji, stan, ścieżkę pliku, pozycję w diff) i zintegruj je z Twoim systemem — na przykład zapisz wyniki w bazie danych, wyślij powiadomienia lub zaktualizuj status pull request'a.

  6. Przetestuj endpoint, wysyłając przykładowe żądania webhook z GitHub lub używając narzędzia takie jak curl z prawidłowym nagłówkiem sygnatury, aby upewnić się, że walidacja i przetwarzanie działają poprawnie.

Related skills