Voraussetzungen
Bevor Sie Code für ein GitHub App schreiben, sollten Sie ein GitHub App registrieren. Wenn Sie eine GitHub AppRegistrierung durchführen, wählen Sie Berechtigungen für die App aus. Diese Berechtigungen diktieren, was dies GitHub App tun kann. Wenn Sie eine App registrieren, geben Sie auch andere Einstellungen an, darunter auch, welche Webhook-Ereignisse Ihr GitHub App empfangen soll. Sie können die Einstellungen für Ihre GitHub App Registrierung jederzeit ändern. Weitere Informationen findest du unter Registrieren einer GitHub-App und Ändern einer GitHub App-Registrierung.
Wenn Ihr GitHub App auf Repository- und/oder Organisationsdaten zugreifen soll, müssen Sie Ihr GitHub App installieren. Weitere Informationen finden Sie unter Installieren Ihrer eigenen GitHub App.
Code für ein GitHub App schreiben
Damit Ihr GitHub App etwas tun kann, müssen Sie Code schreiben, um Ihrem GitHub App Funktionalität hinzuzufügen.
Anleitungen dazu, wie Sie Code für ein GitHub App schreiben, finden Sie unter:
- Schnellstart zum Erstellen von GitHub Apps
- Erstellen einer GitHub-App, die auf Webhook-Ereignisse reagiert
- Erstellen einer Schaltfläche "Anmelden mit GitHub" mit einer GitHub-App
- Erstellen einer CLI mit einer GitHub-App
Sie können die Zugangsdaten aus Ihrer Registrierung bei GitHub App verwenden, um authentifizierte Anfragen an die APIs von GitHub zu senden. Weitere Informationen finden Sie unter Informationen zur Authentifizierung mit einer GitHub-App.
Während der Entwicklung verwenden Sie wahrscheinlich Ihren eigenen Computer oder Codespace, um Ihre GitHub App auszuführen. Möglicherweise müssen Sie während der Entwicklung einige Änderungen an Ihrer GitHub App Registrierung vornehmen:
-
Wenn Ihre App Webhooks empfängt, können Sie eine Webhook-Proxy-URL verwenden, um Webhooks von GitHub an Ihren Computer oder Codespace weiterzuleiten. Sie müssen die Einstellung "Webhook-URL" in Ihrer GitHub App Registrierung aktualisieren, um Ihre Webhook-Proxy-URL zu verwenden. Ein Beispiel findest du unter Erstellen einer GitHub-App, die auf Webhook-Ereignisse reagiert.
-
Wenn Ihre App den Webanwendungsfluss verwendet, um einen Benutzer zu autorisieren, sollten Sie die Einstellung "Rückruf-URL" in Ihrer GitHub App Registrierung aktualisieren, um eine lokale Rückruf-URL zu verwenden. Ein Beispiel findest du unter Erstellen einer Schaltfläche "Anmelden mit GitHub" mit einer GitHub-App.
Nächste Schritte
Nachdem Sie den Code für Ihr GitHub App geschrieben haben, sollten Sie sicherstellen, dass er bewährten Verfahren folgt. Denken Sie bei Bedarf daran, Ihre GitHub App Registrierung zu aktualisieren. Wenn GitHub App auf einem Server statt auf dem Gerät eines Benutzers ausgeführt werden muss, stellen Sie Ihre App auf Ihrem Server bereit. Schließlich können Sie Ihr GitHub App mit anderen Benutzern und Organisationen teilen.
Bewährte Methode befolgen
Stellen Sie sicher, dass Sie bewährte Verfahren befolgen, bevor Sie Ihr GitHub App bereitstellen. Stellen Sie beispielsweise sicher, dass ihre GitHub AppAnmeldeinformationen sicher sind. Weitere Informationen finden Sie unter Bewährte Methoden zum Erstellen einer GitHub-App.
Aktualisieren Ihrer GitHub App Registrierung
Wenn Sie die Registrierung für die GitHub App Entwicklung geändert haben, stellen Sie sicher, dass Sie die Registrierung so aktualisieren, dass produktionsfähige Werte verwendet werden. Wenn Sie beispielsweise für die Entwicklung eine Webhook-Proxy-URL verwendet haben, sollten Sie das Feld „Webhook-URL“ auf die URL aktualisieren, unter der Ihr GitHub App Webhooks im Produktivbetrieb empfangen soll.
Stellen Sie Ihre GitHub App bereit
Sobald Sie den Code für Ihr GitHub App geschrieben haben, muss Ihr Code irgendwo ausgeführt werden. Wenn Ihre App eine Website oder Web-App ist, hosten Sie Ihre App möglicherweise auf einem Server wie Azure App Service. 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.
Teilen Sie Ihre GitHub App
Wenn Sie GitHub App für andere Benutzer und Organisationen freigeben möchten, sollten Sie GitHub App öffentlich machen. Um Ihre GitHub App leichter auffindbar zu machen, können Sie sie auf GitHub Marketplace auflisten. Weitere Informationen finden Sie unter Freigeben deiner GitHub-App.