Publikování rozhraní API pomocí GitHub Actions

Dokončeno

Do své webové aplikace jste přidali rozhraní API a obě tyto komponenty běží místně. Teď nastal čas publikovat rozhraní API i aplikaci do Azure Static Web Apps.

Když jste vytvořili instanci Azure Static Web Apps a dali jí pokyn ke sledování větve main, vygenerovala se vám akce GitHubu. Akce GitHubu naslouchá změnám v hlavní větvi úložiště a když zjistí potvrzení nebo žádost o přijetí změn do hlavní větve, sestaví a publikuje vaši aplikaci.

Možná si pamatujete, že jste vytvořili prostředek Azure Static Web Apps, který jste zadali umístění složky pro vaše rozhraní API. Použili jste výchozí hodnotu api. Ale protože jste ve složce api rozhraní API ještě neměli, služba Azure Static Web Apps se nepokusila o jeho publikování.

Tady se ale všechno změní.

Konfigurace akce GitHubu

Váš soubor akce GitHubu je ve složce .github/workflows. V souboru je nastaveno umístění vaší webové aplikace, rozhraní API a artefaktů sestavení. Umístění, která jste zvolili při vytváření prostředku Azure Static Web Apps, se teď nacházejí v tomto souboru, jak je znázorněno tady:

app_location: 'angular-app' # App source code path
api_location: 'api' # Api source code path - optional
output_location: 'dist/angular-app' # Built app content directory - optional
app_location: 'react-app' # App source code path
api_location: 'api' # Api source code path - optional
output_location: 'build' # Built app content directory - optional
app_location: 'svelte-app' # App source code path
api_location: 'api' # Api source code path - optional
output_location: 'public' # Built app content directory - optional
app_location: 'vue-app' # App source code path
api_location: 'api' # Api source code path - optional
output_location: 'dist' # Built app content directory - optional

Položku api_location máte nastavenou na správnou hodnotu, takže odkazuje na rozhraní API ve složce api.

Aktivace akce GitHubu

Akce GitHubu je připravena začít sestavovat a publikovat webovou aplikaci a rozhraní API, jakmile zjistí změnu ve větvi main. Pokud chcete aktivovat akci GitHubu, můžete buď potvrdit přímo, nebo vytvořit žádost o přijetí změn do hlavní větve. Změny zjištěné v hlavní větvi aktivují akci GitHubu, aby se aplikace publikovala na stejné adrese URL vašeho živého webu.

Náhledové adresy URL

Někdy chcete vidět změny v přípravném webu před publikováním na živý web. Azure Static Web Apps umožňuje zobrazit náhled změn prostřednictvím adres URL ve verzi Preview. Náhledovou adresu URL si můžete vytvořit tak, že vytvoříte žádost o přijetí změn ve větvi, kterou sleduje vaše akce GitHubu. Na váš živý web to nemá vliv. Ale vznikne nová přípravná verze vaší aplikace. Pokud se vrátíte a zkontrolujete žádost o přijetí změn na GitHubu, měli byste vidět odkaz na přípravnou verzi publikovou na kartě Konverzace.

Následující tabulka ukazuje, jak Azure Static Web Apps publikuje vaši aplikaci na různé adresy URL. Vaše aplikace se publikuje na jednu adresu URL, zatímco žádost o přijetí změn do stejné větve se publikuje na jinou adresu URL.

Source Popis Adresa URL
větev main Adresa URL živého webu https://purple-rain-062d03304.azurestaticapps.net/
Žádost o přijetí změn č. 5 Náhledová adresa URL https://purple-rain-062d03304-5.azurestaticapps.net/

V tuto chvíli pracujete ve větvi api. Vytvořte žádost o přijetí změn z větve rozhraní API do hlavní větve. Když vytvoříte žádost o přijetí změn pro větev main, akce GitHubu tuto aplikaci publikuje na náhledovou adresu URL.

Jakmile pracovní postup dokončí sestavování a nasazování aplikace, robot GitHubu přidá do žádosti o přijetí změn komentář, který obsahuje adresu URL předprodukčního prostředí. Výběrem tohoto odkazu můžete zobrazit připravené změny.

Dále vytvoříte žádost o přijetí změn a navštívíte fázovanou verzi aplikace.