GitHub Webhooks: Eventhandler für Issues und Pull-Requests

GitHub Webhooks: Eventhandler für Issues und Pull-Requests

Dies ist Folgeartikel 6 aus meiner Serie zu GitHub-Webhooks.

Heute zeige ich die Skripte, die Issues und Pull-Requests verarbeiten. Inhaltlich sind sich beide Dinge sehr ähnlich, daher sehen die Skripte auch fast gleich aus. So gleich, dass ich nur eine gemeinsame Skriptbesprechung mache.

Beide Skripte sind nur für gbsplay aktiv und schicken jeweils eine Benachrichtigung an die gbsplay-Mailingliste, wenn ein neues Item (Issue oder Pull-Request) eröffnet wurde.

handle_issue.pl

  1. #!/usr/bin/perl -I.
  2. use warnings;
  3. use strict;
  4.  
  5. use WebHookLib;
  6.  
  7. use constant SENDTO => 'gbsplay-dev@lists.uguu.de';
  8.  
  9. my $json = read_payload();
  10.  
  11. my $repository = $json->{repository}->{full_name};
  12. unless ($repository eq 'mmitch/gbsplay') {
  13.     print "  (R/$repository is ignored)\n";
  14.     exit;
  15. }
  16.  
  17. my $action = $json->{action};
  18. unless ($action eq 'opened') {
  19.     print "  (A/$action is ignored)\n";
  20.     exit;
  21. }
  22.  
  23. my $number = $json->{issue}->{number};
  24. my $title = $json->{issue}->{title};
  25. my $issue_url = $json->{issue}->{html_url};
  26. my $issue_body = crlf($json->{issue}->{body});
  27.  
  28. my $subject = sprintf "new issue #%d: %s\n", $number, $title;
  29. my $mail_body = sprintf "see %s\n\n%s\n", $issue_url, $issue_body;
  30.  
  31. send_mail(SENDTO, $subject, $mail_body);
  32. print "  mail sent.\n";

handle_pull_request.pl

  1. #!/usr/bin/perl -I.
  2. use warnings;
  3. use strict;
  4.  
  5. use WebHookLib;
  6.  
  7. use constant SENDTO => 'gbsplay-dev@lists.uguu.de';
  8.  
  9. my $json = read_payload();
  10.  
  11. my $repository = $json->{repository}->{full_name};
  12. unless ($repository eq 'mmitch/gbsplay') {
  13.     print "  (R/$repository is ignored)\n";
  14.     exit;
  15. }
  16.  
  17. my $action = $json->{action};
  18. unless ($action eq 'opened') {
  19.     print "  (A/$action is ignored)\n";
  20.     exit;
  21. }
  22.  
  23. my $number = $json->{pull_request}->{number};
  24. my $title = $json->{pull_request}->{title};
  25. my $pr_url = $json->{pull_request}->{html_url};
  26. my $pr_body = crlf($json->{pull_request}->{body});
  27.  
  28. my $subject = sprintf "new pull request #%d: %s\n", $number, $title;
  29. my $mail_body = sprintf "see %s\n\n%s\n", $pr_url, $pr_body;
  30.  
  31. send_mail(SENDTO, $subject, $mail_body);
  32. print "  mail sent.\n";

Codereview

  1. Hilfsmethoden laden über -I. und use WebHookLib;
  2. Payload nach $json einlesen
  3. das betroffene Repository prüfen – falls es nicht mmitch/gbsplay ist, loggen wir das als Begründung und brechen ab
  4. die gemeldete Action prüfen – falls sie nicht opened ist, loggen wir das als Begründung und brechen ab
  5. Nummer, Titel, URL und Beschreibung des Items besorgen (bei der Beschreibung die Umwandlung der Zeilenumbrüche nicht vergessen)
  6. Betreffzeile der Mail aus Nummer und Titel zusammenbauen
  7. Body der Mail aus URL und Beschreibung zusammenbauen
  8. Mail verschicken
  9. Logzeile schreiben
  10. fertig

Ähnlichkeit

Beide Skripte unterscheiden sich nur in insgesamt 5 Zeilen:

  • 3× issue vs. pull_request in der JSON-Struktur
  • 2× Variablenname $issue_… vs. $pr_… (meine Schuld ;-)
  • "issue" vs. "pull request" im Betreff der verschickten Mail

Man könnte die Skripte zusammenführen, aber ich will ja kleine, einzeln austauschbare Einheiten. Mit 32 Zeilen ist jedes Skript total simpel. Wenn ich beide verheirate, lande ich bei vermutlich 40 Zeilen, die aber zusätzliche Fallunterscheidungen usw. haben – das wird unnötig kompliziert. Außerdem will ich ja die Möglichkeit haben, ein einzelnes Skript wegzuwerfen und (ggf. in einer anderen Programmiersprache) neu zu implementieren.

Einzig wenn jetzt ein Bug auftritt, dann muss ich ihn zweimal fixen. Das halte ich für vertretbar. Kein nicht-triviales Programm ist bugfrei, aber diese beiden Skripte gehen schon stark in Richtung trivial…

Geschrieben von in Hacken, Internet um 20:15 | Kommentar (1) | Trackbacks (2)
◀ f r t ▶
Trackbacks
Trackback-URL für diesen Eintrag

Renee B am : Renee B via Twitter

RT @master_mitch: blog update: #GitHub Webhooks: Eventhandler für Issues und Pull-Requests https://t.co/HqopeN7656 #Webhook #perl #issue

Netz - Rettung - Recht am : Wellenreiten 02/2019

Wer als "Websurfer" metaphorisch auf den Wellen des Netzes reitet, findet dabei zwar keine paradiesischen Inseln, manchmal aber immerhin ganz interessante Lektüre. Im Februar 2019 kann ich u.a. folgende Fundstücke empfehlen und der werten Leserschaft ans
Kommentare
Kommentare dieses Artikels abonnieren (als RSS)
Ansicht der Kommentare: (Linear | Verschachtelt)

mitch am um :

Upps, da waren zwei Fehler, die habe ich jetzt korrigiert:

1. $number wird nicht mit $json->{number} befüllt, sondern mit $json->{issue}->{number} bzw. $json->{pull_request}->{number}
2. $subject braucht vorne kein "Subject: " im String, das ergänzt send_mail() schon selber
Kommentar schreiben
Um über Antworten auf Deinen Kommentar informiert zu werden, abonniere bitte entweder den Kommentarfeed des ganzen Blogs oder den dieses Eintrages.