Voraussetzungen
Bevor du Code für eine App schreibst, musst du eine App registrieren. Beim Registrieren einer App wählst du Berechtigungen für die App aus. Diese Berechtigungen geben vor, welche Aktionen die App ausführen kann. Wenn du eine App registrierst, gibst du auch andere Einstellungen an, u. a. die Webhookereignisse, die deine App empfangen soll. Du kannst die Einstellungen für deine App-Registrierung jederzeit ändern. Weitere Informationen findest du unter Registrieren einer -App und Ändern einer -App-Registrierung.
Wenn deine App auf das Repository und/oder Organisationsdaten zugreifen soll, musst du deine App installieren. Weitere Informationen finden Sie unter Installieren einer eigenen -App.
Schreiben von Code für eine App
Damit deine App Aktionen ausführen kann, musst du Code schreiben, um deiner App Funktionen hinzuzufügen.
Tutorials zum Schreiben von Code für eine App findest du unter:
- Schnellstartanleitung zum Erstellen von -Apps
- Erstellen einer -App, die auf Webhookereignisse reagiert
- Erstellen der Schaltfläche „Mit anmelden“ mit einer -App
- Erstellen einer CLI mit einer -App
Du kannst die Anmeldeinformationen deiner App-Registrierung verwenden, um authentifizierte Anforderungen an die -APIs zu senden. Weitere Informationen finden Sie unter Informationen zur Authentifizierung mit einer -App.
Während der Entwicklung verwendest du wahrscheinlich deinen persönlichen Computer oder Codespace für die Ausführung deiner App. Möglicherweise musst du während der Entwicklung einige Änderungen an deiner App-Registrierung vornehmen:
Wenn deine App Webhooks empfängt, wird die Verwendung einer Webhook-Proxy-URL empfohlen, um Webhooks von an deinen Computer oder Codespace weiterzuleiten. Du musst die Einstellung „Webhook-URL“ in deiner App-Registrierung aktualisieren, um die Webhook-Proxy-URL zu verwenden. Ein Beispiel findest du unter Erstellen einer -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 App-Registrierung aktualisieren, um eine lokale Rückruf-URL zu verwenden. Ein Beispiel findest du unter Erstellen der Schaltfläche „Mit anmelden“ mit einer -App.
Nächste Schritte
Nachdem du den Code für deine App geschrieben hast, musst du sicherstellen, dass er bewährten Methoden folgt. Denke daran, bei Bedarf die App-Registrierung zu aktualisieren. Wenn deine 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 App für andere Benutzer*innen und Organisationen freigeben.
Bewährte Methode befolgen
Bevor du deine App bereitstellst, musst du sicherstellen, dass die bewährten Methoden befolgt werden. Stelle beispielsweise sicher, dass die Anmeldeinformationen für deine App sicher sind. Weitere Informationen finden Sie unter Best Practices beim Erstellen einer -App.
Aktualisieren der App-Registrierung
Wenn du die 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 App während der Produktion Webhooks empfangen soll.
Bereitstellen deiner App
Nachdem du den Code für deine 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 App
Wenn du deine App für andere Benutzer*innen und Organisationen freigeben möchtest, musst du deine App öffentlich machen. Damit deine App leichter gefunden werden kann, kannst du sie im Marketplace veröffentlichen. Weitere Informationen findest du unter Freigeben deiner -App.