Skip to content

Commit 188f281

Browse files
committed
mentioned flex in parameters
1 parent eafd1fb commit 188f281

File tree

1 file changed

+23
-11
lines changed

1 file changed

+23
-11
lines changed

articles/azure-functions/functions-how-to-github-actions.md

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Use GitHub Actions to make code updates in Azure Functions
33
description: Learn how to use GitHub Actions to define a workflow to build and deploy Azure Functions projects in GitHub.
44
ms.topic: conceptual
5-
ms.date: 03/16/2024
5+
ms.date: 09/27/2024
66
ms.custom: devx-track-csharp, github-actions-azure
77
zone_pivot_groups: github-actions-deployment-options
88
---
@@ -281,23 +281,35 @@ The Azure Functions action (`Azure/azure-functions`) defines how your code is pu
281281
282282
### Parameters
283283
284-
The following parameters are most commonly used with this action:
284+
The following parameters are required for all function app plans:
285285
286286
|Parameter |Explanation |
287287
|---------|---------|
288-
|_**app-name**_ | (Mandatory) The name of your function app. |
289-
|_**slot-name**_ | (Optional) The name of a specific [deployment slot](functions-deployment-slots.md) you want to deploy to. The slot must already exist in your function app. When not specified, the code is deployed to the active slot. |
290-
|_**publish-profile**_ | (Optional) The name of the GitHub secret that contains your publish profile. |
288+
|_**app-name**_ | The name of your function app. |
289+
|***package*** | This is the location in your project to be published. By default, this value is set to `.`, which means all files and folders in the GitHub repository will be deployed.|
291290
292-
The following parameters are also supported, but are used only in specific cases:
291+
The following parameters are required for the Flex Consumption plan:
293292
294293
|Parameter |Explanation |
295294
|---------|---------|
296-
| _**package**_ | (Optional) Sets a subpath in your repository from which to publish. By default, this value is set to `.`, which means all files and folders in the GitHub repository are deployed. |
297-
| _**respect-pom-xml**_ | (Optional) Used only for Java functions. Whether it's required for your app's deployment artifact to be derived from the pom.xml file. When deploying Java function apps, you should set this parameter to `true` and set `package` to `.`. By default, this parameter is set to `false`, which means that the `package` parameter must point to your app's artifact location, such as `./target/azure-functions/` |
298-
| _**respect-funcignore**_ | (Optional) Whether GitHub Actions honors your .funcignore file to exclude files and folders defined in it. Set this value to `true` when your repository has a .funcignore file and you want to use it exclude paths and files, such as text editor configurations, .vscode/, or a Python virtual environment (.venv/). The default setting is `false`. |
299-
| _**scm-do-build-during-deployment**_ | (Optional) Whether the App Service deployment site (Kudu) performs predeployment operations. The deployment site for your function app can be found at `https://<APP_NAME>.scm.azurewebsites.net/`. Change this setting to `true` when you need to control the deployments in Kudu rather than resolving the dependencies in the GitHub Actions workflow. The default value is `false`. For more information, see the [SCM_DO_BUILD_DURING_DEPLOYMENT](./functions-app-settings.md#scm_do_build_during_deployment) setting. |
300-
| _**enable-oryx-build**_ |(Optional) Whether the Kudu deployment site resolves your project dependencies by using Oryx. Set to `true` when you want to use Oryx to resolve your project dependencies by using a remote build instead of the GitHub Actions workflow. When `true`, you should also set `scm-do-build-during-deployment` to `true`. The default value is `false`.|
295+
|_**sku**_ | Set this to `flexconsumption` when authenticating with publish-profile. When using RBAC credentials or deploying to a non-Flex Consumption plan, the Action can resolve the value, so the parameter does not need to be included. |
296+
|_**remote-build**_ | Set this to `true` to enable a build action from Kudu when the package is deployed to a Flex Consumption app. Oryx build is always performed during a remote build in Flex Consumption; do not set **scm-do-build-during-deployment** or **enable-oryx-build**. By default, this parameter is set to `false`. |
297+
298+
The following parameters are specific to the Consumption, Elastic Premium, and App Service (Dedicated) plans:
299+
300+
|Parameter |Explanation |
301+
|---------|---------|
302+
|_**scm-do-build-during-deployment**_ | (Optional) Allow the Kudu site (e.g. https://your-site-name.scm.azurewebsites.net/) to perform pre-deployment operations like [remote build](functions-deployment-technologies.md#remote-build). By default, this is set to `false`. If you don't want to resolve the dependencies in the GitHub Workflow, and instead, you want to control the deployments in Kudu / KuduLite, you may want to change this setting to `true`. For more information on [SCM_DO_BUILD_DURING_DEPLOYMENT](./functions-app-settings.md#scm_do_build_during_deployment) setting.|
303+
|_**enable-oryx-build**_ | (Optional) Allow Kudu site to resolve your project dependencies with Oryx. By default, this is set to `false`. If you want to use [Oryx](https://github.com/Microsoft/Oryx) to resolve your dependencies instead of the GitHub Workflow, set both **scm-do-build-during-deployment** and **enable-oryx-build** to `true`.|
304+
305+
Optional parameters for all function app plans:
306+
307+
|Parameter |Explanation |
308+
|---------|---------|
309+
| ***slot-name*** | This is the [deployment slot](functions-deployment-slots.md) name to be deployed to. By default, this value is empty, which means the GitHub Action will deploy to your production site. When this setting points to a non-production slot, please ensure the **publish-profile** parameter contains the credentials for the slot instead of the production site. _Currently not supported in Flex Consumption_. |
310+
|***publish-profile*** | The name of the GitHub secret that contains your publish profile.|
311+
| _**respect-pom-xml**_ | Used only for Java functions. Whether it's required for your app's deployment artifact to be derived from the pom.xml file. When deploying Java function apps, you should set this parameter to `true` and set `package` to `.`. By default, this parameter is set to `false`, which means that the `package` parameter must point to your app's artifact location, such as `./target/azure-functions/` |
312+
| _**respect-funcignore**_ | Whether GitHub Actions honors your .funcignore file to exclude files and folders defined in it. Set this value to `true` when your repository has a .funcignore file and you want to use it exclude paths and files, such as text editor configurations, .vscode/, or a Python virtual environment (.venv/). The default setting is `false`. |
301313
302314
### Considerations
303315

0 commit comments

Comments
 (0)