Deploying Java to Azure App Service

Introduction

This guide explains how to use GitHub Actions to build and deploy a Java project to Azure App Service.

Prerequisites

Before creating your GitHub Actions workflow, you will first need to complete the following setup steps:

1. 创建 Azure 应用服务计划。

   例如，可以使用 Azure CLI 创建新的应用服务计划：

   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 替换为应用服务计划的新名称。

   有关使用 Azure CLI 的详细信息，请参阅 Azure 文档：

   • 有关身份验证，请参阅“使用 Azure CLI 登录”。
   • 如果需要创建新的资源组，请参阅“az group”。

2. Create a web app.

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

   Shell

   az webapp create \
       --name MY_WEBAPP_NAME \
       --plan MY_APP_SERVICE_PLAN \
       --resource-group MY_RESOURCE_GROUP \
       --runtime "JAVA|11-java11"

   In the command above, replace the parameters with your own values, where MY_WEBAPP_NAME is a new name for the web app.

3. 配置 Azure 发布配置文件并创建 AZURE_WEBAPP_PUBLISH_PROFILE 机密。

   使用发布配置文件生成 Azure 部署凭据。 有关详细信息，请参阅 Azure 文档中的“生成部署凭据”。

   在 GitHub 存储库中，创建一个名为 AZURE_WEBAPP_PUBLISH_PROFILE 的机密，其中包含发布配置文件的内容。 要详细了解如何创建机密，请参阅“� 密的机密”。

4. Optionally, configure a deployment environment. 环境用于描述常规部署目� �，例如 production、staging 或 development。 当 GitHub Actions 工作流部署到某个环境时，该环境将显示在存储库的主页上。 � 可以使用环境来要求批准才能继续作业，限制哪些分支可以触发工作流，或限制对机密的访问。 有关创建环境的详细信息，请参阅“使用环境进行部署”。

Creating the workflow

Once you've completed the prerequisites, you can proceed with creating the workflow.

The following example workflow demonstrates how to build and deploy a Java 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 you want to use a Java version other than 11, change JAVA_VERSION.

如果配置了部署环境，请将 environment 的值更改为环境的名称。 如果未配置环境 ，请� 除 environment 密钥。

# 此工作流使用未经 GitHub 认证的操作。
# 它们由第三方提供，并受
# 单独的服务条款、隐私政策和支持
# 文档。

# GitHub 建议将操作固定到提交 SHA。
# 若要获取较新版本，需要更新 SHA。
# 还可以引用� �记或分支，但该操作可能会更改而不发出警告。

name: Build and deploy JAR app to Azure Web App

env:
  AZURE_WEBAPP_NAME: MY_WEBAPP_NAME   # set this to your application's name
  JAVA_VERSION: '11'                  # set this to the Java version to use

on:
  push:
    branches:
      - main

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v2

      - name: Set up Java version
        uses: actions/setup-java@v2
        with:
          java-version: ${{ env.JAVA_VERSION }}
          cache: 'maven'

      - name: Build with Maven
        run: mvn clean install

      - name: Upload artifact for deployment job
        uses: actions/upload-artifact@v2
        with:
          name: java-app
          path: '${{ github.workspace }}/target/*.jar'

  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: java-app

      - name: Deploy to Azure Web App
        id: deploy-to-webapp
        uses: azure/webapps-deploy@0b651ed7546ecfc75024011f76944cb9b381ef1e
        with:
          app-name: ${{ env.AZURE_WEBAPP_NAME }}
          publish-profile: ${{ secrets.AZURE_WEBAPP_PUBLISH_PROFILE }}
          package: '*.jar'

Additional resources

The following resources may also be useful:

• For the original starter workflow, see azure-webapps-java-jar.yml in the GitHub 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.