運用前環境で pull request を確認する

[アーティクル]
11/08/2023

この記事では、Azure Static Web Apps を使用してデプロイされたアプリケーションに対する変更を、運用前環境を使用して確認する方法を示します。運用前環境は、運用環境で使用できない変更を含む、完全に機能するステージングバージョンのアプリケーションです。

Note

プル要求環境は Azure DevOps では自動的にサポートされませんが、名前付き環境を使用して手動で設定できます。

Azure Static Web Apps によって、リポジトリに YAML ワークフローが生成されます。ワークフローによって監視されるブランチに対して pull request が作成されると、運用前環境がビルドされます。運用前環境ではアプリがステージされるため、運用環境にプッシュする前に変更を確認できます。実稼働前環境のライフサイクルは、プル要求に関連付けられます。 pull request が閉じられると、実稼働前環境が自動的に削除されます。

運用前環境内では、次のタスクを実行できます。

コンテンツやレイアウトの更新など、運用とステージングの間の視覚的な変更を確認する
自分のチームに変更内容をデモンストレーションする
異なるバージョンのアプリケーションを比較する
受け入れテストを使用して変更を検証する
運用環境にデプロイする前にサニティチェックを実行する

前提条件

Azure Static Web Apps を使用して構成された既存の GitHub リポジトリ。お持ちでない場合は、最初の静的アプリの構築に関する記事をご覧ください。

変更を加える

次の手順に示すように、GitHub でリポジトリを直接変更します。

GitHub でプロジェクトのリポジトリに移動し、[ブランチ] を選択します。
ブランチ名を入力し、[ブランチの作成] を選択します。
app フォルダーに移動して、タイトルや段落などのテキストの内容を一部変更します。 [編集] を選択してファイルを変更します。
完了したら、[変更のコミット] を選択します。

pull request を作成する

更新プログラムを発行する pull request を作成します。

GitHub でプロジェクトの [Pull request] タブを開きます。
[比較とプル要求] を選択 します。
必要に応じて、変更に関する詳細を入力し、[pull request の作成] を選択します。

必要に応じて、レビュー担当者を割り当てて、変更内容について説明するコメントを追加します。

Azure Static Web Apps を使用する場合は、複数の運用前環境を同時に共存させることができます。監視対象のブランチに対して pull request を作成するたびに、変更を含むステージングバージョンが個別の運用前環境にデプロイされます。

複数の変更を行って、ブランチに新しいコミットをプッシュすることができます。 pull request は自動的に更新され、すべての変更内容が反映されます。

変更の確認

GitHub Actions デプロイワークフローが実行され、pull request の変更が運用前環境にデプロイされます。

ワークフローでアプリのビルドとデプロイが完了すると、GitHub ボットによって、運用前環境の URL を含むコメントが pull request に追加されます。

運用前 URL を選択して、ステージされている変更を確認します。

URL は、https://<SUBDOMAIN-PULL_REQUEST_ID>.<AZURE_REGION>.azurestaticapps.net のように構成されます。指定された pull request の URL は、新しい更新をプッシュしても変わりません。同じ運用前環境も、pull request の有効期間中に再利用されます。

エンドツーエンドのテストでレビュープロセスを自動化するために、Azure Static Web Apps をデプロイするための GitHub アクションには static_web_app_url 出力変数があります。この URL は、ワークフローの残りの部分で参照して、運用前環境に対してテストを実行できます。

変更を公開する

pull request をマージして運用環境に発行します。

[Merge pull request](pull request をマージする) を選択します。

変更内容が追跡対象のブランチ ("運用" ブランチ) にコピーされます。その後、追跡対象のブランチでデプロイワークフローが開始され、アプリケーションがリビルドされた後に変更内容が反映されます。
運用 URL を開いて、Web サイトのライブバージョンを読み込み、確認します。

制限事項

GitHub リポジトリがプライベートであっても、すべてのユーザーが URL を使用してアプリケーションのステージングバージョンにアクセスできます。

警告

運用前環境には誰でもアクセスできるため、機密性の高い内容には注意してください。
Static Web Apps を使用してデプロイした各アプリ用に使用できる運用前環境の数は、使用しているホストプランによって異なります。たとえば、Free レベルでは、運用環境に加えて 3 つの運用前環境を使用できます。
運用前環境は地理的に分散されていません。
GitHub Actions デプロイのみが運用前環境をサポートしています。

次のステップ

ブランチプレビュー環境を作成する

次の方法で共有