Veröffentlichen der API mit GitHub Actions

  • 3 Minuten

Sie haben die API Ihrer Web-App hinzugefügt, und beide werden lokal ausgeführt. Nun müssen Sie die API und die App in Azure Static Web Apps veröffentlichen.

Als Sie die Azure Static Web Apps-Instanz erstellt und für die Überwachung des main-Branch konfiguriert haben, wurde automatisch eine GitHub-Aktion generiert. Die GitHub-Aktion lauscht auf Commits und Pull Requests auf den main-Branch Ihres Repositorys. Wenn diese Änderungen von der GitHub-Aktion erkannt werden, wird die App erstellt und veröffentlicht.

Als Sie Ihre Azure Static Web Apps Ressource erstellt haben, haben Sie den Speicherort für Ihr API-Projekt angegeben, indem Sie den Standardwert Api übernommen haben. Azure Static Web Apps hat die Azure Functions-App in diesem Ordner erstellt und bereitgestellt. Die App funktionierte jedoch nicht, da die HTTP GET API noch nicht erstellt wurde.

Auslösen der GitHub-Aktion

Sobald die GitHub-Aktion eine Änderung des main-Branch erkennt, ist sie bereit, die Web-App und die API zu erstellen und zu veröffentlichen. Sie können entweder direkt einen Commit durchführen oder einen Pull Request für den main-Branch erstellen. In beiden Fällen wird die GitHub-Aktion auslöst. Wenn Änderungen im main-Branch erkannt werden, wird die GitHub-Aktion ausgelöst, und die App wird unter derselben URL wie die Livewebsite veröffentlicht.

Vorproduktionsumgebungen mit Vorschau-URLs

Gelegentlich möchten Sie Ihre Änderungen auf einer Stagingsite anzeigen, bevor Sie sie auf der Livewebsite veröffentlichen. Mit Azure Static Web Apps können Sie Ihre Änderungen in Vorproduktionsumgebungen sehen, die jeweils eine eigene Vorschau-URL haben. Sie können eine Vorproduktionsumgebung erstellen, indem Sie einen Pull Request für den Branch erstellen, den Ihre GitHub-Aktion überwacht. Ihre Livewebsite ist davon nicht betroffen. Stattdessen wird eine neue Version Ihrer App in einer eigenen Vorproduktionsumgebung erstellt. Wenn Sie zurück gehen und Ihren Pull Request auf GitHub überprüfen, stellen Sie fest, dass auf der Registerkarte „Unterhaltung“ ein Link zur Vorproduktionsversion angezeigt wird.

In der folgenden Tabelle wird veranschaulicht, wie Ihre App von Azure Static Web Apps unter verschiedenen URLs veröffentlicht wird. Ihre App wird unter einer URL veröffentlicht, während ein Pull Request desselben Branches unter einer anderen URL veröffentlicht wird. Diese automatisch generierten URLs werden von Azure Static Web Apps für die Produktions-App und Pull Requests bereitgestellt. Sie können der Produktions-App optional eine benutzerdefinierte Domäne zuweisen.

`Source` Beschreibung URL
main-Branch Beispiel-URL einer Livewebsite https://purple-rain-062d03304.azurestaticapps.net/
Pull Request #5 Beispiel-URL einer Vorschauseite https://purple-rain-062d03304-5.<location>.azurestaticapps.net/

Derzeit arbeiten Sie im Branch api. Sie senden einen Pull Request aus Ihrem api-Branch an den main-Branch. Wenn Sie den Pull Request für den main-Branch erstellen, veröffentlicht die GitHub-Aktion die App in einer Vorproduktionsumgebung.

Sobald die Workflow die Erstellung und Bereitstellung Ihrer App abgeschlossen hat, fügt der GitHub-Bot Ihrem Pull Request einen Kommentar hinzu. Dieser Kommentar enthält einen Link zur URL der Vorproduktionsumgebung. Sie können diesen Link auswählen, um Ihre gestageten Änderungen anzuzeigen.

Anschließend erstellen Sie einen Pull Request und besuchen die gestagete Version der App.