Publier l’API avec GitHub Actions

Effectué

Vous avez ajouté votre API à votre application web, et les deux s’exécutent localement. À présent, il est temps de publier votre API et votre application dans Azure Static Web Apps.

Quand vous avez créé l’instance Azure Static Web Apps et que vous lui avez demandé de surveiller votre branche main, une action GitHub a été générée pour vous. L’action GitHub est à l’écoute des commits et des demandes de tirage sur la branche main de votre référentiel. Ensuite, lorsque l’action GitHub détecte ces modifications, elle génère et publie votre application.

Lorsque vous avez créé votre ressource Azure Static Web Apps, vous avez fourni l’emplacement du dossier de votre projet d’API en acceptant la valeur par défaut de l’API. Azure Static Web Apps a créé et déployé l’application Azure Functions dans ce dossier. Toutefois, l’application ne fonctionnait pas, car l’API HTTP GET n’avait pas encore été créée.

Déclencher l’action GitHub

L’action GitHub est prête à générer et à publier votre application web et votre API une fois qu’elle détecte une modification de votre branche main. Vous pouvez commiter directement ou créer une demande de tirage sur la branche main. Ces deux modifications déclenchent l’action GitHub. Lorsque des modifications sont détectées sur la branche main, cela déclenche l’action GitHub pour publier l’application à la même URL pour votre site web en ligne.

Environnements de préproduction avec des URL d’aperçu

Parfois, vous souhaitez voir vos modifications dans un site intermédiaire avant de les publier sur le site web en ligne. Azure Static Web Apps vous permet de voir vos modifications dans les environnements de préproduction qui ont chacun leur propre URL d’aperçu. Vous pouvez créer un environnement de préproduction en créant une demande de tirage sur la branche surveillée par votre action GitHub. Votre site web en ligne n’est pas affecté. Au lieu de cela, une version de votre application est créée dans son propre environnement de préproduction. Si vous revenez en arrière et vérifiez votre demande de tirage sur GitHub, vous remarquez qu’un lien vers la version de préproduction a été publié dans l’onglet Conversation.

Le tableau suivant montre comment Azure Static Web Apps publie votre application vers différentes URL. Votre application publie vers une URL, alors qu’une demande de tirage sur la même branche publie vers une autre URL. Ces URL générées automatiquement sont fournies par Azure Static Web Apps pour l’application de production et les demandes de tirage. Vous pouvez éventuellement affecter un domaine personnalisé à l’application de production.

Source Description URL
Branche main Exemple d’une URL de site web en ligne https://purple-rain-062d03304.azurestaticapps.net/
Demande de tirage (pull request) n° 5 Exemple d’une URL d’aperçu https://purple-rain-062d03304-5.<location>.azurestaticapps.net/

Vous travaillez actuellement dans la branche api. Vous effectuez une demande de tirage à partir de votre branche api à la branche main. Quand vous créez la demande de tirage sur la branche main, l’action GitHub publie l’application sur un environnement de préproduction.

Une fois que le workflow termine la création et le déploiement de votre application, le bot GitHub ajoute un commentaire à votre demande de tirage. Ce commentaire contient un lien vers l’URL de l’environnement de préproduction. Vous pouvez sélectionner ce lien pour afficher les changements indexés.

Ensuite, vous créez une demande de tirage et visiter la version intermédiaire de votre application.