Skip to content

[Workflows] Document saga rollbacks#30976

Merged
mia303 merged 5 commits into
productionfrom
workflows/add-rollbacks
Jun 5, 2026
Merged

[Workflows] Document saga rollbacks#30976
mia303 merged 5 commits into
productionfrom
workflows/add-rollbacks

Conversation

@mia303

@mia303 mia303 commented May 20, 2026

Copy link
Copy Markdown
Contributor

Documentation checklist

@github-actions github-actions Bot added product:changelog product:workflows Workflows: https://developers.cloudflare.com/workflows/ size/m labels May 20, 2026
@github-actions

github-actions Bot commented May 20, 2026 •
edited
Loading

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/changelog/ @cloudflare/pm-changelogs, @cloudflare/product-owners
/src/content/docs/workflows/ @elithrar, @rita3ko, @irvinebroque, @vy-ton, @celso, @deloreyj, @mia303, @jonesphillip, @cloudflare/product-owners

@ask-bonk ask-bonk Bot added documentation Documentation edits product:workers Related to Workers product triage Waiting for a docs team review. labels May 20, 2026
@mia303 mia303 force-pushed the workflows/add-rollbacks branch from ce7d7d3 to ca1862e Compare May 20, 2026 20:31
ask-bonk[bot]
ask-bonk Bot reviewed May 20, 2026
View reviewed changes

@ask-bonk ask-bonk Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

3 suggestions posted.

MEDIUM — src/content/docs/workflows/build/sleeping-and-retrying.mdx line 137: New Workers code example uses a bare ts fence instead of TypeScriptExample.

LOW — src/content/changelog/workflows/2026-05-22-saga-rollbacks.mdx line 7: Changelog date field includes a time component; use YYYY-MM-DD only.

LOW — src/content/docs/workflows/build/workers-api.mdx line 212: TypeScript type alias uses lowercase. Use PascalCase to match the API type name.

Note: For the TypeScriptExample change, add import { TypeScriptExample } from "~/components"; after the frontmatter block in sleeping-and-retrying.mdx.

Comment thread src/content/changelog/workflows/2026-05-22-saga-rollbacks.mdx Outdated
Comment thread src/content/docs/workflows/build/sleeping-and-retrying.mdx
Comment thread src/content/docs/workflows/build/workers-api.mdx Outdated
@ask-bonk

ask-bonk Bot commented May 20, 2026

Copy link
Copy Markdown
Contributor

3 suggestions posted, and labels documentation, product:workers, and triage applied.

Summary of the PR
This PR documents the new saga rollback feature for Cloudflare Workflows. It adds:

  • A changelog entry announcing the capability.
  • A new "Register rollback handlers" section in the sleeping-and-retrying guide.
  • Updated step.do() API signatures and a new "Rollback options" reference section.
  • The rollback field added to InstanceStatus type documentation.
  • New rollback lifecycle events in the metrics and analytics reference.

Issues flagged

MEDIUM — src/content/docs/workflows/build/sleeping-and-retrying.mdx line 137: New Workers code example uses a bare ts fence. The style guide requires TypeScriptExample for all Workers JS/TS examples. An inline suggestion was posted; you'll also need to add import { TypeScriptExample } from "~/components"; after the frontmatter block.

LOW — src/content/changelog/workflows/2026-05-22-saga-rollbacks.mdx line 7: Changelog date field includes a time component (12:00:00 UTC). Existing changelog entries use YYYY-MM-DD only.

LOW — src/content/docs/workflows/build/workers-api.mdx line 212: TypeScript type alias uses lowercase (type options = {). It should be PascalCase (WorkflowStepRollbackOptions) to match the API signature and TypeScript conventions.

No broken links, missing frontmatter, or MDX syntax errors were found.

github run

@mia303 mia303 force-pushed the workflows/add-rollbacks branch 2 times, most recently from 191bbe9 to aa632f1 Compare May 20, 2026 20:55
@github-actions

github-actions Bot commented May 20, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Preview URL: https://98977c3a.preview.developers.cloudflare.com
Preview Branch URL: https://workflows-add-rollbacks.preview.developers.cloudflare.com

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/workflows/build/workers-api/ https://workflows-add-rollbacks.preview.developers.cloudflare.com/workflows/build/workers-api/
https://developers.cloudflare.com/workflows/build/sleeping-and-retrying/ https://workflows-add-rollbacks.preview.developers.cloudflare.com/workflows/build/sleeping-and-retrying/
https://developers.cloudflare.com/changelog/post/2026-06-05-saga-rollbacks/ https://workflows-add-rollbacks.preview.developers.cloudflare.com/changelog/post/2026-06-05-saga-rollbacks/
https://developers.cloudflare.com/workflows/build/trigger-workflows/ https://workflows-add-rollbacks.preview.developers.cloudflare.com/workflows/build/trigger-workflows/
https://developers.cloudflare.com/workflows/observability/metrics-analytics/ https://workflows-add-rollbacks.preview.developers.cloudflare.com/workflows/observability/metrics-analytics/

@nyreegloriani2-prog nyreegloriani2-prog mentioned this pull request May 20, 2026
Open
@vaishnav-mk vaishnav-mk mentioned this pull request May 21, 2026
Merged
5 tasks
vaishnav-mk
vaishnav-mk suggested changes May 21, 2026
View reviewed changes
Comment thread src/content/changelog/workflows/2026-05-22-saga-rollbacks.mdx Outdated
Comment thread src/content/docs/workflows/build/sleeping-and-retrying.mdx Outdated
Comment thread src/content/docs/workflows/build/sleeping-and-retrying.mdx Outdated
Comment thread src/content/docs/workflows/build/sleeping-and-retrying.mdx Outdated
Comment thread src/content/docs/workflows/build/workers-api.mdx Outdated
mia303
mia303 commented May 21, 2026
View reviewed changes
Comment thread src/content/changelog/workflows/2026-05-22-saga-rollbacks.mdx Outdated
Comment thread src/content/docs/workflows/build/sleeping-and-retrying.mdx Outdated
Comment thread src/content/docs/workflows/build/sleeping-and-retrying.mdx Outdated
Comment thread src/content/docs/workflows/build/sleeping-and-retrying.mdx Outdated
Comment thread src/content/docs/workflows/build/workers-api.mdx Outdated
@mia303
Apply suggestions from code review
81cbd0b 
Co-authored-by: mia303 <mmalden@cloudflare.com>
@mia303 mia303 marked this pull request as ready for review May 21, 2026 12:58
@mia303 mia303 requested review from a team, celso, elithrar and jonesphillip as code owners May 21, 2026 12:58
@marciojpflorindo marciojpflorindo mentioned this pull request May 24, 2026
Open
@github-actions github-actions Bot mentioned this pull request May 25, 2026
Open
@cloudflare-docs-bot

cloudflare-docs-bot Bot commented Jun 2, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Review

✅ No style-guide issues found in commit 98977c3.

Commands

Only codeowners can run commands. Post a comment with the command to trigger it.

Command Description
/review Runs a review now. Incremental if a prior review exists, full if not.
/full-review Re-reviews the entire PR diff from scratch, ignoring incremental history. Useful after a rebase, when you want a fresh review, or if the bot gets out of sync and reports issues that no longer exist.

@mia303 mia303 merged commit 8ff891d into production Jun 5, 2026
11 checks passed
@mia303 mia303 deleted the workflows/add-rollbacks branch June 5, 2026 16:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ask-bonk ask-bonk[bot] ask-bonk[bot] left review comments
@jonesphillip jonesphillip jonesphillip approved these changes
@elithrar elithrar Awaiting requested review from elithrar elithrar is a code owner
@celso celso Awaiting requested review from celso celso is a code owner
@rita3ko rita3ko Awaiting requested review from rita3ko rita3ko is a code owner
@irvinebroque irvinebroque Awaiting requested review from irvinebroque irvinebroque is a code owner
@vy-ton vy-ton Awaiting requested review from vy-ton vy-ton is a code owner
@deloreyj deloreyj Awaiting requested review from deloreyj deloreyj is a code owner
+1 more reviewer
@vaishnav-mk vaishnav-mk vaishnav-mk requested changes
Reviewers whose approvals may not affect merge requirements

Assignees

@celso celso

@elithrar elithrar

@jonesphillip jonesphillip

Labels

do-not-merge-yet documentation Documentation edits product:changelog product:workers Related to Workers product product:workflows Workflows: https://developers.cloudflare.com/workflows/ size/m triage Waiting for a docs team review.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@mia303 @jonesphillip @vaishnav-mk @celso @elithrar