注: GitHub ホステッド ランナーは、現在 GitHub Enterprise Server でサポートされていません。 GitHub public roadmap で、今後の計画的なサポートの詳細を確認できます。
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:
-
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」を参照してく� さい。
-
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. -
Azure 発行プロファイルを構成し、
AZURE_WEBAPP_PUBLISH_PROFILE
シークレットを作成します。公開されたプロフィールを使って、Azureのデプロイ資� �情� �を生成してく� さい。 詳細については、Azure ドキュメントの「デプロイ資� �情� �の生成」を参照してく� さい。
GitHub リポジトリで、発行プロファイルの内容を含む
AZURE_WEBAPP_PUBLISH_PROFILE
という名前のシークレットを作成してく� さい。 シークレットの作成の詳細については、「暗号化されたシークレット」を参照してく� さい。 -
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 Actionsstarter-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.