title | intro | redirect_from | versions | type | topics | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Deploying Node.js to Azure App Service | You can deploy your Node.js project to Azure App Service as part of your continuous deployment (CD) workflows. |
|
| tutorial |
|
{% data reusables.actions.enterprise-github-hosted-runners %}
This guide explains how to use {% data variables.product.prodname_actions %} to build, test, and deploy a Node.js project to Azure App Service.
Note
{% data reusables.actions.about-oidc-short-overview %} and AUTOTITLE.
Before creating your {% data variables.product.prodname_actions %} workflow, you will first need to complete the following setup steps:
{% data reusables.actions.create-azure-app-plan %}
Create a web app.
For example, you can use the Azure CLI to create an Azure App Service web app with a Node.js runtime:
az webapp create \ --name MY_WEBAPP_NAME \ --plan MY_APP_SERVICE_PLAN \ --resource-group MY_RESOURCE_GROUP \ --runtime "NODE|14-lts"
In the command above, replace the parameters with your own values, where
MY_WEBAPP_NAME
is a new name for the web app.
{% data reusables.actions.create-azure-publish-profile %}
- Optionally, configure a deployment environment. {% data reusables.actions.about-environments %}
Once you've completed the prerequisites, you can proceed with creating the workflow.
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.
Ensure that you set AZURE_WEBAPP_NAME
in the workflow env
key to the name of the web app you created. 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.
{% data reusables.actions.delete-env-key %}
{% data reusables.actions.actions-not-certified-by-github-comment %}{% data reusables.actions.actions-use-sha-pinning-comment %}on: push: branches: - mainenv: AZURE_WEBAPP_NAME: MY_WEBAPP_NAME # set this to your application's nameAZURE_WEBAPP_PACKAGE_PATH: '.'# set this to the path to your web app project, defaults to the repository rootNODE_VERSION: '14.x'# set this to the node version to usejobs: build: runs-on: ubuntu-lateststeps: - uses: {% data reusables.actions.action-checkout %} - name: Set up Node.jsuses: {% data reusables.actions.action-setup-node %}with: node-version: {% raw %}${{ env.NODE_VERSION }}{% endraw %}cache: 'npm' - name: npm install, build, and testrun: | npm install npm run build --if-present npm run test --if-present - name: Upload artifact for deployment jobuses: {% data reusables.actions.action-upload-artifact %}with: name: node-apppath: .deploy: runs-on: ubuntu-latestneeds: buildenvironment: name: 'production'url: {% raw %}${{ steps.deploy-to-webapp.outputs.webapp-url }}{% endraw %}steps: - name: Download artifact from build jobuses: {% data reusables.actions.action-download-artifact %}with: name: node-app - name: 'Deploy to Azure WebApp'id: deploy-to-webappuses: azure/webapps-deploy@85270a1854658d167ab239bce43949edb336fa7cwith: app-name: {% raw %}${{ env.AZURE_WEBAPP_NAME }}{% endraw %}publish-profile: {% raw %}${{ secrets.AZURE_WEBAPP_PUBLISH_PROFILE }}{% endraw %}package: {% raw %}${{ env.AZURE_WEBAPP_PACKAGE_PATH }}{% endraw %}
The following resources may also be useful:
- For the original workflow template, see
azure-webapps-node.yml
in the {% data variables.product.prodname_actions %}starter-workflows
repository. - The action used to deploy the web app is the official Azure
Azure/webapps-deploy
action. - 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 {% data variables.product.prodname_vscode %} with the Azure App Service extension.