Skip to content

workflows: serializable #20776

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Mar 21, 2025
Merged

workflows: serializable #20776

merged 1 commit into from
Mar 21, 2025

Conversation

@elithrar
Copy link
Collaborator

@elithrar elithrar commented Mar 13, 2025

clarifies return type of step.do

@elithrar elithrar requested review from a team, ToriLindsay and celso as code owners March 13, 2025 11:44
@hyperlint-ai
Copy link
Contributor

hyperlint-ai bot commented Mar 13, 2025

Howdy and thanks for contributing to our repo. The Cloudflare team reviews new, external PRs within two (2) weeks. If it's been two weeks or longer without any movement, please tag the PR Assignees in a comment.

We review internal PRs within 1 week. If it's something urgent or has been sitting without a comment, start a thread in the Developer Docs space internally.

PR Change Summary

Clarified the return type of the step.do method to ensure that returned state is serializable.

  • Added a note on the importance of returning serializable state from a step.
  • Specified which types can be serialized and which cannot.
  • Updated documentation to prevent errors related to non-serializable objects.

Modified Files

  • src/content/docs/workflows/build/workers-api.mdx
How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

What is Hyperlint?

Hyperlint is an AI agent that helps you write, edit, and maintain your documentation.

Learn more about the Hyperlint AI reviewer and the checks that we can run on your documentation.

@github-actions github-actions bot added the product:workflows Workflows: https://developers.cloudflare.com/workflows/ label Mar 13, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Mar 13, 2025

Preview URL: https://50604225.preview.developers.cloudflare.com
Preview Branch URL: https://elithrar-patch-25.preview.developers.cloudflare.com

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/workflows/build/workers-api/ https://elithrar-patch-25.preview.developers.cloudflare.com/workflows/build/workers-api/

@elithrar elithrar merged commit 1f62c31 into production Mar 21, 2025
12 checks passed
@elithrar elithrar deleted the elithrar-patch-25 branch March 21, 2025 13:31
RebeccaTamachiro pushed a commit that referenced this pull request Apr 21, 2025
@elithrar @RebeccaTamachiro
workflows: serializable (#20776)
2787848
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@TownLake TownLake TownLake approved these changes

@Oxyjun Oxyjun Oxyjun approved these changes

@ToriLindsay ToriLindsay Awaiting requested review from ToriLindsay

@celso celso Awaiting requested review from celso celso is a code owner

Assignees

@celso celso

@ToriLindsay ToriLindsay

Labels

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

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@elithrar @TownLake @Oxyjun @celso @ToriLindsay