From e63a241836cfefbf0940029924fca35db9002d91 Mon Sep 17 00:00:00 2001 From: Chandni Patel Date: Tue, 21 May 2024 13:58:16 -0500 Subject: [PATCH] updated readme --- README.md | 5 +++-- action.yml | 11 +++++------ 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 71311d9c2..ac1e96df9 100644 --- a/README.md +++ b/README.md @@ -105,11 +105,12 @@ If `WEBSITE_RUN_FROM_PACKAGE_BLOB_MI_RESOURCE_ID` is defined then user-assigned - **respect-funcignore**: Allow GitHub Action to parse your .funcignore file and exclude files and folders defined in it. By default, this value is set to `false`. If your GitHub repo contains .funcignore file and want to exclude certain paths (e.g. text editor configs .vscode/, Python virtual environment .venv/), we recommend setting this to `true`. - **scm-do-build-during-deployment**: Allow Kudu site (e.g. https://your-site-name.scm.azurewebsites.net/) to perform pre-deployment operation. 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 setting, please visit our [Kudu doc](https://github.com/projectkudu/kudu/wiki/Configurable-settings#enabledisable-build-actions). - **enable-oryx-build**: Allow Kudu site to resolve your project dependencies with [Oryx](https://github.com/Microsoft/Oryx). By default, this is set to `false`. If you want to use Oryx to resolve your dependencies (e.g. [remote build](https://docs.microsoft.com/en-us/azure/azure-functions/functions-deployment-technologies#remote-build)) instead of GitHub Workflow, please consider setting **scm-do-build-during-deployment** and **enable-oryx-build** to `true`. + +Parameters only supported for Flex Consumption plan: - **sku**: For function app on Flex Consumption plan, set this to `flexconsumption`. You can skip this parameter for function app on other plans. If using RBAC credentials, then by default, GitHub Action will resolve the value for this paramter. But if using **publish-profile**, then you must set this for function app on Flex Consumption plan. -- **remote-build**: For function app on Flex Consumption plan, enable build action from Kudu when the package is deployed onto the function app by setting this to `true`. -Parameter **remote-build** is only supported for function app on Flex Consumption plan. For other plans, you can use **scm-do-build-during-deployment** and **enable-oryx-build**. +- **remote-build**: For function app on Flex Consumption plan, enable build action from Kudu when the package is deployed onto the function app by setting this to `true`. For function app on Flex Consumption plan, do not set **scm-do-build-during-deployment** and **enable-oryx-build**. By default, this is set to `false`. diff --git a/action.yml b/action.yml index ec416d77e..94b2fd389 100644 --- a/action.yml +++ b/action.yml @@ -47,15 +47,14 @@ inputs: required: false default: 'false' sku: - description: "For function app on Flex Consumption plan, please set this to 'flexconsumption'. You can skip this parameter for function app on other plans. - If using RBAC credentials, then by default, GitHub Action will resolve the value for this paramter. But if using publish-profile, + description: "For function app on Flex Consumption plan, set this to 'flexconsumption'. You can skip this parameter for function app on other plans. + If using RBAC credentials, then by default, GitHub Action will resolve the value for this paramter. But if using 'publish-profile', then you must set this for function app on Flex Consumption plan." required: false remote-build: - description: "For function app on Flex Consumption plan, enable build action from Kudu when the package is deployed onto the function app by setting this to 'true'. - Parameter 'remote-build' is only supported for function app on Flex Consumption plan. For other plans, please set 'scm-do-build-during-deployment' and 'enable-oryx-build'. - For function app on Flex Consumption plan, please do not set 'scm-do-build-during-deployment' and 'enable-oryx-build'. - By default, GitHub Action respects the packages resolved in GitHub workflow, disabling the + description: "For function app on Flex Consumption plan, enable build action from Kudu when the package is deployed onto the function app by setting this to 'true'. + For function app on Flex Consumption plan, do not set 'scm-do-build-during-deployment' and 'enable-oryx-build'. + By default, GitHub Action respects the packages resolved in GitHub workflow, disabling the redundant build action from Kudu endpoint. (default: 'false')." required: false default: 'false'