SuperAPI AI 工具集

catalog

通用与其它

查看项目

更新于 10-16 07:14

技能介绍

用途:Temporal Catalog 是 temporalio/ui 仓库内的本地开发页面,用于查找、运行、检查、编写和提升 Temporal 工作流示例。示例在代码中声明,生成浏览器读取的产物,并由本仓库启动的 worker 执行。该页面仅在本地开发环境可访问,其他环境返回 404。

主要能力:示例分为两类来源——OSS(提交到仓库的共享示例,位于 src/lib/catalog/worker/examples/<id>/)和 Local(本地示例,位于 catalog.local/examples/<id>/,被 gitignore 忽略)。生成的 src/lib/catalog/browser/catalog.generated.json 列出每个共享示例的能力标签、预期证据、输入 schema 和设置说明。示例页面显示就绪状态(worker 是否在轮询目标任务队列及声明的先决条件)和每次运行的尝试状态及工作流历史证据链接。

使用方式:所有操作通过 pnpm catalog 命令完成。启动用 pnpm catalog dev(同时运行 UI 和 worker,并打印目录 URL,形如 http://localhost:3000/namespaces/default/catalog);pnpm dev 不受目录影响且不启动 worker。其他命令包括 help、scaffold <example-id>、generate、verify、promote <example-id>、demote <example-id>、worker。promote 和 demote 支持 --dry-run 预览。scaffold 创建 catalog.local/examples/<id>/ 下的 example.ts 和 workflow.ts。example.ts 导出 catalogExample,声明 id、标题、描述、能力标签、预期证据、输入与启动选项 schema 及执行逻辑;注册会被校验,未知字段、空必填字符串和不可序列化值会在生成时报错。

配置:命名空间在浏览器中来自 URL,在 worker 中来自 TEMPORAL_NAMESPACE,两者需指向同一命名空间。任务队列仅来自目标的注册,无环境变量覆盖。环境文件分层:.env.catalog(已提交,本地默认地址和命名空间)、.env.catalog.local(未提交,覆盖和凭据)、.env.catalog.local.example(已提交模板)。只能设置一种凭据模式:API key 或客户端证书对(可选私有 CA 证书和服务器名覆盖),混用或半对证书会在启动时报错。地址建议用 127.0.0.1 而非 localhost。

限制:生成产物(catalog.generated.json、catalog.generated.ts 及本地组装文件)不可手动编辑,需运行 pnpm catalog generate;提交前应运行 pnpm catalog verify。只有自包含示例能在两个根目录间移动,若旧共享示例导入自身目录外的文件,demote 会拒绝。提升后示例会提交到仓库并发布给所有使用者,需先审查输入 schema、预期证据和设置说明。Cloud UI 消费 @temporalio/ui 打包的目录,示例提升后需 Cloud 采用新包版本才可用;共享示例不应加入 Cloud 特定假设。