Welche Berechtigungen benötigt eine GitHub App, um Pull Requests zu verwalten?
- Einleitung
- Berechtigungen der GitHub App im Kontext von Pull Requests
- Berechtigung Pull requests
- Zusätzliche Berechtigung Issues
- Berechtigung Repository contents
- Zusätzliche Zugriffsrechte und Webhook Events
- Fazit
Einleitung
GitHub Apps sind spezialisierte Anwendungen, die mittels definierter Berechtigungen und Events innerhalb eines GitHub-Repositories agieren können. Um Pull Requests verwalten zu können, benötigt eine GitHub App spezifische Zugriffsrechte. Diese Berechtigungen steuern, welche Aktionen die App im Zusammenhang mit Pull Requests durchführen darf, beispielsweise das Erstellen, Bearbeiten, Kommentieren oder Zusammenführen von Pull Requests.
Berechtigungen der GitHub App im Kontext von Pull Requests
Grundsätzlich ist das Management von Pull Requests auf GitHub daran gebunden, dass eine App entsprechende Berechtigungen auf Repository- oder Organisationsebene hat. Die wichtigsten Berechtigungen betreffen dabei die Bereiche Pull requests, Issues sowie eventuell Repository contents, je nachdem welche Funktionen die App ausführen soll.
Berechtigung Pull requests
Um Pull Requests direkt zu verwalten, benötigt die GitHub App mindestens Leserechte auf die Pull requests, um Informationen abzurufen. Möchte die App Pull Requests erstellen, aktualisieren oder zusammenführen (mergen), sind Schreibberechtigungen erforderlich. Diese Berechtigung erlaubt es der App, Pull Requests zu kommentieren, Labels hinzufügen, Status oder Reviews zu setzen sowie Branches in Zusammenhang mit PRs zu aktualisieren.
Zusätzliche Berechtigung Issues
Pull Requests und Issues sind auf GitHub eng verknüpft. Häufig werden Kommentare, Labels oder Reaktionen sowohl auf Issues als auch auf Pull Requests angewendet. Wenn die App beispielsweise Kommentare zu einem Pull Request hinzufügen oder verwalten soll, kann die Berechtigung für Issues erforderlich sein, da GitHub Pull Requests technisch als Spezialform von Issues behandelt.
Berechtigung Repository contents
Wenn die GitHub App nicht nur Pull Requests verwalten, sondern auch Inhalte anpassen will, zum Beispiel durch das Erstellen von Commits auf Branches, die in Pull Requests verwendet werden, ist Zugriff auf die Repository contents notwendig. Dadurch kann die App Dateien lesen und schreiben, was für das automatische Aktualisieren oder Erzeugen von Pull Requests relevant ist.
Zusätzliche Zugriffsrechte und Webhook Events
Neben den Berechtigungen im klassischen Sinne sind auch Webhook Events wichtig, damit die GitHub App frühzeitig über Änderungen an Pull Requests informiert wird. So kann sie auf Ereignisse wie das Erstellen, Aktualisieren oder Schließen eines Pull Requests reagieren.
Fazit
Für eine GitHub App, die Pull Requests verwalten möchte, sind primär die Berechtigungen Pull requests mit Schreibzugriff notwendig, um sämtliche Aktionen wie Erstellen, Bearbeiten, Kommentieren und Zusammenführen durchzuführen. Ergänzend können Issues und Repository contents erforderlich sein, abhängig von den genauen Anforderungen der App. Zudem sollten passende Webhook Events aktiviert sein, damit die App auf PR-bezogene Ereignisse reagieren kann.