docs: Tell versioning users to call updateBuildIdCompatibility (#1253)

lorensr · web-flow · commit 2b585b69ed97 · 2023-09-29T06:53:06.000-07:00
So they know to do so. Without doing so, they may not realize why their
Workers aren't picking up tasks.
diff --git a/packages/worker/src/worker-options.ts b/packages/worker/src/worker-options.ts
@@ -88,6 +88,9 @@ export interface WorkerOptions {
    *
    * ℹ️ Required if {@link useVersioning} is `true`.
    *
+   * :warning: NOTE: When used with versioning, you must pass this build ID to {@link updateBuildIdCompatibility}.
+   * Otherwise, this Worker will not pick up any tasks.
+   *
    * @default `@temporalio/worker` package name and version + checksum of workflow bundle's code
    *
    * @experimental

Original file line number	Diff line number	Diff line change
`@@ -88,6 +88,9 @@ export interface WorkerOptions {`
`88`	`88`	`*`
`89`	`89`	* ℹ️ Required if {@link useVersioning} is `true`.
`90`	`90`	`*`
	`91`	`+ * :warning: NOTE: When used with versioning, you must pass this build ID to {@link updateBuildIdCompatibility}.`
	`92`	`+ * Otherwise, this Worker will not pick up any tasks.`
	`93`	`+ *`
`91`	`94`	* @default `@temporalio/worker` package name and version + checksum of workflow bundle's code
`92`	`95`	`*`
`93`	`96`	`* @experimental`