How to deploy to a virtual Directory using GitHub action "azure/webapps-deploy"

Question

How to deploy to a virtual Directory using GitHub action "azure/webapps-deploy"

Jean Paul Larach 36 Microsoft Employee

Does anyone know how to deploy to a virtual Directory using GitHub action "azure/webapps-deploy"? I don't see the equivalent in the GitHub action.

In Azure DevOps you were able to do this: User's image

ajkuma 28,036 Reputation points Microsoft Employee Moderator

2023-05-23T18:53:24.0466667+00:00

@Jean Paul Larach ,

Just checking in to see if you had got a chance to see the previous response.

To benefit the community, find the right answers, please do mark the post which was helpful by clicking on Accept Answer.

1 answer

Your answer

ajkuma 28,036 Reputation points Microsoft Employee Moderator

2023-05-23T18:53:24.0466667+00:00

@Jean Paul Larach ,

Just checking in to see if you had got a chance to see the previous response.

To benefit the community, find the right answers, please do mark the post which was helpful by clicking on Accept Answer.

Answer 1

ajkuma 28,036 Microsoft Employee Moderator

@Jean Paul Larach , Firstly, apologies for the delay from over the weekend.

Based on my understanding of your scenario, to deploy to a virtual directory using the azure/webapps-deploy GitHub action, you can specify the virtual directory path in the app-name parameter. For example, if your virtual directory path is /myapp, you can set the app-name parameter to myapp.

You may take a look the example YAML configuration for deploying to a virtual directory:

- name: Deploy to Azure Web App
  uses: azure/webapps-deploy@v2
  with:
    app-name: myapp/virtualdirectory
    publish-profile: ${{ secrets.AZURE_WEBAPP_PUBLISH_PROFILE }}
    package: ${{ env.AZURE_WEBAPP_PACKAGE_PATH }}/myapp

In this example, the app-name parameter is set to myapp/virtualdirectory, which specifies the virtual directory path. The publish-profile parameter specifies the publish profile file, and the package parameter specifies the path to the package or folder to deploy.

Additionally, you may test it our with "VirtualApplication" input parameter. Here's an example YAML code snippet:

- name: Deploy to Azure Web App
  uses: azure/webapps-deploy@v2
  with:
    app-name: 'myapp'
    publish-profile: ${{ secrets.AZURE_WEBAPP_PUBLISH_PROFILE }}
    package: ${{ env.AZURE_WEBAPP_PACKAGE_PATH }}
    VirtualApplication: 'virtual-directory-name'

In this example, the "VirtualApplication" input parameter is set to the name of the virtual directory you want to deploy to. Ensure to replace 'myapp' with the name of your Azure Web App, and 'virtual-directory-name' with the name of your virtual directory.

Reference:

Deploying .NET to Azure App Service

Deploy to App Service using GitHub Actions

Jean Paul Larach 36 Reputation points Microsoft Employee

2023-05-24T15:30:31.1633333+00:00
The second option worked for us using the "VirtualApplication" parameter but we have an issue with another deployment workflow that is supposed to deploy to wwwroot and it is erroneously deploying to the virtual directory (we do not have the VirtualApplication as a parameter as you see in the code snippet below).

Also, option #1 didn't work for us. Here is the error: "Error: Deployment Failed, Error: Publish profile is invalid for app-name and slot-name provided. Provide correct publish profile credentials for app."

We would suggest updating the documentation for "VirtualApplication" parameter. We couldn't find that option anywhere.

Thank you for your help!

- name: 'Deploy to Azure App Service using DEV publish profile credentials' uses: azure/webapps-deploy@v2.2.10 with: app-name: ${{ secrets.APP_NAME }} publish-profile: ${{ secrets.PUBLISH_PROFILE_WEB }} package: '.'
ajkuma 28,036 Reputation points Microsoft Employee Moderator

2023-05-26T06:13:12.19+00:00

Jean Paul Larach , Glad to know that the issue is resolved. Thanks for the follow-up and update.
I'll work with the doc author for a review and update it appropriately, for adding more clarity . Thank you for your feedback.

Jean Paul Larach 36 Microsoft Employee

Hi ajkuma. It worked partially for us. Here is the issue explained:

We have one Azure App Service which uses /wwwroot and a Virtual Directory on that App Service that uses /api

We use two Github workflows. One for the web app (/wwwroot) and another one for the API (/api).

What happens is that we can deploy to the virtual directory (/api) in its workflow, but then when we run the web app workflow, it also deploys to the /api folder.

The only way I've gotten this to work is by manually editing the following file in Kudu: D:\home\site\deployments\tools\deploy.cmd

In that file, I set the DEPLOYMENT_TARGET based on the existence of a DLL in the DEPLOYMENT_SOURCE. If the DEPLOYMENT_SOURCE contains the DLL associated with the API, I set the DEPLOYMENT_TARGET to /api. Else if it contains the DLL associated with the Web App, I set DEPLOYMENT_TARGET to /wwwroot

The problem with this approach is that the 'deploy.cmd' file randomly gets reset and I lose my changes to it! I have no idea what is resetting this file.

Below is the relevant YAML for our deployments:

API workflow file

env:
  AZURE_DEPLOYMENT_TARGET: 'D:\home\site\api'

- name: Configure Azure Deployment Target
  uses: Azure/login@v1.4.6
  with:
      creds: ${{ secrets.ATC_DEVTEST_EXT_GITHUB_SP }}
      environment: 'AzureUSGovernment'
      run: az webapp config appsettings set --name ${{ secrets.ATC_APP_NAME }} --resource-group ${{ env.AZURE_RESOURCE_GROUP }} --settings DEPLOYMENT_TARGET=${{ env.AZURE_DEPLOYMENT_TARGET }} --output none

- name: 'Deploy to Azure App Service using DEV publish profile credentials'
  uses: azure/webapps-deploy@v2.2.10
  with:
    app-name: ${{ secrets.ATC_APP_NAME }}
    publish-profile: ${{ secrets.ATC_PUBLISH_PROFILE_API }}
    package: '.'

Web App workflow file

env:
  AZURE_DEPLOYMENT_TARGET: 'D:\home\site\wwwroot'

- name: Configure Azure Deployment Target
  uses: Azure/login@v1.4.6
  with:
      creds: ${{ secrets.ATC_DEVTEST_EXT_GITHUB_SP }}
      environment: 'AzureUSGovernment'
      run: az webapp config appsettings set --name ${{ secrets.ATC_APP_NAME }} --resource-group ${{ env.AZURE_RESOURCE_GROUP }} --settings DEPLOYMENT_TARGET=${{ env.AZURE_DEPLOYMENT_TARGET }} --output none

- name: 'Deploy to Azure App Service using DEV publish profile credentials'
  uses: azure/webapps-deploy@v2.2.10
  with:
    app-name: ${{ secrets.ATC_APP_NAME }}
    publish-profile: ${{ secrets.ATC_PUBLISH_PROFILE_WEB }}
    package: '.'

ajkuma 28,036 Reputation points Microsoft Employee Moderator

2023-05-29T16:28:19.7066667+00:00

Jean, Thanks for the follow-up. Apologies for the delayed response from over the weekend. I'm following-up further with you offline.

Share via

How to deploy to a virtual Directory using GitHub action "azure/webapps-deploy"

1 answer

Your answer