Skip to content

Commit 611cd8b

Browse files
committed
Edits
1 parent 313c0db commit 611cd8b

1 file changed

Lines changed: 32 additions & 32 deletions

File tree

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

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -77,58 +77,58 @@ The best way to manually create a workflow configuration is to start from the of
7777
1. Choose either **Windows** or **Linux** to make sure that you get the template for the correct operating system.
7878

7979
# [Windows](#tab/windows)
80-
80+
8181
Deployments to Windows use `runs-on: windows-latest`.
82-
82+
8383
# [Linux](#tab/linux)
84-
84+
8585
Deployments to Linux use `runs-on: ubuntu-latest`.
86-
86+
8787
---
8888

8989
1. Copy the language-specific template from the Azure Functions actions repository using the following link:
9090

9191
# [.NET](#tab/dotnet/windows)
92-
92+
9393
<https://github.com/Azure/actions-workflow-samples/blob/master/FunctionApp/windows-dotnet-functionapp-on-azure.yml>
94-
94+
9595
# [.NET](#tab/dotnet/linux)
96-
96+
9797
<https://github.com/Azure/actions-workflow-samples/blob/master/FunctionApp/linux-dotnet-functionapp-on-azure.yml>
98-
98+
9999
# [Java](#tab/java/windows)
100-
100+
101101
<https://github.com/Azure/actions-workflow-samples/blob/master/FunctionApp/windows-java-functionapp-on-azure.yml>
102-
102+
103103
# [Java](#tab/java/linux)
104-
104+
105105
<https://github.com/Azure/actions-workflow-samples/blob/master/FunctionApp/linux-java-functionapp-on-azure.yml>
106-
106+
107107
# [JavaScript](#tab/javascript/windows)
108-
108+
109109
<https://github.com/Azure/actions-workflow-samples/blob/master/FunctionApp/windows-node.js-functionapp-on-azure.yml>
110-
110+
111111
# [JavaScript](#tab/javascript/linux)
112-
112+
113113
<https://github.com/Azure/actions-workflow-samples/blob/master/FunctionApp/linux-node.js-functionapp-on-azure.yml>
114-
114+
115115
# [Python](#tab/python/windows)
116-
116+
117117
Python functions aren't supported on Windows. Choose Linux instead.
118-
118+
119119
# [Python](#tab/python/linux)
120-
120+
121121
<https://github.com/Azure/actions-workflow-samples/blob/master/FunctionApp/linux-python-functionapp-on-azure.yml>
122-
122+
123123
# [PowerShell](#tab/powershell/windows)
124-
124+
125125
<https://github.com/Azure/actions-workflow-samples/blob/master/FunctionApp/windows-powershell-functionapp-on-azure.yml>
126-
126+
127127
# [PowerShell](#tab/powershell/linux)
128-
128+
129129
<https://github.com/Azure/actions-workflow-samples/blob/master/FunctionApp/linux-powershell-functionapp-on-azure.yml>
130-
131-
---
130+
131+
---
132132

133133
1. Update the `env.AZURE_FUNCTIONAPP_NAME` parameter with the name of your function app resource in Azure. You may optionally need to update the parameter that sets the language version used by your app, such as `DOTNET_VERSION` for C#.
134134

@@ -221,7 +221,7 @@ You can create the GitHub Actions workflow configuration file from the Azure Fun
221221
222222
## Update a workflow configuration
223223
224-
If for some reason, you need to update or change an existing workflow configuration, just navigate to the `/.github/workflows/` location in your repository, open the specific YAML file, make any needed changes, and then commit the updates to the repository.
224+
If for some reason you need to update or change an existing workflow configuration, just navigate to the `/.github/workflows/` location in your repository, open the specific YAML file, make any needed changes, and then commit the updates to the repository.
225225
226226
## Example: workflow configuration file
227227
@@ -296,21 +296,21 @@ The following parameters are required for the Flex Consumption plan:
296296
297297
|Parameter |Explanation |
298298
|---------|---------|
299-
|_**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. |
300-
|_**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`. |
299+
|_**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 doesn't need to be included. |
300+
|_**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; don't set **scm-do-build-during-deployment** or **enable-oryx-build**. By default, this parameter is set to `false`. |
301301
302302
The following parameters are specific to the Consumption, Elastic Premium, and App Service (Dedicated) plans:
303303
304304
|Parameter |Explanation |
305305
|--------- |--------- |
306-
|_**scm-do-build-during-deployment**_ | (Optional) Allow the Kudu site (e.g. `https://<APP_NAME>.scm.azurewebsites.net/`) to perform pre-deployment operations, such as [remote builds](functions-deployment-technologies.md#remote-build). By default, this is set to `false`. Set this to `true` when you do want to control deployment behaviors using Kudu instead of resolving dependencies in your GitHub workflow. For more information, see the [`SCM_DO_BUILD_DURING_DEPLOYMENT`](./functions-app-settings.md#scm_do_build_during_deployment) setting.|
306+
|_**scm-do-build-during-deployment**_ | (Optional) Allow the Kudu site (for example, `https://<APP_NAME>.scm.azurewebsites.net/`) to perform pre-deployment operations, such as [remote builds](functions-deployment-technologies.md#remote-build). By default, this is set to `false`. Set this to `true` when you do want to control deployment behaviors using Kudu instead of resolving dependencies in your GitHub workflow. For more information, see the [`SCM_DO_BUILD_DURING_DEPLOYMENT`](./functions-app-settings.md#scm_do_build_during_deployment) setting.|
307307
|_**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`.|
308308
309309
Optional parameters for all function app plans:
310310
311311
|Parameter | Explanation |
312312
| --------- | --------- |
313-
| ***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_. |
313+
| ***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, ensure the **publish-profile** parameter contains the credentials for the slot instead of the production site. _Currently not supported in Flex Consumption_. |
314314
|***publish-profile*** | The name of the GitHub secret that contains your publish profile.|
315315
| _**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/` |
316316
| _**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`. |
@@ -330,11 +330,11 @@ Keep the following considerations in mind when using the Azure Functions action:
330330
331331
\* The ability to run your apps on Linux in a Consumption plan is planned for retirement. For more information, see [Azure Functions Consumption plan hosting](consumption-plan.md).
332332
333-
+ The credentials required by GitHub to connection to Azure for deployment are stored as Secrets in your GitHub repository and accessed in the deployment as `secrets.<SECRET_NAME>`.
333+
+ The credentials required by GitHub to connect to Azure for deployment are stored as Secrets in your GitHub repository and accessed in the deployment as `secrets.<SECRET_NAME>`.
334334
335335
+ The easiest way for GitHub Actions to authenticate with Azure Functions for deployment is by using a publish profile. You can also authenticate using a service principal. To learn more, see [this GitHub Actions repository](https://github.com/Azure/functions-action).
336336
337-
+ The actions for setting up the environment and running a build are generated from the templates, and are language specific.
337+
+ The actions for setting up the environment and running a build are generated from the templates and are language specific.
338338
339339
+ The templates use `env` elements to define settings unique to your build and deployment.
340340

0 commit comments

Comments
 (0)