注: GitHub ホステッド ランナーは、現在 GitHub Enterprise Server でサポートされていません。 GitHub public roadmap で、今後の計画的なサポートの詳細を確認できます。
はじめに
このガイドでは、GitHub Actions を使用して、Node.js プロジェクトを作成、テスト、および Azure App Service にデプロイする方法について説明します。
前提条件
GitHub Actionsワークフローを作成する前に、まず以下のセットアップのステップを完了しておかなければなりません。
-
Azure App Service プランを作成する。
たとえば、Azure CLIを使って新しいApp Serviceのプランを作成できます。
Shell az appservice plan create \ --resource-group MY_RESOURCE_GROUP \ --name MY_APP_SERVICE_PLAN \ --is-linux上記のコマンドでは、
MY_RESOURCE_GROUPを既存の Azure リソース グループに、MY_APP_SERVICE_PLANを App Service プランの新しい名前に置き換えます。Azure CLI の使用に関する詳細については、Azure のドキュメントを参照してく� さい。
- 認証については、「Azure CLI を使用してサインインする」を参照してく� さい。
- 新しいリソース グループを作成する必要がある� �合は、「az group」を参照してく� さい。
-
Web アプリを作成する。
たとえば、Azure CLI を使用すると、Node.js ランタイ� を持つ Azure App Service Web アプリを作成することができます。
Shell az webapp create \ --name MY_WEBAPP_NAME \ --plan MY_APP_SERVICE_PLAN \ --resource-group MY_RESOURCE_GROUP \ --runtime "NODE|14-lts"上のコマンドで、パラメーターを独自の値に置き換えます。
MY_WEBAPP_NAMEは、その Web アプリの新しい名前です。 -
Azure 発行プロファイルを構成し、
AZURE_WEBAPP_PUBLISH_PROFILEシークレットを作成します。公開されたプロフィールを使って、Azureのデプロイ資� �情� �を生成してく� さい。 詳細については、Azure ドキュメントの「デプロイ資� �情� �の生成」を参照してく� さい。
GitHub リポジトリで、発行プロファイルの内容を含む
AZURE_WEBAPP_PUBLISH_PROFILEという名前のシークレットを作成してく� さい。 シークレットの作成の詳細については、「暗号化されたシークレット」を参照してく� さい。 -
必要に応じて、デプロイ環境を構成します。 環境は、一般的なデプロイ ターゲットを記述するために使用されます (例:
production、staging、またはdevelopment)。 GitHub Actions ワークフローが環境にデプロイされると、その環境がリポジトリのメイン ページに表示されます。 環境を使用して、ジョブの続行に対する承認の要求、ワークフローをトリガーできるブランチの制限、シークレットへのアクセスの制限を実行できます。 環境の作成の詳細については、「デプロイに環境を使用する」を参照してく� さい。
ワークフローの作成
必要な環境を整えたら、ワークフローの作成に進むことができます。
次のワークフローの例では、main ブランチへのプッシュがある� �合に、Node.js プロジェクトを作成し、Azure App Service にデプロイする方法のデモを行います。
ワークフロー env キーの AZURE_WEBAPP_NAME は、必ず作成した Web アプリの名前に設定してく� さい。 プロジェクトへのパスがリポジトリ ルートでない� �合は、AZURE_WEBAPP_PACKAGE_PATH をプロジェクト パスに変更します。 10.x 以外の Node.js のバージョンを使用する� �合、NODE_VERSION は、使用するバージョンに変更します。
デプロイ環境を構成した� �合は、environment の値を環境の名前に変更します。 環境を構成しなかった� �合 を使わない� �合は、environment キーを削除します。
# このワークフローはGitHubによって認定されていないアクションを使用します。
# それらはサードパーティによって提供され、
# 別個の利用規約、プライバシーポリシー、
# ドキュメントを参照してく� さい。
# GitHub では、コミット SHA にアクションをピン留めすることが推奨されます。
# 新しいバージョンを取得するには、SHA を更新する必要があります。
# タグまたはブランチを参照することもできますが、アクションは警告なしに変更される可能性があります。
on:
push:
branches:
- main
env:
AZURE_WEBAPP_NAME: MY_WEBAPP_NAME # set this to your application's name
AZURE_WEBAPP_PACKAGE_PATH: '.' # set this to the path to your web app project, defaults to the repository root
NODE_VERSION: '14.x' # set this to the node version to use
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Set up Node.js
uses: actions/setup-node@v2
with:
node-version: ${{ env.NODE_VERSION }}
cache: 'npm'
- name: npm install, build, and test
run: |
npm install
npm run build --if-present
npm run test --if-present
- name: Upload artifact for deployment job
uses: actions/upload-artifact@v2
with:
name: node-app
path: .
deploy:
runs-on: ubuntu-latest
needs: build
environment:
name: 'production'
url: ${{ steps.deploy-to-webapp.outputs.webapp-url }}
steps:
- name: Download artifact from build job
uses: actions/download-artifact@v2
with:
name: node-app
- name: 'Deploy to Azure WebApp'
id: deploy-to-webapp
uses: azure/webapps-deploy@0b651ed7546ecfc75024011f76944cb9b381ef1e
with:
app-name: ${{ env.AZURE_WEBAPP_NAME }}
publish-profile: ${{ secrets.AZURE_WEBAPP_PUBLISH_PROFILE }}
package: ${{ env.AZURE_WEBAPP_PACKAGE_PATH }}その他のリソース
以下のリソースも役に立つでしょう。
- もともとのスターター ワークフローについては、GitHub Actions
starter-workflowsリポジトリのazure-webapps-node.ymlを参照してく� さい。 - Web アプリのデプロイに使用されるアクションは、Azure の公式な
Azure/webapps-deployアクションです。 - Azure にデプロイする GitHub アクション ワークフローの例が他にも必要であれば、actions-workflow-samples リポジトリを参照してく� さい。
- Azure Web アプリ ドキュメントの「Azure で Node.js Web アプリを作成する」では、Azure App Service 拡張機能で Visual Studio Code を使用する方法のデモを行います。