Skip to content

Conversation

@elithrar
Copy link
Collaborator

@elithrar elithrar commented Apr 1, 2025

DO NOT MERGE

This PR documents the new waitForEvent API in Workflows and other minor changes:

Later

@elithrar elithrar added the product:workflows Workflows: https://developers.cloudflare.com/workflows/ label Apr 1, 2025
@elithrar elithrar self-assigned this Apr 1, 2025
@elithrar elithrar requested review from a team and celso as code owners April 1, 2025 22:55
@elithrar elithrar mentioned this pull request Apr 1, 2025
9 tasks
@github-actions github-actions bot added the size/s label Apr 1, 2025
@hyperlint-ai
Copy link
Contributor

hyperlint-ai bot commented Apr 1, 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

Documented the new waitForEvent API in Workflows and made several updates to existing documentation.

  • Added documentation for the waitForEvent API in Workflows.
  • Updated events documentation to include new ways to pass parameters.
  • Introduced a human-in-the-loop concept with examples.
  • Updated best practices in the Rules of Workflows.

Modified Files

  • src/content/docs/workflows/build/events-and-parameters.mdx

Added Files

  • src/content/changelog/workflows/2025-04-07-workflows-human-in-the-loop copy.mdx
  • src/content/changelog/workflows/2025-04-07-workflows-human-in-the-loop.mdx
  • src/content/docs/workflows/build/human-in-the-loop.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.

@github-actions
Copy link
Contributor

github-actions bot commented Apr 1, 2025

@elithrar elithrar mentioned this pull request Apr 2, 2025
2 tasks
@github-actions github-actions bot added size/m and removed size/s labels Apr 2, 2025
@elithrar elithrar enabled auto-merge (squash) April 6, 2025 14:41
@Oxyjun Oxyjun disabled auto-merge April 6, 2025 17:16
@elithrar elithrar enabled auto-merge (squash) April 6, 2025 20:24
@elithrar elithrar merged commit 9bc1757 into production Apr 6, 2025
11 checks passed
@elithrar elithrar deleted the workflows/waitForEvent branch April 6, 2025 20:34
RebeccaTamachiro pushed a commit that referenced this pull request Apr 21, 2025
* workflows: new docs

* update

* remove beta badge

* limits

* pricin

* waitForEvent more

* hidden: true

* flesh out examples

* changelog done

* final

* Apply suggestions from code review

Co-authored-by: Jun Lee <[email protected]>

* ok

---------

Co-authored-by: Jun Lee <[email protected]>
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.

8 participants