Migrate quickstart from Functions Core Tools v4 to Functions CLI v5 (func5)#20
Open
paulyuk wants to merge 6 commits into
Open
Migrate quickstart from Functions Core Tools v4 to Functions CLI v5 (func5)#20paulyuk wants to merge 6 commits into
paulyuk wants to merge 6 commits into
Conversation
…func5) Adopt the new Azure Functions CLI v5 preview, installed alongside any existing v4 as 'func5'. This shrinks the local-dev story from three terminals to two and removes the separate Azurite install/start. What changed - README Prerequisites: drop 'Core Tools v4 >= 4.12.0 (v5 preview not yet compatible)'. Recommend Functions CLI v5 installed as 'func5', with a one-line nod to v4 users (full fallback in troubleshooting). - README Quickstart step 1: replace 'brew install azure-functions-core-tools@4 + npm install -g azurite' with the download-from-releases install pattern and a 'func5 setup --features python' one-shot that pulls host + python-worker + python-templates + the extension-bundles workload (the fix for #5309 on early v5 previews). - README Quickstart step 3: collapse three terminals to two. v5 auto-starts Azurite, so the dedicated 'azurite ...' terminal goes away. - docs/troubleshooting.md: invert the v5 advice. Remove the 'Stay on v4' note. Replace it with a self-fix entry that points at the extension bundles workload. Drop the dead Azurite 'Connection refused 127.0.0.1:10000' and 'InvalidHeaderValue' entries (v5 manages Azurite for you). Add a new 'Still using v4' section that documents how to keep the v4 path working until v5 reaches GA. - chat.py, function_app.py, docs/configuration.md, infra/scripts: every user-visible 'uv run func start' becomes 'uv run func5 start', and the hydrate scripts now hint at the v5 auto-Azurite behavior. Why The repo currently tells users to install Core Tools v4 + Azurite + the host runtime, and routes around an extension-bundle bug in early v5 previews. v5-preview.2 ships the extension bundles workload (4.42 +) and resolves that bug; staying on v4 also means the user has to maintain a separate Azurite install and run it in its own terminal. Installing v5 as 'func5' avoids breaking any consumer that still needs v4 'func'. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The earlier URL (Azure.Functions.Cli-osx-arm64-5.0.0-preview.2.tar.gz)
404s. The actual asset names on the v5 preview releases are
func-{osx|linux|win}-{x64|arm64}.{tar.gz|zip}. Verified all six exist.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
31328dc to
1f6e10d
Compare
… workload callout Drops OS-specific brew/curl/PowerShell snippets and the FUNC5_DIR archive recipe in favor of links to the official install docs for uv, azd, func5, and the connector-namespace CLI extension. The only inline command kept is `func5 setup --features python` since the extension bundles workload is the one template-specific, non-default thing. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…tures python by default Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…cally); add Azurite to prereqs; link uv (not Python) in prereq bullet - func5 run replaces 'uv run func5 start' everywhere - v5 detects pyproject.toml and uses the uv-managed venv without the explicit 'uv run' prefix. - Azurite added as an explicit prereq with install link; func5 launches it on demand but does not bundle it. - Prereq bullet now links to uv (the thing you install) instead of Python 3.13 (the thing uv installs). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Add TEAMS_MENTION_USER_ID and TEAMS_MENTION_NAME to the README go-live block with inlined �z ad signed-in-user show subshells so users don't have to copy ids manually. Mirror the same snippet in docs/configuration.md. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Move the documented local-dev path from Azure Functions Core Tools v4 to the new Azure Functions CLI v5 preview, installed alongside any existing v4 as
func5. This shrinks the local-dev story from three terminals to two and removes the separate Azurite install/start.Why
The current README:
brew install azure-functions-core-tools@4+npm install -g azurite+ run Azurite in its own terminal.That bundle issue is fixed in
bundles@4.42.0-preview.2(shipped viafunc5 setup --features python), and v5 auto-manages Azurite (func run/func startstarts and stops it for you unless you pass--no-azurite). So the v4 + separate Azurite recipe is now strictly more work for new users.What changed
README.mdfunc5, runfunc5 setup --features pythononce). Quickstart step 3: collapse 3 terminals to 2 (Azurite goes away).docs/troubleshooting.mdchat.py,function_app.py,infra/scripts/*.sh,infra/scripts/*.ps1,docs/configuration.mduv run func startreferences becomeuv run func5 start. Hydrate scripts hint at v5 auto-Azurite.Test recipe
On a clean machine:
Notes for reviewers / followups
v5.0.0-preview.2. We can swap to a 'latest preview' URL once Microsoft publishes one (currently the GitHub Releases page is the source of truth).func5alias is intentional: it keeps the v4funcusers have today out of the way. The official v5 binary ISfunc; the alias is just for coexistence.