Edit

Configure service packaging file exclusions

The Azure Developer CLI (azd) allows you to add ignore files in your templates that specify files and directories to exclude from the deployment package for App Service and Function Apps. This feature provides granular control at the service level over which files are included in the packaging process.

Understand service packaging ignore files

There are two different types of ignore files you can use to influence the packaging process:

  • .webappignore influences packaging exclusions for Azure App Service deployments.
  • .funcignore influences packaging exclusions for Azure Functions deployments.

These ignore files are applied based on the targeted deployment service, ensuring users can independently customize file exclusions when packaging for Azure App Service and Azure Functions. Both types of packaging ignore files follow these rules:

  • .webappignore or .funcignore files should be placed in the root folder of the relevant service in your azd template.
  • If a .webappignore or .funcignore file exists in a service directory, the packaging process follows its rules, allowing granular control over which files are included or excluded in the service's zip archive.
  • If no .webappignore or .funcignore file is present, default exclusions apply:
    • Python: __pycache__ and any venv files
    • Node.js: node_modules
  • The syntax for the ignore files followed the standard gitignore syntax. For example, use the ! symbol to revert an exclusion.

Exclusion examples

In your azd template, add a .webappignore or .funcignore file to the root folder of the service you intend to deploy to Azure App Service or Azure Functions. Update the content of those ignore files to include or exclude files using the following patterns:

Exclude a folder or a specific file:

logs/*
testfile.js

Exclude folders or files that are ignored by default when the .webappignore or .funcignore file isn't present:

node_modules/
  • Last updated on