Skip to content

Commit efa713a

Browse files
authored
Update CONTRIBUTING.md documentation with app settings and extension … (#695)
* Update CONTRIBUTING.md documentation with app settings and extension bundle sections * Update extension bundle version in sample host.json file
1 parent 3d29724 commit efa713a

1 file changed

Lines changed: 29 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,35 @@ With this you have completed the setup for Azure Functions Host and the Azure Fu
171171

172172
- Restart host debugger
173173

174+
#### App settings
175+
You can run your local function app in two ways:
176+
1. By running the host code and worker code
177+
2. By running core tools
178+
179+
If you are running the host code and worker code to debug your function app, then you need to add the app settings as part of the host's environment variables (in launch.json).
180+
181+
If you are running core tools to debug your function app, then you need to add the app settings in your function app's local.settings.json file.
182+
183+
### Common Issues
184+
#### Extension Bundle
185+
If you are running the host code and worker code to debug your function app, the extension bundle does not need to be enabled if your local function app only uses the HTTP trigger. However, it does need to be enabled when using other types of triggers and output bindings (e.g. EventHub). Otherwise, you will get exceptions like "The binding type(s) were not found in the configured extension bundle. Please ensure the type is correct and the correct version of extension bundle is configured". In order to enable the extension bundle, you need to follow the steps here:
186+
https://github.com/Azure/azure-functions-host/wiki#extension-bundle-configuration
187+
The `downloadPath` attribute can be any path in your local machine and is used to indicate what directory you would like some generated files to be saved.
188+
189+
This is a sample host.json file configuration in the function app:
190+
```json
191+
{
192+
"version": "2.0",
193+
"extensionBundle": {
194+
"id": "Microsoft.Azure.Functions.ExtensionBundle",
195+
"version": "[4.*, 5.0.0)",
196+
"downloadPath": "C:/Users/<user>/Repos"
197+
}
198+
}
199+
```
200+
201+
If you are running core tools to debug your function app, you do not need to enable the extension bundle.
202+
174203
### Running unit tests
175204

176205
1. Add your unit tests under ./src/test folder

0 commit comments

Comments
 (0)