deploy-container-github-action.md

title	Custom Container CI/CD from GitHub Actions
description	Learn how to use GitHub Actions to deploy your custom Linux container to App Service from a CI/CD pipeline.
ms.topic	how-to
ms.date	02/14/2025
ms.reviewer	ushan
ms.devlang	azurecli
author	cephalin
ms.author	cephalin
zone_pivot_groups	app-service-containers-github-actions
ms.service	azure-app-service
ms.custom	github-actions-azure devx-track-azurecli linux-related-content sfi-ropc-nochange

Deploy a custom container to App Service by using GitHub Actions

You can use GitHub Actions to build an automated software development workflow. You can use the Azure Web Deploy action to automate your workflow and deploy custom containers to Azure App Service.

A workflow is defined by a YAML (.yml) file in the /.github/workflows/ path in your repository. This definition contains the various steps and parameters that are in the workflow.

For an App Service container workflow, the file has three sections:

Section	Tasks
Authentication	1. Retrieve a service principal or publish profile. 2. Create a GitHub secret.
Build	1. Create the environment. 2. Build the container image.
Deploy	1. Deploy the container image.

Prerequisites

• An Azure account with an active subscription. Create an account for free.
• A GitHub account. If you don't have one, sign up for free. You need to have code in a GitHub repository to deploy to Azure App Service.
• A working container registry and Azure App Service app for containers. This example uses Azure Container Registry. Make sure to finish the full deployment to Azure App Service for containers. Unlike regular web apps, web apps for containers don't have a default landing page. Publish the container to have a working example.
• Complete these tasks: Learn how to create a containerized Node.js application by using Docker, push the container image to a registry, and then deploy the image to Azure App Service.

Generate deployment credentials

We recommend that you authenticate with Azure App Services for GitHub Actions by using OpenID Connect. You can also authenticate with a service principal or a publish profile.

To authenticate with Azure, save your publish profile credential or service principal as a GitHub secret. You access the secret within your workflow.

Publish profile

A publish profile is an app-level credential. Set up your publish profile as a GitHub secret.

1. Go to App Service in the Azure portal.

2. On the Overview pane, select Get Publish profile.

   [!NOTE] As of October 2020, users must set the app setting for Linux web apps WEBSITE_WEBDEPLOY_USE_SCM to true before they download the file. To learn how to configure common web app settings, go to Configure an App Service app in the Azure portal.

3. Save the downloaded file. You use the contents of the file to create a GitHub secret.

Service principal

1. Create a Microsoft Entra application with a service principal by using the Azure portal, the Azure CLI, or Azure PowerShell.

2. Create a client secret for your service principal by using the Azure portal, the Azure CLI, or Azure PowerShell.

3. Copy the values for Client ID, Client Secret, Subscription ID, and Directory (tenant) ID to use later in your GitHub Actions workflow.

4. Assign an appropriate role to your service principal by using the Azure portal, the Azure CLI, or Azure PowerShell.

OpenID Connect

OpenID Connect is an authentication method that uses short-lived tokens. Setting up OpenID Connect with GitHub Actions is a more complex process that offers hardened security.

To use the Azure Login action with OpenID Connect, you need to configure a federated identity credential on a Microsoft Entra application or a user-assigned managed identity.

Option 1: Use a Microsoft Entra application

1. Create a Microsoft Entra application with a service principal by using the Azure portal, the Azure CLI, or Azure PowerShell.

2. Copy the values for Client ID, Subscription ID, and Directory (tenant) ID to use later in your GitHub Actions workflow.

3. Assign an appropriate role to your service principal by using the Azure portal, the Azure CLI, or Azure PowerShell.

4. Configure a federated identity credential on a Microsoft Entra application to trust tokens that GitHub Actions issues to your GitHub repository.

Option 2: Use a user-assigned managed identity

1. Create a user-assigned managed identity.

2. Copy the values for Client ID, Subscription ID, and Directory (tenant) ID to use later in your GitHub Actions workflow.

3. Assign an appropriate role to your user-assigned managed identity.

4. Configure a federated identity credential on a user-assigned managed identity to trust tokens that GitHub Actions issues to your GitHub repository.

---

Configure the GitHub secret for authentication

Publish profile

In GitHub, browse your repository. Select Settings > Security > Secrets and variables > Actions > New repository secret.

To use app-level credentials, paste the contents of the downloaded publish profile file into the secret's value field. Name the secret AZURE_WEBAPP_PUBLISH_PROFILE.

When you configure your GitHub workflow, use the AZURE_WEBAPP_PUBLISH_PROFILE secret in the deploy Azure Web App action. For example:

- uses: azure/webapps-deploy@v2
  with:
    publish-profile: ${{ secrets.AZURE_WEBAPP_PUBLISH_PROFILE }}

Service principal

In GitHub, browse your repository. Select Settings > Security > Secrets and variables > Actions > New repository secret.

To use user-level credentials, paste the entire JSON output from the Azure CLI command into the secret's value field. Give the secret a name, like AZURE_CREDENTIALS.

When you configure the workflow file later, use the secret as the input creds value of the Azure Login action. For example:

- uses: azure/login@v2
  with:
    creds: ${{ secrets.AZURE_CREDENTIALS }}

OpenID Connect

You need to provide your application's Client ID, Tenant ID, and Subscription ID to the sign-in action. You can provide these values either directly in the workflow or you can store them in GitHub secrets and reference them in your workflow. It's more secure to save the values as GitHub secrets.

1. Open your GitHub repository and go to Settings > Security > Secrets and variables > Actions > New repository secret.

   [!NOTE] To enhance workflow security in public repositories, use environment secrets instead of repository secrets. If the environment requires approval, a job can't access environment secrets until one of the required reviewers approves it.

2. Create secrets for AZURE_CLIENT_ID, AZURE_TENANT_ID, and AZURE_SUBSCRIPTION_ID. Use these values from your active directory application for your GitHub secrets. You can find these values in the Azure portal by searching for your active directory application.

   GitHub secret	Active Directory application
   AZURE_CLIENT_ID	Application (client) ID
   AZURE_TENANT_ID	Directory (tenant) ID
   AZURE_SUBSCRIPTION_ID	Subscription ID

3. Save each secret by selecting Add secret.

---

Configure GitHub secrets for your registry

Define secrets to use with the Docker Login action. The example in this article uses Azure Container Registry for the container registry.

1. Go to your container in the Azure portal or Docker and copy the username and password. You can find the Azure Container Registry username and password in the Azure portal under Settings > Access keys for your registry.

2. Define a new secret for the registry username named REGISTRY_USERNAME.

3. Define a new secret for the registry password named REGISTRY_PASSWORD.

Build the container image

::: zone pivot="github-actions-containers-linux"

The following example shows part of the workflow that builds a Node.js Docker image. Use Docker Login to sign in to a private container registry. This example uses Azure Container Registry but the same action works for other registries.

name: Linux Container Node Workflow

on: [push]

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v2
    - uses: azure/docker-login@v1
      with:
        login-server: mycontainer.azurecr.io
        username: ${{ secrets.REGISTRY_USERNAME }}
        password: ${{ secrets.REGISTRY_PASSWORD }}
    - run: |
        docker build . -t mycontainer.azurecr.io/myapp:${{ github.sha }}
        docker push mycontainer.azurecr.io/myapp:${{ github.sha }}     

You can also use Docker sign in to sign in to multiple container registries at the same time. This example includes two new GitHub secrets for authentication with docker.io. The example assumes that there's a Dockerfile at the root level of the registry.

name: Linux Container Node Workflow

on: [push]

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v2
    - uses: azure/docker-login@v1
      with:
        login-server: mycontainer.azurecr.io
        username: ${{ secrets.REGISTRY_USERNAME }}
        password: ${{ secrets.REGISTRY_PASSWORD }}
    - uses: azure/docker-login@v1
      with:
        login-server: index.docker.io
        username: ${{ secrets.DOCKERIO_USERNAME }}
        password: ${{ secrets.DOCKERIO_PASSWORD }}
    - run: |
        docker build . -t mycontainer.azurecr.io/myapp:${{ github.sha }}
        docker push mycontainer.azurecr.io/myapp:${{ github.sha }}     

::: zone-end

::: zone pivot="github-actions-containers-windows"

The following example shows part of the workflow that builds a Windows Docker image. Use Docker Login to sign in to a private container registry. This example uses Azure Container Registry but the same action works for other registries.

name: Windows Container Workflow
on: [push]
jobs:
  build:
    runs-on: windows-latest
    steps:
    - uses: actions/checkout@v2
    - uses: azure/docker-login@v1
      with:
        login-server: mycontainer.azurecr.io
        username: ${{ secrets.REGISTRY_USERNAME }}
        password: ${{ secrets.REGISTRY_PASSWORD }}
    - run: |
        docker build . -t mycontainer.azurecr.io/myapp:${{ github.sha }}
        docker push mycontainer.azurecr.io/myapp:${{ github.sha }}     

You can also use Docker sign-in to sign in to multiple container registries at the same time. This example includes two new GitHub secrets for authentication with docker.io. The example assumes that there's a Dockerfile at the root level of the registry.

name: Windows Container Workflow
on: [push]
jobs:
  build:
    runs-on: windows-latest
    steps:
    - uses: actions/checkout@v2
    - uses: azure/docker-login@v1
      with:
        login-server: mycontainer.azurecr.io
        username: ${{ secrets.REGISTRY_USERNAME }}
        password: ${{ secrets.REGISTRY_PASSWORD }}
    - uses: azure/docker-login@v1
      with:
        login-server: index.docker.io
        username: ${{ secrets.DOCKERIO_USERNAME }}
        password: ${{ secrets.DOCKERIO_PASSWORD }}
    - run: |
        docker build . -t mycontainer.azurecr.io/myapp:${{ github.sha }}
        docker push mycontainer.azurecr.io/myapp:${{ github.sha }}     

::: zone-end

Deploy to an App Service container

To deploy your image to a custom container in App Service, use the azure/webapps-deploy@v2 action. This action has seven parameters:

Parameter	Explanation
app-name	(Required) Name of the App Service app.
publish-profile	(Optional) Used with web apps (Windows and Linux) and web app containers (Linux). Multi-container scenario not supported. Publish profile \*.publishsettings file contents with Web Deploy secrets.
slot-name	(Optional) Enter an existing slot other than the production slot.
package	(Optional) Used only with web apps: Path to package or folder. \*.zip, \*.war, \*.jar, or a folder to deploy.
images	(Required) Used only with web app containers: Specify the fully qualified container image name. For example, myregistry.azurecr.io/nginx:latest or python:3.12.12-alpine/. For a multi-container app, multiple container image names can be provided (multi-line separated).
configuration-file	(Optional) Used only with web app containers: Path of the Docker Compose file. Should be a fully qualified path or relative to the default working directory. Required for multi-container apps.
startup-command	(Optional) Enter the startup command. For example: dotnet run or dotnet filename.dll.

::: zone pivot="github-actions-containers-linux"

Publish profile

name: Linux Container Node Workflow

on: [push]

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v2

    - uses: azure/docker-login@v1
      with:
        login-server: mycontainer.azurecr.io
        username: ${{ secrets.REGISTRY_USERNAME }}
        password: ${{ secrets.REGISTRY_PASSWORD }}

    - run: |
        docker build . -t mycontainer.azurecr.io/myapp:${{ github.sha }}
        docker push mycontainer.azurecr.io/myapp:${{ github.sha }}     

    - uses: azure/webapps-deploy@v2
      with:
        app-name: 'myapp'
        publish-profile: ${{ secrets.AZURE_WEBAPP_PUBLISH_PROFILE }}
        images: 'mycontainer.azurecr.io/myapp:${{ github.sha }}'

Service principal

on: [push]

name: Linux_Container_Node_Workflow

jobs:
  build-and-deploy:
    runs-on: ubuntu-latest
    steps:
    # Check out the repo
    - name: 'Checkout GitHub Action' 
      uses: actions/checkout@main
    
    - name: 'Sign in via Azure CLI'
      uses: azure/login@v2
      with:
        creds: ${{ secrets.AZURE_CREDENTIALS }}
    
    - uses: azure/docker-login@v1
      with:
        login-server: mycontainer.azurecr.io
        username: ${{ secrets.REGISTRY_USERNAME }}
        password: ${{ secrets.REGISTRY_PASSWORD }}
    - run: |
        docker build . -t mycontainer.azurecr.io/myapp:${{ github.sha }}
        docker push mycontainer.azurecr.io/myapp:${{ github.sha }}     
      
    - uses: azure/webapps-deploy@v2
      with:
        app-name: 'myapp'
        images: 'mycontainer.azurecr.io/myapp:${{ github.sha }}'
    
    - name: Azure logout
      run: |
        az logout

OpenID Connect

on: [push]
name: Linux_Container_Node_Workflow

permissions:
      id-token: write
      contents: read

jobs:
  build-and-deploy:
    runs-on: ubuntu-latest
    steps:
    # Check out the repo
    - name: 'Checkout GitHub Action' 
      uses: actions/checkout@main
    
    - name: 'Sign in via Azure CLI'
      uses: azure/login@v2
      with:
        client-id: ${{ secrets.AZURE_CLIENT_ID }}
        tenant-id: ${{ secrets.AZURE_TENANT_ID }}
        subscription-id: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
    
    - uses: azure/docker-login@v1
      with:
        login-server: mycontainer.azurecr.io
        username: ${{ secrets.REGISTRY_USERNAME }}
        password: ${{ secrets.REGISTRY_PASSWORD }}
    - run: |
        docker build . -t mycontainer.azurecr.io/myapp:${{ github.sha }}
        docker push mycontainer.azurecr.io/myapp:${{ github.sha }}     
      
    - uses: azure/webapps-deploy@v2
      with:
        app-name: 'myapp'
        images: 'mycontainer.azurecr.io/myapp:${{ github.sha }}'
    
    - name: Azure logout
      run: |
        az logout

::: zone-end

::: zone pivot="github-actions-containers-windows"

Publish profile

name: Windows_Container_Workflow

on: [push]

jobs:
  build:
    runs-on: windows-latest

    steps:
    - uses: actions/checkout@v2

    - uses: azure/docker-login@v1
      with:
        login-server: mycontainer.azurecr.io
        username: ${{ secrets.REGISTRY_USERNAME }}
        password: ${{ secrets.REGISTRY_PASSWORD }}

    - run: |
        docker build . -t mycontainer.azurecr.io/myapp:${{ github.sha }}
        docker push mycontainer.azurecr.io/myapp:${{ github.sha }}     

    - uses: azure/webapps-deploy@v2
      with:
        app-name: 'myapp'
        publish-profile: ${{ secrets.AZURE_WEBAPP_PUBLISH_PROFILE }}
        images: 'mycontainer.azurecr.io/myapp:${{ github.sha }}'

Service principal

on: [push]

name: Windows_Container_Workflow

jobs:
  build-and-deploy:
    runs-on: windows-latest
    steps:
    # Check out the repo
    - name: 'Checkout GitHub Action' 
      uses: actions/checkout@main
    
    - name: 'Sign in via Azure CLI'
      uses: azure/login@v2
      with:
        creds: ${{ secrets.AZURE_CREDENTIALS }}
    
    - uses: azure/docker-login@v1
      with:
        login-server: mycontainer.azurecr.io
        username: ${{ secrets.REGISTRY_USERNAME }}
        password: ${{ secrets.REGISTRY_PASSWORD }}
    - run: |
        docker build . -t mycontainer.azurecr.io/myapp:${{ github.sha }}
        docker push mycontainer.azurecr.io/myapp:${{ github.sha }}     
      
    - uses: azure/webapps-deploy@v2
      with:
        app-name: 'myapp'
        images: 'mycontainer.azurecr.io/myapp:${{ github.sha }}'
    
    - name: Azure logout
      run: |
        az logout

OpenID Connect

on: [push]
name: Windows_Container_Workflow

permissions:
      id-token: write
      contents: read

jobs:
  build-and-deploy:
    runs-on: windows-latest
    steps:
    # Check out the repo
    - name: 'Checkout GitHub Action' 
      uses: actions/checkout@main
    
    - name: 'Sign in via Azure CLI'
      uses: azure/login@v2
      with:
        client-id: ${{ secrets.AZURE_CLIENT_ID }}
        tenant-id: ${{ secrets.AZURE_TENANT_ID }}
        subscription-id: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
    
    - uses: azure/docker-login@v1
      with:
        login-server: mycontainer.azurecr.io
        username: ${{ secrets.REGISTRY_USERNAME }}
        password: ${{ secrets.REGISTRY_PASSWORD }}
    - run: |
        docker build . -t mycontainer.azurecr.io/myapp:${{ github.sha }}
        docker push mycontainer.azurecr.io/myapp:${{ github.sha }}     
      
    - uses: azure/webapps-deploy@v2
      with:
        app-name: 'myapp'
        images: 'mycontainer.azurecr.io/myapp:${{ github.sha }}'
    
    - name: Azure logout
      run: |
        az logout

::: zone-end

---

Related content

You can find our set of actions grouped into different repositories on GitHub. Each repository contains documentation and examples to help you use GitHub for CI/CD and deploy your apps to Azure.

• Actions workflows to deploy to Azure
• Azure sign-in
• Azure WebApp
• Docker sign-in/out
• Events that trigger workflows
• K8s deploy
• Starter workflows