Deploying Node.js to Azure App Service

はじめに

This guide explains how to use GitHub Actions to build, test, and deploy a Node.js project to Azure App Service.

必要な環境

GitHub Actionsワークフローを作成する前に、まず以下のセットアップのステップを完了しておかなければなりません。

1. 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 Resource Groupに、MY_APP_SERVICE_PLANはApp Serviceプランの新しい名前に置き換えてく� さい。

   Azure CLIの使いからに関する詳しい情� �については、Azureのドキュメンテーションを参照してく� さい。

   • For authentication, see "Sign in with Azure CLI."
   • 新しいリソースグループを作成しなければならない� �合は、「az group」を参照してく� さい。

2. Webアプリケーションの作成

   For example, you can use the Azure CLI to create an Azure App Service web app with a Node.js runtime:

   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アプリケーションの新しい名前です。

3. Azure公開プロフィールを設定して、AZURE_WEBAPP_PUBLISH_PROFILEシークレットを作成してく� さい。

   公開されたプロフィールを使って、Azureのデプロイ資� �情� �を生成してく� さい。 For more information, see "Generate deployment credentials" in the Azure documentation.

   GitHubリポジトリで、公開されたプロフィールの内容を含むAZURE_WEBAPP_PUBLISH_PROFILEという名前のシークレットを生成してく� さい。 シークレットの作成に関する詳しい情� �については「暗号化されたシークレット」を参照してく� さい。

4. Optionally, configure a deployment environment. Environments are used to describe a general deployment target like production, staging, or development. When a GitHub Actions workflow deploys to an environment, the environment is displayed on the main page of the repository. You can use environments to require approval for a job to proceed, restrict which branches can trigger a workflow, or limit access to secrets. For more information about creating environments, see "Using environments for deployment."

ワークフローの作成

必要な環境を整えたら、ワークフローの作成に進むことができます。

The following example workflow demonstrates how to build, test, and deploy the Node.js project to Azure App Service when there is a push to the main branch.

ワークフローのenvキー中のAZURE_WEBAPP_NAMEを、作成したWebアプリケーションの名前に設定してく� さい。 If the path to your project is not the repository root, change AZURE_WEBAPP_PACKAGE_PATH to your project path. If you use a version of Node.js other than 10.x, change NODE_VERSION to the version that you use.

If you configured a deployment environment, change the value of environment to be the name of your environment. If you did not configure an environment, delete the environment key.

# このワークフローはGitHubによって認定されていないアクションを使用します。
# それらはサードパーティによって提供され、
# 別個の利用規約、プライバシーポリシー、
# サポートドキュメンテーションが適用されます。

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アクションです。
• For more examples of GitHub Action workflows that deploy to Azure, see the actions-workflow-samples repository.
• The "Create a Node.js web app in Azure" quickstart in the Azure web app documentation demonstrates using Visual Studio Code with the Azure App Service extension.