docs: worker page restrcture - #5001
Open
lennessyy wants to merge 4 commits into
Open
Conversation
Gives all four pages the same six sections as the Go, Python, and TypeScript pages: create and run, register types, connect to Cloud, configure options, run a versioned Worker, shut down. - Adds a versioned Worker section. None of these pages documented Worker Versioning. - Replaces hand-written code with snipsync snippets for Java, .NET, and Ruby. Rust stays inline because the features repo has no Rust harness. - Notes that a versioning behavior only applies on a Worker with versioning enabled. Declaring one without it makes the server reject the Workflow Task. - Rewrites the Rust page against temporalio-sdk 0.5.0. The previous code used execute_activity, which only exists on the SDK's unreleased main branch, and omitted the ? that register_workflow requires. Existing anchor IDs are preserved because other pages link to them. Every Worker was run against a local dev server and completed a Workflow. Snippet bodies for Java, .NET, and Ruby come from temporalio/features#861 and need that PR merged before the next snipsync run.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
📖 Docs PR preview links
|
- .NET: the shutdown section referred to "the token passed to ExecuteAsync()" when the reader had only ever passed CancellationToken.None. Shutting a Worker down is a start-time decision in .NET, so the section now shows creating a CancellationTokenSource and passing its Token, and the first section explains what CancellationToken.None does instead of only warning against it. - Rust: move the Cargo.toml dependencies ahead of the code that needs them, and rename "Register types" to match the other pages. The anchor comment sets the heading id, so #register-types is unchanged. - Ruby: tighten the run_all description, and move the shutdown_signals and cancellation details into the shutdown section rather than forward-referencing them from the first section.
Follow-up to #4980, applying the same pass done for the other four SDKs. - Python: the shutdown snippet used interrupt_event, which the page never defined. The SNIPSTART boundary in the features repo excludes the enclosing function that declares it. Adds the entry point that sets the event. - Python: run() installs no signal handlers and polls until shutdown() is called, so "the Worker runs until the process is interrupted" was inaccurate. - TypeScript: lowercase the operating system signals. Signal is a Temporal core term, so the capitalized form read as a Workflow Signal. - TypeScript: drop the paragraph in the first section that restated the registration rule the next section already states, and document per-Workflow versioningBehavior through setWorkflowOptions. - Go: document DefaultVersioningBehavior, that it requires UseVersioning, and that a Workflow with no behavior fails at registration time. - Go: name the Worker instead of "It" in the shutdown section.
lennessyy
changed the title
lennessyy
changed the title
The registration section on all seven pages said a Task for an unregistered type fails and "The Workflow Execution itself does not fail." The second half holds for Workflow Tasks but not Activity Tasks: sdk-go fails an unregistered Activity Task deliberately so it retries, and exhausting the Activity's Retry Policy can fail the Workflow. Drops that claim and states up front that a Task Queue does not route by type, which is why the same-registration rule exists at all. Removes the .NET dependency injection section. Temporalio.Extensions.Hosting is a separate package, DI there applies to Activities and never to Workflows, and the section implied otherwise by registering a Workflow in the same chain. Nothing linked to the anchor. Cuts hedging from the TypeScript page, most of it in the older Docker content: "you might want to," "it is generally possible," "we recommended," "it's probably because." Two of those hid the actual fact. The Node.js memory default is wrong in Docker because it reads the host's memory rather than the container limit, and a distroless build fails outright because npm is absent, rather than "might result in various error messages."
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| [`NODE_OPTIONS` environment variable](https://nodejs.org/api/cli.html#node_optionsoptions). | ||
| Pass this argument through the [`NODE_OPTIONS` environment variable](https://nodejs.org/api/cli.html#node_optionsoptions). | ||
|
|
||
| ### Do not use Alpine |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'Do not use Alpine' should use sentence-style capitalization.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Finishes the Worker page restructure started in #4980, then fixes what a reader's-path pass turned up across all seven pages. PHP is left alone.
Depends on temporalio/features#861, which adds the snippets the Java, .NET, and Ruby pages pull from. Merge it first, or the next
yarn snipsyncrun will empty them.Restructure: Java, .NET, Ruby, Rust
These four get the same six sections as the Go, Python, and TypeScript pages: create and run, register types, connect to Cloud, configure options, run a versioned Worker, shut down.
temporalio-sdk0.5.0. The previous code did not compile.Every Worker was built and run against a local dev server and completed a Workflow, both basic and versioned: Java 1.30.1, .NET 1.17.0, Ruby 1.6.0, Rust 0.5.0. That turned up one constraint, now documented on each page: a versioning behavior is only valid on a Worker with versioning enabled. Otherwise the server rejects the Workflow Task and it retries indefinitely rather than failing.
Fixes: all seven pages
Reading each page top to bottom as a first-time reader found several places where the prose assumed something the reader had not been shown yet.
ExecuteAsync()" when the only token they had passed wasCancellationToken.None. Shutting a Worker down is a start-time decision in .NET, so that section now shows creating aCancellationTokenSource.interrupt_eventin the shutdown snippet without ever defining it. TheSNIPSTARTboundary excludes the enclosing function that declares it, so the page now shows the entry point that sets the event.run()installs no signal handlers and polls untilshutdown()is called.Temporalio.Extensions.Hostingis a separate package, its DI applies to Activities and never to Workflows, and the section implied otherwise by registering a Workflow in the same chain. Nothing linked to the anchor.npmis absent.Cargo.tomlappearing after the code that needs it.yarn buildpasses with no broken links or anchors, and Vale CI-scoped is clean.Unrelated break
yarn snipsyncfails onmainfor everyone.snipsync.config.yamlpinssamples-dotnettoea/aws-lambda, which has been deleted. Not fixed here.🤖 Generated with Claude Code
┆Attachments: EDU-6856 Restructure the Java, .NET, Ruby, and Rust Worker pages