Skip to content

[docs] Document hookForceClaim for World authors and spec version 8 - #4361

Merged
pranaygp merged 1 commit into
mainfrom
workflow-docs-cleanup-thu-24-sept
Sep 24, 2026
Merged

pranaygp merged 1 commit into
mainfrom
workflow-docs-cleanup-thu-24-sept

Conversation

@pranaygp

Copy link
Copy Markdown
Contributor

Follow-up docs for PRs that landed in the last day. #4193 shipped its user-facing docs and #4353 added cross-links; this fills the World-author and reference gaps that were left.

createHook({ experimental_force: true }) (#4193)

  • worlds/upgrading-to-v5: hookForceClaim in the capabilities list, plus a "Hook token takeover" row describing what a World must guarantee before advertising it
  • worlds/building-a-world: hookForceClaim in WorldCapabilities; mintedSpecVersion() now stamps 8 by default (was documented as 7)
  • configuration/runtime-tuning: WORKFLOW_SEALED_LOG=0 stamps runs below spec 8, so their hook tokens can't be taken over
  • world/storage: claimedFrom in the Hook type table
  • workflow/define-hook: create() takes the same options as createHook(), including experimental_force

Nothing more needed for #4326, #4124, or #3908.

Preview

🤖 Generated with Claude Code

Follow-up to #4193: add the hookForceClaim capability and its contract to
the World author guides, update the default minted spec version to 8, note
WORKFLOW_SEALED_LOG=0's effect on hook takeover, list Hook.claimedFrom in
the storage reference, and point defineHook().create() at experimental_force.

Co-Authored-By: Claude <noreply@anthropic.com>

Co-Authored-By: Pranay Prakash <1797812+pranaygp@users.noreply.github.com>
@pranaygp
pranaygp requested a review from a team as a code owner September 24, 2026 16:09
Copilot AI lite review requested due to automatic review settings September 24, 2026 16:09

Copilot AI 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.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@vercel

vercel Bot commented Sep 24, 2026 •

Copy link
Copy Markdown
Contributor

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
example-nextjs-workflow-turbopack Ready Ready Preview, v0 Sep 24, 2026 4:12pm UTC
example-nextjs-workflow-webpack Ready Ready Preview, v0 Sep 24, 2026 4:12pm UTC
example-workflow Ready Ready Preview, v0 Sep 24, 2026 4:12pm UTC
workbench-astro-workflow Ready Ready Preview, v0 Sep 24, 2026 4:12pm UTC
workbench-express-workflow Ready Ready Preview, v0 Sep 24, 2026 4:12pm UTC
workbench-fastify-workflow Ready Ready Preview, v0 Sep 24, 2026 4:12pm UTC
workbench-hono-workflow Ready Ready Preview, v0 Sep 24, 2026 4:12pm UTC
workbench-nestjs-workflow Ready Ready Preview, v0 Sep 24, 2026 4:12pm UTC
workbench-nitro-workflow Ready Ready Preview, v0 Sep 24, 2026 4:12pm UTC
workbench-nuxt-workflow Ready Ready Preview, v0 Sep 24, 2026 4:12pm UTC
workbench-python-workflow Ready Ready Preview, v0 Sep 24, 2026 4:12pm UTC
workbench-sveltekit-workflow Ready Ready Preview, v0 Sep 24, 2026 4:12pm UTC
workbench-tanstack-start-workflow Ready Ready Preview, v0 Sep 24, 2026 4:12pm UTC
workbench-vite-workflow Ready Ready Preview, v0 Sep 24, 2026 4:12pm UTC
workflow-docs Ready Ready Preview, v0 Sep 24, 2026 4:12pm UTC
workflow-swc-playground Ready Ready Preview, v0 Sep 24, 2026 4:12pm UTC
workflow-tarballs Ready Ready Preview, v0 Sep 24, 2026 4:12pm UTC
workflow-web Ready Ready Preview, v0 Sep 24, 2026 4:12pm UTC

@changeset-bot

changeset-bot Bot commented Sep 24, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 4fd537f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions

Copy link
Copy Markdown
Contributor

Sim World

Simulated world deterministic testing for races. Traces

🟠 world-sim scenario book — 1 fail of 42 total

fence=per-spec

scenario outcome events virt replay violations
✅ smoke-no-steps completed 3 0ms ok 0
✅ smoke-one-step completed 6 0ms ok 0
✅ hook-at-step-started completed 12 0ms ok 0
✅ hook-at-step-completed completed 12 0ms ok 0
✅ hook-at-hook-created completed 12 0ms ok 0
✅ deadline-hook-wins completed 7 1.0h ok 0
✅ deadline-expires completed 7 1.0h ok 0
✅ step-vs-timer-early-settlement completed 8 1.0h ok 0
✅ long-sleep completed 11 30.0d ok 0
✅ hook-never-arrives stalled 3 0ms skipped 0
✅ step-retries-twice completed 10 2.0s ok 0
✅ parallel-steps completed 9 0ms ok 0
✅ hook-on-execution-state completed 12 0ms ok 0
✅ peek-hook-before-branch completed 12 0ms ok 0
✅ peek-hook-after-branch completed 12 0ms ok 0
✅ peek-hook-at-registration completed 12 0ms ok 0
✅ race-hook-before-probe completed 12 0ms ok 0
✅ race-hook-after-probe completed 12 0ms ok 0
✅ race-duplicate-delivery completed 13 0ms ok 0
✅ attr-hook-before-step completed 11 0ms ok 0
✅ attr-hook-after-step completed 11 0ms ok 0
✅ attr-from-step-body completed 13 0ms ok 0
✅ fork-hook-after-timeout completed 14 1.0m ok 0
✅ fork-hook-before-timeout completed 14 1.0m ok 0
✅ count-hook-after-timeout completed 17 1.0m ok 0
✅ count-hook-before-timeout completed 20 1.0m ok 0
✅ stale-read-step-count-fork completed 20 1.0m ok 0
✅ stale-read-equal-step-counts completed 14 1.0m ok 0
✅ step-vs-step-fork completed 12 0ms ok 0
✅ step-vs-step-fork-fenced completed 12 0ms ok 0
✅ fence-catches-benign-direction completed 12 5ms ok 0
✅ in-flight-before-decision completed 17 1.0m ok 0
❌ in-flight-before-decision-counted completed 17 1.0m ok 0
✅ in-flight-after-decision completed 19 2.0m ok 0
✅ stale-read-step-count-fork-fenced completed 20 1.0m ok 0
✅ fork-hook-wins completed 13 1.0m ok 0
✅ fork-timeout-wins completed 13 1.0m ok 0
✅ unclaimed-payload-under-fork completed 17 1.0m ok 0
✅ claimed-payload-under-fork completed 17 1.0m ok 0
✅ writers-independent-step-bodies completed 12 0ms ok 0
✅ writers-scripted-tempo completed 12 0ms ok 0
✅ cancel-mid-step cancelled 7 0ms skipped 0

Full trace: world-sim.txt

@pranaygp
pranaygp merged commit 98234f3 into main Sep 24, 2026
66 checks passed
@pranaygp
pranaygp deleted the workflow-docs-cleanup-thu-24-sept branch September 24, 2026 17:15
@github-actions

Copy link
Copy Markdown
Contributor

No backport to stable for 98234f3 (AI decision).

This commit documents new capabilities (hookForceClaim, createHook({ experimental_force: true }), Hook.claimedFrom, and the bump of the default minted spec version to 8) that were introduced by feature PR #4193 on main. Documenting new capabilities is feature work, not a documentation correction, and the described behavior does not exist on stable, so backporting it would misdescribe the maintenance line.

To override, re-run the Backport to stable workflow manually via workflow_dispatch and paste this commit SHA into the ref input:

98234f3730724b5275e17308b4c5cb37cf2fe244

This branch was successfully deployed

18 active deployments
Preview – workflow-swc-playground — 4fd537fd Deployed Sep 24, 2026 by vercel[bot]
Preview – workflow-docs — 4fd537fd Deployed Sep 24, 2026 by vercel[bot]
Preview – example-nextjs-workflow-webpack — 4fd537fd Deployed Sep 24, 2026 by vercel[bot]
Preview – workbench-sveltekit-workflow — 4fd537fd Deployed Sep 24, 2026 by vercel[bot]
Preview – workbench-vite-workflow — 4fd537fd Deployed Sep 24, 2026 by vercel[bot]
Preview – workbench-tanstack-start-workflow — 4fd537fd Deployed Sep 24, 2026 by vercel[bot]
Preview – workbench-nuxt-workflow — 4fd537fd Deployed Sep 24, 2026 by vercel[bot]
Preview – workbench-express-workflow — 4fd537fd Deployed Sep 24, 2026 by vercel[bot]
Preview – example-workflow — 4fd537fd Deployed Sep 24, 2026 by vercel[bot]
Preview – workflow-tarballs — 4fd537fd Deployed Sep 24, 2026 by vercel[bot]
Preview – workbench-hono-workflow — 4fd537fd Deployed Sep 24, 2026 by vercel[bot]
Preview – workbench-astro-workflow — 4fd537fd Deployed Sep 24, 2026 by vercel[bot]
Preview – workbench-nitro-workflow — 4fd537fd Deployed Sep 24, 2026 by vercel[bot]
Preview – workbench-fastify-workflow — 4fd537fd Deployed Sep 24, 2026 by vercel[bot]
Preview – workbench-nestjs-workflow — 4fd537fd Deployed Sep 24, 2026 by vercel[bot]
Preview – example-nextjs-workflow-turbopack — 4fd537fd Deployed Sep 24, 2026 by vercel[bot]
Preview – workflow-web — 4fd537fd Deployed Sep 24, 2026 by vercel[bot]
Preview – workbench-python-workflow — 4fd537fd Deployed Sep 24, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants