[Workflows] add subscribe documentation and changelog - #33361
Open
mkuritsu wants to merge 4 commits into
Open
Conversation
mkuritsu
force-pushed
the
rcorreia/add-workflows-subscription
branch
3 times, most recently
from
September 10, 2026 11:06
cedce7f to
8289de2
Compare
mia303
requested changes
Sep 10, 2026
mkuritsu
force-pushed
the
rcorreia/add-workflows-subscription
branch
from
September 10, 2026 15:24
476d4d7 to
959c8e6
Compare
5 tasks
mkuritsu
force-pushed
the
rcorreia/add-workflows-subscription
branch
from
September 11, 2026 10:02
959c8e6 to
8374265
Compare
mkuritsu
marked this pull request as ready for review
September 11, 2026 14:21
mkuritsu
requested review from
a team,
celso,
deloreyj,
irvinebroque,
jonesphillip,
rita3ko and
vy-ton
as code owners
September 11, 2026 14:21
Contributor
Review
👉 Fix in your agent 👈Fix the following review findings in PR #33361 (https://github.com/cloudflare/cloudflare-docs/pull/33361).
Before making changes, review each finding and present a brief summary table:
- For each finding, state whether you agree, disagree, or need clarification
- If you disagree (e.g. the fix requires disproportionate effort for minimal benefit,
or the finding is factually incorrect), explain why
- If you need clarification before deciding, ask those questions
- Then share your plan for which issues to tackle and in what order
After triaging, follow this order:
1. Post a comment on this PR for any findings you are skipping, with the finding ID and your reasoning.
2. Then commit the fixes for the legitimate findings.
The comment must come before the commit — the bot reads PR comments when a new
push triggers a review, so skip comments posted after the push will be missed.
---
## Code Review
### Warnings (1)
#### CR-637d8152e80a · Incorrect API description
- **File:** `src/content/docs/workflows/build/workers-api.mdx` line 775
- **Issue:** The text claims each `next()` call "returns the next matching `WorkflowInstanceEvent`". The sibling page added in this PR (`subscribe-to-instance-events.mdx`) shows `next()` returns an async-iterator result: `const result = await subscription.next(); if (result.done) break; console.log(result.value.type, ...)`. Following this wording, a user would treat the result directly as the event (e.g. `event.type`) instead of `result.value.type`, producing undefined fields.
- **Fix:** Reword to say each `next()` call returns the next iterator result (`{ done, value }`) whose `value` is the matching `WorkflowInstanceEvent`, matching the examples in the linked Subscribe to events page.
Code ReviewThis code review is in beta and may not always be helpful — use your judgment. Warnings (1)
ConventionsNo convention issues found. Style Guide ReviewNo style-guide issues found. CommandsOnly codeowners can run commands. Post a comment with the command to trigger it.
|
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.
Summary
This PR adds documentation and changelog entry for the new workflows subscribe feature.
Documentation checklist