Implement planned topic: 0027-worker-version-reporting#204
Open
skill-temporal-developer-updater[bot] wants to merge 1 commit into
Open
Implement planned topic: 0027-worker-version-reporting#204skill-temporal-developer-updater[bot] wants to merge 1 commit into
skill-temporal-developer-updater[bot] wants to merge 1 commit into
Conversation
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
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.
Validation Report — Worker Version Reporting (TypeScript)
Branch:
draft/0027-worker-version-reportingScope: unstaged diff to
references/typescript/versioning.md(this branch has no commits beyondmain; the change is in the working tree). Roughly 30 lines added under a new H3 "Build ID reporting without enabling Worker Versioning" plus four citation comments appended to pre-existing bullets.Plan:
VALIDATION_PLAN.mdValidator constraint: authored files and
../documentation/docs/only; no authoring artifacts read.Go / no-go
<!-- VERIFY: ... -->flag was not resolved)<!-- VERIFY: ... -->editorial marker)Overall verdict: RE-RUN AUTHORING. The four bullets added to the pre-existing "Configuration options" list are fine and individually well-cited; the new "Build ID reporting without enabling Worker Versioning" section is not grounded in the documentation and discloses a configuration the docs do not describe as supported. Send the new section back through authoring; keep the four-bullet citation addition.
Check 1 findings — citation audit
9 citation comments added by the diff. 8 resolve cleanly; 1 has a wrong path.
Finding 1.1 — wrong file path
<!-- docs/develop/typescript/versioning.mdx:36-38 -->find documentation/docs -name versioning.mdxfinds language versioning pages atdocs/develop/{lang}/workflows/versioning.mdx(note the/workflows/segment). There is nodocs/develop/typescript/versioning.mdx.docs/develop/typescript/workflows/versioning.mdx. Lines 36–38 there are:Statistics: 8 / 9 = 88.9 % clean. Below the 98 % threshold.
Check 2 findings — reverse-grep audit
Finding 2.1 — central claim not found in docs (matches the author's
VERIFYmarker)The new H3 section (lines 185–214 of
references/typescript/versioning.md) asserts:Grep results across
../documentation/docs/:useWorkerVersioning(camelCase) appears only inside the TS Worker-Versioning example atproduction-deployment/worker-deployments/worker-versioning.mdx:214and the deprecateduseVersioningatdevelop/typescript/worker-versioning-legacy.mdx. Both contexts present it as part of enabling Worker Versioning, not as an independently optional flag.worker-versioning.mdx:141-148treatsUseVersioning,Version, andDefaultVersioningBehavioras the trio of "configuration parameters to toggle on Worker Versioning" — no mention of supplyingVersionwithoutUseVersioning.version-without-useWorkerVersioningconfiguration, "Build ID reporting" as a stand-alone mode, or "reports Build ID without enabling versioning routing".kubernetes-controller.mdx:40: "When a Worker starts polling for Workflow and Activity Tasks, it reports its Deployment Version to the Temporal Server." — sits in a Worker Versioning context, not a "without enabling versioning" context.The author flagged this themselves in the
<!-- VERIFY: ... -->comment on line 187, which asks for confirmation against@temporalio/workertypings that this configuration is "a supported shape rather than just permitted by the type system." The validator cannot resolve a VERIFY that targets SDK source. The unresolved VERIFY itself is the finding: shipping with an editorial-review marker indicates the claim wasn't grounded before publication.Finding 2.2 —
<!-- VERIFY: ... -->marker left in shipped prosereferences/typescript/versioning.md:187carries the full multi-sentence editorial note inside an HTML comment. It is invisible to a human reader of the rendered markdown, but agents that strip HTML comments may behave correctly and agents that don't will see editor's-notebook content. Either way, aVERIFYis an authoring-pass artifact; it must be either resolved (claim re-grounded) or the surrounding section removed.Check 3 findings — regression on known bugs
Zero hits.
--profile,TEMPORAL_TLS_CLIENT_*_PATH,tcld service-account,--output text/jsonl, orsaas-api.tmprl.cloud:7233in the diff.buildId/useVersioningfields are referenced only in the explicit "Do not use the legacy top-levelbuildId/useVersioningfields" warning at line 214 — the supported "don't do X, do Y" form. Acceptable.buildId/deploymentNamecamelCase is correct throughout.Check 4 findings — independent re-verification (n = 9)
Sample size: all 9 cited claims in the diff.
useWorkerVersioningenables Worker VersioningUseVersioning: This enables the Versioning functionality for this Worker."version.deploymentNameis the logical service nameVersionas deployment-name + build-ID pairversion.buildIdidentifies a builddefaultVersioningBehavioroptional; if unset, every Workflow type must declare its owntemporal worker deployment describe-versionin the version-without-useWorkerVersioning configurationdescribe-versionoutput, but for fully versioned workers. The cited lines do not establish that thereport-onlyconfiguration makes Deployment Versions visible. The citation supports a weaker claim ("describe-version exists and shows these fields") than the authored sentence requires.useWorkerVersioning: trueUseVersioning"enables the Versioning functionality." The inverse (no useVersioning → no pinning) is plausibly inferred but not stated at the cited line. Inverse is reasonable but the citation is adjacency rather than direct support.buildId/useVersioningfields are the deprecated pre-2025 APIWorker.create({ buildId, useVersioning: true })form under a Deprecated cautionMatch rate: 6 strict matches + 1 path-only failure (claim still correct) + 1 weak + 1 mismatch = 6 / 9 strict = 66.7 % or, charitably counting #6 and #8 as matches, 7–8 / 9 ≈ 77–88 %. Either way below the 95 % threshold.
The mismatch (#5) and the weak citation (#6) both load-bear for the new H3 section's "use this configuration to get Build IDs into visibility without committing to versioning routing" thesis. Without those two, the section's "When to use" bullet has no factual grounding.
Check 5 findings
Not an integration topic. Skipped.
Check 6 findings — tone and scope
Finding 6.1 — workaround disclosure (MAJOR, pattern 1)
The entire new H3 "Build ID reporting without enabling Worker Versioning" section (lines 185–214) reads as a classic workaround-disclosure pattern:
useWorkerVersioning: truetogether withversion.versionalone, here's a configuration that does that, and here's when to reach for it."<!-- VERIFY: ... -->admits this may be "permitted by the type system" rather than "a supported shape."Agents reading this will adopt the configuration. If it turns out to be type-permitted but unsupported (server-side rejection, undefined server-side behavior, or behavior that changes when the SDK is updated), the result is broken user code attributable to skill guidance.
Per the plan's verdict rubric, a pattern-1 finding alone is MAJOR.
Finding 6.2 — editorial marker shipped in prose (pattern 2)
references/typescript/versioning.md:187contains the multi-sentence<!-- VERIFY: ... -->comment in the middle of the prose. This is an authoring-pass artifact and should be either resolved (with a new citation) or removed with its surrounding section.Other patterns
Patterns 2 (other instances), 3, and 4 — clean.
Statistics
useVersioningat top-level — appropriately framed as "don't use")version-without-useWorkerVersioningreporting mode)Recommended action
RE-RUN AUTHORING for the new H3 section (
references/typescript/versioning.md:185–214). Three possible outcomes:<!-- VERIFY: ... -->with a real citation (SDK source, release notes, or a docs PR) and rewrite the "Build ID reporting" framing so it doesn't read like a workaround.Keep, with one path fix: the four citation comments appended to the pre-existing "Configuration options" bullets (lines 180–183) are correct and add real grounding to existing prose. The
defaultVersioningBehaviorbullet (line 183) is a useful addition.Path fix: change
<!-- docs/develop/typescript/versioning.mdx:36-38 -->on line 214 to<!-- docs/develop/typescript/workflows/versioning.mdx:36-38 -->.