Skip to content

Add docs for steps that return readable streams#29393

Merged
Caio-Nogueira merged 1 commit intoproductionfrom
caio/workflows-readable-stream
Mar 27, 2026
Merged

Add docs for steps that return readable streams#29393
Caio-Nogueira merged 1 commit intoproductionfrom
caio/workflows-readable-stream

Conversation

@Caio-Nogueira
Copy link
Copy Markdown
Contributor

@Caio-Nogueira Caio-Nogueira commented Mar 27, 2026

Summary

We're adding the option of returning a ReadableStream<Uint8Array> from workflow steps. This PR adds documentation, with examples and usage guidelines for this new pattern

  • Is there a changelog entry (guidelines)? If you don't add one for something awesome and new (however small) — how will our customers find out? Changelogs are automatically posted to RSS feeds, the Discord, and X.
  • The change adheres to the documentation style guide.
  • If a larger change - such as adding a new page- an issue has been opened in relation to any incorrect or out of date information that this PR fixes.
  • Files which have changed name or location have been allocated redirects.

@github-actions github-actions bot added product:workflows Workflows: https://developers.cloudflare.com/workflows/ size/m labels Mar 27, 2026
@github-actions
Copy link
Copy Markdown
Contributor

This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:

Pattern Owners
/src/content/docs/workflows/ @elithrar, @celso, @mia303, @jonesphillip, @cloudflare/pcx-technical-writing
* @cloudflare/pcx-technical-writing

Comment thread src/content/docs/workflows/build/rules-of-workflows.mdx Outdated
Comment thread src/content/docs/workflows/build/rules-of-workflows.mdx Outdated
Comment thread src/content/docs/workflows/build/rules-of-workflows.mdx Outdated
Comment thread src/content/docs/workflows/build/rules-of-workflows.mdx Outdated
Comment thread src/content/docs/workflows/build/rules-of-workflows.mdx Outdated
Comment thread src/content/docs/workflows/build/rules-of-workflows.mdx Outdated
Comment thread src/content/docs/workflows/build/workers-api.mdx Outdated
@Caio-Nogueira Caio-Nogueira force-pushed the caio/workflows-readable-stream branch from 255babf to 77f64c3 Compare March 27, 2026 15:23
@Caio-Nogueira Caio-Nogueira force-pushed the caio/workflows-readable-stream branch from 77f64c3 to e80a074 Compare March 27, 2026 16:28
Comment thread src/content/docs/workflows/build/rules-of-workflows.mdx Outdated
Comment thread src/content/docs/workflows/build/workers-api.mdx Outdated
Comment thread src/content/docs/workflows/build/workers-api.mdx Outdated
Comment thread src/content/docs/workflows/build/workers-api.mdx Outdated
Apply suggestions from code review

Co-authored-by: mia303 <mmalden@cloudflare.com>
@Caio-Nogueira Caio-Nogueira force-pushed the caio/workflows-readable-stream branch from 2c4d367 to f41822a Compare March 27, 2026 17:59
@Caio-Nogueira Caio-Nogueira merged commit d01b08b into production Mar 27, 2026
11 checks passed
@Caio-Nogueira Caio-Nogueira deleted the caio/workflows-readable-stream branch March 27, 2026 18:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

product:workflows Workflows: https://developers.cloudflare.com/workflows/ size/m

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants