Informationen zum Schreiben von Code für eine GitHub-App

Voraussetzungen

Bevor du Code für eine GitHub App schreibst, musst du eine GitHub App registrieren. Beim Registrieren einer GitHub App wählst du Berechtigungen für die App aus. Diese Berechtigungen geben vor, welche Aktionen die GitHub App ausführen kann. Wenn du eine App registrierst, gibst du auch andere Einstellungen an, u. a. die Webhookereignisse, die deine GitHub App empfangen soll. Du kannst die Einstellungen für deine GitHub App-Registrierung jederzeit ändern. Weitere Informationen findest du unter Registrieren einer GitHub-App und Ändern einer GitHub-App-Registrierung.

Wenn deine GitHub App auf das Repository und/oder Organisationsdaten zugreifen soll, musst du deine GitHub App installieren. Weitere Informationen finden Sie unter Installieren einer eigenen GitHub-App.

Schreiben von Code für eine GitHub App

Damit deine GitHub App Aktionen ausführen kann, musst du Code schreiben, um deiner GitHub App Funktionen hinzuzufügen.

Tutorials zum Schreiben von Code für eine GitHub App findest du unter:

Du kannst die Anmeldeinformationen deiner GitHub App-Registrierung verwenden, um authentifizierte Anforderungen an die GitHub-APIs zu senden. Weitere Informationen finden Sie unter Informationen zur Authentifizierung mit einer GitHub-App.

Während der Entwicklung verwendest du wahrscheinlich deinen persönlichen Computer oder Codespace für die Ausführung deiner GitHub App. Möglicherweise musst du während der Entwicklung einige Änderungen an deiner GitHub App-Registrierung vornehmen:

Wenn deine App Webhooks empfängt, wird die Verwendung einer Webhook-Proxy-URL empfohlen, um Webhooks von GitHub an deinen Computer oder Codespace weiterzuleiten. Du musst die Einstellung „Webhook-URL“ in deiner GitHub App-Registrierung aktualisieren, um die Webhook-Proxy-URL zu verwenden. Ein Beispiel findest du unter Erstellen einer GitHub-App, die auf Webhookereignisse reagiert.
Wenn deine App den Webanwendungsflow zum Autorisieren von Benutzer*innen verwendet, solltest du die Einstellung „Rückruf-URL“ in deiner GitHub App-Registrierung aktualisieren, um eine lokale Rückruf-URL zu verwenden. Ein Beispiel findest du unter Erstellen der Schaltfläche „Mit GitHub anmelden“ mit einer GitHub-App.

Nächste Schritte

Nachdem du den Code für deine GitHub App geschrieben hast, musst du sicherstellen, dass er bewährten Methoden folgt. Denke daran, bei Bedarf die GitHub App-Registrierung zu aktualisieren. Wenn deine GitHub App auf einem Server statt auf dem Gerät eines Benutzers bzw. einer Benutzerin ausgeführt werden muss, stelle deine App auf deinem Server bereit. Abschließend kannst du deine GitHub App für andere Benutzer*innen und Organisationen freigeben.

Bewährte Methode befolgen

Bevor du deine GitHub App bereitstellst, musst du sicherstellen, dass die bewährten Methoden befolgt werden. Stelle beispielsweise sicher, dass die Anmeldeinformationen für deine GitHub App sicher sind. Weitere Informationen finden Sie unter Best Practices beim Erstellen einer GitHub-App.

Aktualisieren der GitHub App-Registrierung

Wenn du die GitHub App-Registrierung für die Entwicklung geändert hast, aktualisiere unbedingt die Registrierung so, dass produktionsbereite Werte verwendet werden. Wenn du beispielsweise eine Webhook-Proxy-URL für die Entwicklung verwendet hast, musst du das Feld „Webhook-URL“ aktualisieren, sodass die URL verwendet wird, unter der deine GitHub App während der Produktion Webhooks empfangen soll.

Bereitstellen deiner GitHub App

Nachdem du den Code für deine GitHub App geschrieben hast, muss dein Code irgendwo ausgeführt werden. Wenn es sich bei deiner App um eine Website oder Web-App handelt, kannst du deine App auf einem Server wie Azure App Service hosten. Wenn es sich bei deiner App um eine clientseitige App handelt, kann sie auf dem Gerät eines Benutzers bzw. einer Benutzerin ausgeführt werden.

Freigeben deiner GitHub App

Wenn du deine GitHub App für andere Benutzer*innen und Organisationen freigeben möchtest, musst du deine GitHub App öffentlich machen. Damit deine GitHub App leichter gefunden werden kann, kannst du sie im GitHub Marketplace veröffentlichen. Weitere Informationen findest du unter Freigeben deiner GitHub-App.