GitHub Action for deploying to Azure Spring Apps

GitHub Actions support an automated software development lifecycle workflow. With GitHub Actions for Azure Spring Apps you can create workflows in your repository to manage your deployment of Azure Spring Apps conveniently.

Prerequisites

Set up GitHub repository and authenticate

You need an Azure service principal credential to authorize Azure login action. To get an Azure credential, execute the following commands on your local machine:

az login
az ad sp create-for-rbac --role contributor --scopes /subscriptions/<SUBSCRIPTION_ID> --sdk-auth

To access to a specific resource group, you can reduce the scope:

az ad sp create-for-rbac --role contributor --scopes /subscriptions/<SUBSCRIPTION_ID>/resourceGroups/<RESOURCE_GROUP> --sdk-auth

The command should output a JSON object:

{
  "clientId": "<GUID>",
  "clientSecret": "<GUID>",
  "subscriptionId": "<GUID>",
  "tenantId": "<GUID>",
  ...
}

Dependencies on other GitHub Actions

• Checkout Checkout your Git repository content into GitHub Actions agent.
• Authenticate using the Azure Login Action with the Azure service principal credential prepared as mentioned above. Examples are given later in this article.

End-to-End Sample Workflows

Deploying

To production

Azure Spring Apps supports deploying to deployments with built artifacts (e.g., JAR or .NET Core ZIP) or source code archive. The following example deploys to the default production deployment in Azure Spring Apps using JAR file built by Maven. This is the only possible deployment scenario when using the Basic SKU:

name: AzureSpringApps
on: push
env:
  ASC_PACKAGE_PATH: ${{ github.workspace }}
  AZURE_SUBSCRIPTION: <azure subscription id>

jobs:
  deploy_to_production:
    runs-on: ubuntu-latest
    name: deploy to production with artifact
    steps:
      - name: Checkout Github Action
        uses: actions/checkout@v2
        
      - name: Set up JDK 1.8
        uses: actions/setup-java@v1
        with:
          java-version: 1.8

      - name: maven build, clean
        run: |
          mvn clean package

      - name: Login via Azure CLI
        uses: azure/login@v1
        with:
          creds: ${{ secrets.AZURE_CREDENTIALS }}

      - name: deploy to production with artifact
        uses: azure/spring-apps-deploy@v1
        with:
          azure-subscription: ${{ env.AZURE_SUBSCRIPTION }}
          action: Deploy
          service-name: <service instance name>
          app-name: <app name>
          use-staging-deployment: false
          package: ${{ env.ASC_PACKAGE_PATH }}/**/*.jar

The following example deploys to the default production deployment in Azure Spring Apps using source code.

name: AzureSpringApps
on: push
env:
  ASC_PACKAGE_PATH: ${{ github.workspace }}
  AZURE_SUBSCRIPTION: <azure subscription id>

jobs:
  deploy_to_production:
    runs-on: ubuntu-latest
    name: deploy to production with soruce code
    steps:
      - name: Checkout Github Action
        uses: actions/checkout@v2

      - name: Login via Azure CLI
        uses: azure/login@v1
        with:
          creds: ${{ secrets.AZURE_CREDENTIALS }}

      - name: deploy to production step with soruce code
        uses: azure/spring-apps-deploy@v1
        with:
          azure-subscription: ${{ env.AZURE_SUBSCRIPTION }}
          action: deploy
          service-name: <service instance name>
          app-name: <app name>
          use-staging-deployment: false
          package: ${{ env.ASC_PACKAGE_PATH }}

Blue-green

The following examples deploy to an existing staging deployment. This deployment will not receive production traffic until it is set as a production deployment. You can set use-staging-deployment true to find the staging deployment automatically or just allocate specific deployment-name. We will only focus on the spring-apps-deploy action and leave out the preparatory jobs in the rest of the article.

# environment preparation configurations omitted
    steps:
      - name: blue green deploy step use-staging-deployment
        uses: azure/spring-apps-deploy@v1
        with:
          azure-subscription: ${{ env.AZURE_SUBSCRIPTION }}
          action: deploy
          service-name: <service instance name>
          app-name: <app name>
          use-staging-deployment: true
          package: ${{ env.ASC_PACKAGE_PATH }}/**/*.jar

# environment preparation configurations omitted
    steps:
      - name: blue green deploy step with deployment-name
        uses: azure/spring-apps-deploy@v1
        with:
          azure-subscription: ${{ env.AZURE_SUBSCRIPTION }}
          action: deploy
          service-name: <service instance name>
          app-name: <app name>
          deployment-name: staging
          package: ${{ env.ASC_PACKAGE_PATH }}/**/*.jar

For more information on blue-green deployments, including an alternative approach, see Blue-green deployment strategies.

Creating new deployment

The following example shows how to create a new staing deployment. CPU and memory can be allocated when creating new deployment.

# environment preparation configurations omitted
    steps:
      - name: blue green deploy step with deployment-name
        uses: azure/spring-apps-deploy@v1
        with:
          azure-subscription: ${{ env.AZURE_SUBSCRIPTION }}
          action: deploy
          service-name: <service instance name>
          app-name: <app name>
          create-new-deployment: true
          deployment-name: staging
          cpu: <cpu>
          memory: <memory>
          package: ${{ env.ASC_PACKAGE_PATH }}/**/*.jar

Custom container image support

To deploy directly from a existing container image, use the following template.

# environment preparation configurations omitted
    steps:
      - name: Deploy custom container image
        uses: Azure/spring-apps-deploy@v1
        with:
          azure-subscription: ${{ env.AZURE_SUBSCRIPTION }}
          action: deploy
          service-name: <service instance name>
          app-name: <app name>
          deployment-name: <deployment name>
          container-registry: <container registry>
          registry-username: <registry username>
          registry-password: <registry password>
          container-image: <container image>

Setting production deployment

The following example will set the current staging deployment as production, effectively swapping which deployment will receive production traffic.

# environment preparation configurations omitted
    steps:
      - name: set production deployment step
        uses: azure/spring-apps-deploy@v1
        with:
          azure-subscription: ${{ env.AZURE_SUBSCRIPTION }}
          action: set-production
          service-name: <service instance name>
          app-name: <app name>
          use-staging-deployment: true

Deleting a staging deployment

The "Delete Staging Deployment" action allows you to delete the deployment not receiving production traffic. This frees up resources used by that deployment and makes room for a new staging deployment:

# environment preparation configurations omitted
    steps:
      - name: Delete staging deployment step
        uses: azure/spring-apps-deploy@v1
        with:
          azure-subscription: ${{ env.AZURE_SUBSCRIPTION }}
          action: delete-staging-deployment
          service-name: <service instance name>
          app-name: <app name>

Create or update build

The following example will create or update an build resource.

# environment preparation configurations omitted
    steps:
      - name: Create or update build
        uses: azure/spring-apps-deploy@v1
        with:
          azure-subscription: ${{ env.AZURE_SUBSCRIPTION }}
          action: build
          service-name: <service instance name>
          build-name: <build name>
          package: ${{ env.ASC_PACKAGE_PATH }}
          builder: <builder>

Delete build

The following example will delete an build resource.

# environment preparation configurations omitted
    steps:
      - name: Delete build
        uses: azure/spring-apps-deploy@v1
        with:
          azure-subscription: ${{ env.AZURE_SUBSCRIPTION }}
          action: delete-build
          service-name: <service instance name>
          build-name: <build name>

Arguments

Note

Some arguments are only applicable for certain settings of the action argument. The Action column below specifies the pertinent actions for each argument. Any argument listed as Required is only required for the pertinent Action(s).

Argument	Action	Required	Description
action	all	Required	The action to be performed by this task. One of: deploy, set-production, delete-staging-deployment, build, delete-build Default value: deploy
azure-subscription	all	Required	The Azure subscription ID for the target Azure Spring Apps instance.
service-name	all	Required	The name of the Azure Spring Apps service instance.
app-name	deploy set-production delete-staging-deployment	Optional	The name of the Azure Spring Apps app to deploy. The app must exist prior to task execution.
use-staging-deployment	deploy set-production	Optional	If set to true, apply the task to whichever deployment is set as the staging deployment at time of execution. If set to false, apply the task to the production deployment. Default value: true
deployment-name	deploy set-production	Optional	The name of the deployment to which the action will apply. It overrides the setting of use-staging-deployment.
create-new-deployment	deploy	Optional	If set to true and the deployment specified by deployment-name does not exist at execution time, it will be created. Default value: false
package	deploy build	Required	The file path to the package containing the application to be deployed (.jar file for Java, .zip for .NET Core) or to a folder containing the application source to be built. Default value: ${{ github.workspace }}/**/*.jar
target-module	deploy	Optional	Child module to be deployed, required for multiple jar packages built from source code.
cpu	deploy	Optional	The CPU resource quantity. It should be 500m or number of CPU cores. It is effective only when creating new deployment. Default value: 1
memory	deploy	Optional	The memory resource quantity. It should be 512Mi or #Gi, e.g., 1Gi, 3Gi. It is effective only when creating new deployment. Default value: 1Gi
runtime-version	deploy	Optional	The runtime stack for the application. One of: Java_8, Java_11, NetCore_31, Default value: Java_11
environment-variables	deploy	Optional	Environment variables to be entered using the syntax '-key value'. Values containing spaces should be enclosed in double quotes. Example: -CUSTOMER_NAME Contoso -WEBSITE_TIME_ZONE "Eastern Standard Time"
jvm-options	deploy	Optional	A string containing JVM Options. Example: -Dspring.profiles.active=mysql
dotnetcore-mainentry-path	deploy	Optional	A string containing the path to the .NET executable relative to zip root.
version	deploy	Optional	The deployment version. If not set, the version is left unchanged.
build-name	build delete-build	Optional	(Enterprise Tier Only) The build name.
builder	deploy build	Optional	(Enterprise Tier Only) Build service builder used to build the executable.
build-cpu	deploy build	Optional	(Enterprise Tier Only) CPU resource quantity for build container. Should be 500m or number of CPU cores. Default: 1
build-memory	deploy build	Optional	(Enterprise Tier Only) Memory resource quantity for build container. Should be 512Mi or #Gi, e.g., 1Gi, 3Gi. Default: 2Gi.
build-env	deploy build	Optional	(Enterprise Tier Only) Space-separated environment variables for the build process using the syntax '-key value'. Example: -CUSTOMER_NAME Contoso -WEBSITE_TIME_ZONE "Eastern Standard Time"
config-file-patterns	deploy	Optional	(Enterprise Tier Only) Config file patterns separated with ',' to decide which patterns of Application Configuration Service will be used. Use '""' to clear existing configurations.
container-registry	deploy	Optional	The registry of the container image. Default value: docker.io
registry-username	deploy	Optional	The username of the container registry.
registry-password	deploy	Optional	The password of the container registry.
container-image	deploy	Optional	The container image.
container-command	deploy	Optional	The command of the container.
container-args	deploy	Optional	The arguments of the container.
language-framework	deploy	Optional	The language framework of the container.
enable-liveness-probe	deploy	Optional	If false, will disable the liveness probe of the app instance. Allowed values: false, true.
enable-readiness-probe	deploy	Optional	If false, will disable the readiness probe of the app instance. Allowed values: false, true.
enable-startup-probe	deploy	Optional	If false, will disable the startup probe of the app instance. Allowed values: false, true.
termination-grace-period-seconds	deploy	Optional	Optional duration in seconds the app instance needs to terminate gracefully.
liveness-probe-config	deploy	Optional	A json file path indicates the liveness probe config.
readiness-probe-config	deploy	Optional	A json file path indicates the readiness probe config.
startup-probe-config	deploy	Optional	A json file path indicates the startup probe config.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.