Skip to content

Add local.settings.json to template - #24

Merged
paulyuk merged 1 commit into
Azure-Samples:mainfrom
paulyuk:add-local-settings-json
Feb 25, 2026
Merged

Add local.settings.json to template#24
paulyuk merged 1 commit into
Azure-Samples:mainfrom
paulyuk:add-local-settings-json

Conversation

@paulyuk

@paulyuk paulyuk commented Feb 24, 2026

Copy link
Copy Markdown
Member

Summary

This PR adds local.settings.json directly to the template, eliminating the manual file creation step from the README.

Changes

File Change
local.settings.json Added with base settings
.gitignore Removed local.settings.json line (so file ships with template)
.funcignore No change (keeps excluding from deployment)
README.md Updated to remove manual creation instructions

local.settings.json contents

{
    "IsEncrypted": false,
    "Values": {
        "AzureWebJobsStorage": "UseDevelopmentStorage=true",
        "FUNCTIONS_WORKER_RUNTIME": "python"
    }
}

Why

  • Better DX: Developers get a working setup immediately after azd init
  • No secrets: Only contains safe default values
  • Still protected: .funcignore prevents deployment to Azure

Tracking

- Add local.settings.json with base settings (AzureWebJobsStorage, FUNCTIONS_WORKER_RUNTIME)
- Remove local.settings.json from .gitignore so file ships with template
- Keep local.settings.json in .funcignore to prevent deployment
- Update README.md:
  - Remove manual file creation instructions
  - Add Azurite to prerequisites (required for UseDevelopmentStorage=true)
  - Add step to start Azurite before running the function

This improves developer experience by including the required local settings
file directly in the template, eliminating a manual setup step.

Tracking: microsoft/GitHub-Copilot-for-Azure#973

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@paulyuk
paulyuk force-pushed the add-local-settings-json branch from 68def78 to 62b30de Compare February 24, 2026 01:33
@paulyuk
paulyuk merged commit 6c070b1 into Azure-Samples:main Feb 25, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant