Skip to content

Draft: Workers event notifications#31826

Draft
yomna-shousha wants to merge 2 commits into
productionfrom
workers-notifs
Draft

Draft: Workers event notifications#31826
yomna-shousha wants to merge 2 commits into
productionfrom
workers-notifs

Conversation

@yomna-shousha

Copy link
Copy Markdown
Contributor

Draft reference page for Workers event notifications via Queues event subscriptions. Covers gradual deployment events, deployment/version lifecycle, routing, secrets/tags/settings, account-level events, and Workers for Platforms — with milestone 1 and milestone 2 breakdown.

@github-actions

github-actions Bot commented Jul 1, 2026

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/workers/ @cloudflare/workers-docs, @GregBrimble, @irvinebroque, @mikenomitch, @korinne, @WalshyDev, @cloudflare/deploy-config, @cloudflare/product-owners, @cloudflare/wrangler, @MattieTK, @cloudflare/dev-plat-leads, @vy-ton

@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.

PR Review: Workers event notifications reference

Summary

This PR adds a new reference page (event-notifications.mdx) cataloging Workers lifecycle and configuration events available through Queues event subscriptions. The page is well-structured into event sources, Milestone 1 (gradual deployments, lifecycle, routing, secrets/settings, account-level, and Workers for Platforms), and Milestone 2 (granular settings). Links are valid and frontmatter is mostly complete.

Issues flagged — needs maintainer attention

1. Duplicate version.created event with conflicting semantics (lines 56 and 89)
The same event name and type field (cf.workers.worker.version.created) is used for two completely different concepts:

  • Line 56: "A new version was explicitly uploaded (for example, wrangler versions upload)"
  • Line 89: "A versioned setting was changed (bindings, limits, placement)"

This appears to be a copy-paste error. These should have distinct event names and type values so customers can differentiate them.

Suggested fix: Rename the settings-table entry to something like settings.versionedUpdated with a corresponding type of cf.workers.worker.settings.versionedUpdated (or whatever the actual product API uses).

2. Draft content in a Note admonition (lines 92–94)

:::note[Open question]
Secret changes create new versions under the hood. These events may collapse into `version.created` in a future revision — to be determined based on whether customers prefer granular secret-level events or version-level events.
:::

The :::note[Open question] framing signals that the product behavior is undecided. Published docs should not contain unresolved product deliberations. Please resolve this before merging — either remove the note, convert it to a standard :::note with settled guidance, or move the context to an internal doc.

Style / polish suggestions

3. Unused component import (line 14)
Render is imported but never used on the page. Remove the import:

- import { Render } from "~/components";

4. Redundant <title> tag in frontmatter (lines 7–9)
Starlight automatically generates the <title> tag from the title: field. The head: block is unnecessary here and can be removed:

- head:
-   - tag: title
-     content: Event notifications

5. Missing Oxford comma (line 90)
Per the style guide, use an Oxford comma in lists of three or more:

- | `settings.updated` | `cf.workers.worker.settings.updated` | An unversioned setting was changed (observability, logpush, tail consumers, subdomain) |
+ | `settings.updated` | `cf.workers.worker.settings.updated` | An unversioned setting was changed (observability, logpush, tail consumers, and subdomain) |

Labels

Applying content, workers, documentation.

@ask-bonk ask-bonk Bot added content:new Request for new/missing content triage Waiting for a docs team review. labels Jul 1, 2026
@ask-bonk

ask-bonk Bot commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Done. Here's a summary of my review on PR #31826:

Labels applied

  • content:new — this is a new reference page
  • triage — flagged for docs team review
  • product:workers was already present

Summary of the PR

This PR adds a new reference page (src/content/docs/workers/configuration/event-notifications.mdx) that catalogs Workers lifecycle and configuration events available through Queues event subscriptions. It's organized by event source (workers, workers.worker, workers.dispatchNamespace) and split into Milestone 1 (current events) and Milestone 2 (future granular settings events). Coverage includes gradual deployments, version/deployment lifecycle, routing, secrets/tags/settings, account-level events, and Workers for Platforms.

Issues flagged

Critical — needs maintainer attention before merge:

  1. Duplicate/conflicting version.created event (lines 56 and 89) — The same event name and type field (cf.workers.worker.version.created) is used for two different concepts: "A new version was explicitly uploaded" vs. "A versioned setting was changed." This looks like a copy-paste error and needs distinct identifiers.

  2. Draft content in a Note admonition (lines 92–94) — The :::note[Open question] block frames a product decision as unresolved. Published docs should not contain open product deliberations.

Style / polish:

  1. Unused importRender is imported but never used.
  2. Redundant head: frontmatter — Starlight auto-generates <title> from title:; the head: block is unnecessary.
  3. Missing Oxford comma in the settings description on line 90.

All of this has been posted as a review comment on PR #31826.

github run

@yomna-shousha

Copy link
Copy Markdown
Contributor Author

this will not be merged in

@yomna-shousha yomna-shousha marked this pull request as draft July 1, 2026 14:07
@github-actions

github-actions Bot commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

content:new Request for new/missing content product:workers Related to Workers product size/m triage Waiting for a docs team review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants