docs: align Worker Options with the API - #500
Open
yhwang-nydig wants to merge 2 commits into
Open
Conversation
The Worker Options section documented a deploymentName field that does not exist in WorkerOptions (the Temporal deployment name is always derived from the Kubernetes namespace and WorkerDeployment name, and is not user-configurable), while omitting the unsafeCustomBuildID field that does exist. Replace the phantom field with the real one — including its workflow-safety caveat inline — and state the deployment-name derivation explicitly, cross-linking the TEMPORAL_DEPLOYMENT_NAME section that already describes it.
yhwang-nydig
requested review from
a team,
eniko-dif and
jlegrone
as code owners
August 5, 2026 18:48
|
|
jaypipes
approved these changes
Aug 6, 2026
jaypipes
left a comment
jaypipes
left a comment
Collaborator
There was a problem hiding this comment.
just aligns the docs, cool with me. thank you @yhwang-nydig
jaypipes
enabled auto-merge (squash)
August 6, 2026 16:46
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
3 participants
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.
The Worker Options section documented a
deploymentNamefield that does not exist. This replaces it withunsafeCustomBuildID, includes its safety caveat, and clarifies how the Temporal deployment name is derived.