docs(release): changelog, README, and copilot-instructions updates - #339
Open
YunchuWang wants to merge 1 commit into
Open
docs(release): changelog, README, and copilot-instructions updates#339YunchuWang wants to merge 1 commit into
YunchuWang wants to merge 1 commit into
Conversation
Split out of #335 as a standalone, independently reviewable change. Documentation-only updates supporting the per-package release: - CHANGELOG.md (root, core + azuremanaged) - packages/azure-functions-durable/CHANGELOG.md (compat) - packages/azure-functions-durable/README.md - .github/copilot-instructions.md No runtime code changes. Content is byte-identical to the CI-green #335 branch at 8501bc0; this is a pure re-partition with no behavior change. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: d86f5f69-4e1a-4c1d-b017-5e290c85cc05
This was referenced Jul 29, 2026
This was referenced Jul 29, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Documentation-only PR that updates release notes and compat-package guidance for the durable-functions (Azure Functions) provider and the repo-wide changelog/Copilot instructions, aligning docs with current runtime semantics (e.g., whenAll wait-all behavior).
Changes:
- Update
durable-functionsREADME guidance around removed v3 surfaces and add explicit Functions extension bundle requirements for gRPC. - Replace the compat package changelog placeholder with detailed preview/rewrite notes, requirements, breaking changes, and added features.
- Update root changelog and Copilot instructions to reflect
whenAllwait-all semantics and related breaking-change notes.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
packages/azure-functions-durable/README.md |
Updates migration guidance and adds extension bundle requirements for the gRPC-based provider. |
packages/azure-functions-durable/CHANGELOG.md |
Replaces placeholder with detailed “Upcoming” preview/rewrite notes and compatibility/breaking-change documentation. |
CHANGELOG.md |
Adds breaking-change notes for whenAll semantics and default sub-orchestration instance ID derivation. |
.github/copilot-instructions.md |
Updates internal guidance to match current WhenAllTask wait-all behavior. |
Comment on lines
+45
to
+46
| `context.entities.isInCriticalSection()`. The v3 `df.lock` / `isLocked` surface is **not supported | ||
| and not planned** — there is no tracking issue. |
Comment on lines
+3
to
+4
| First preview of the rewritten `durable-functions` provider. This is a **preview release**: it is | ||
| published under the `preview` npm dist-tag, and APIs may change before the stable `4.0.0`. |
YunchuWang
added a commit
that referenced
this pull request
Jul 30, 2026
The azure-functions-durable CHANGELOG on main is a placeholder skeleton
("# Changelog" + "## TBD" + a "Details to be finalized" bullet), not the
"## Upcoming"/"## v*" structure update-changelog.js expects. Because #337 and
#339 are independently mergeable, this script must produce a clean changelog
even if #337 lands first against that skeleton. Previously the first run
prepended the new release sections and stranded the old skeleton at the
bottom, yielding a confusing mixed-format file.
Detect only that exact pristine skeleton (CRLF/LF tolerant) and swap in the
standard empty Upcoming scaffold before the existing Upcoming parsing runs, so
the placeholder bullet is never promoted into release notes and modern
"## Upcoming" changelogs (core and the #339 compat rewrite) are unaffected.
Addresses PR #337 review comment r3678561864.
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: d86f5f69-4e1a-4c1d-b017-5e290c85cc05
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.
Splits the documentation and changelog updates out of #335. Zero runtime risk.
What (docs only)
CHANGELOG.md(root — core + azuremanaged notes)packages/azure-functions-durable/CHANGELOG.md(compat)packages/azure-functions-durable/README.md.github/copilot-instructions.mdNo runtime code changes.
Provenance
Content is byte-identical to the CI-green #335 branch at
8501bc0— a pure re-partition, no behavior change.Part of the #335 split
#335 is being decomposed into four mutually independent PRs that can merge in any order:
Together these carry every one of #335's 10 files with no overlap. #335 stays open until the file→PR mapping posted there is confirmed; these PRs neither merge nor close it.