code-transform.mdx §ID Generation omits the package-shipped `name@version` ID form

未关闭 适合新手
#3,154 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

@Mohith26 已经在做这个了。

开始于 2026年7月28日。

  • #3161 来自 @Mohith26 —— 未关闭

评估

难度
1/5
预计耗时
1 小时以内
新手友好度
90/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
冷清
技术栈
typescript
领域
documentation

调研方向

打开 how-it-works/code-transform.mdx,并定位 v4:309-329 或 v5:311-329 处的“ID Generation”部分。将其本地文件形式与 packages/builders/src/module-specifier.ts:370-402 生成的随包发布形式进行比较,然后记录各自何时适用,以完善该部分。

由索引模型根据 Issue 内容生成。

描述

Summary

how-it-works/code-transform.mdx §"ID Generation" (v4:309-329, v5:311-329) documents only the local-file ID form {type}//{filepath}//{functionName} and never mentions the package-shipped form {type}//{name}/{subpath}@{version}//{functionName} (produced by packages/builders/src/module-specifier.ts:370-402 for export-reachable package files).

Not wrong, but incomplete in exactly the direction that made the #3152 error plausible: a reader learns IDs come from file paths, so "re-export into my workflows/ dir → my path → my ID" is a natural inference — the same inference #3153 corrects in publishing-libraries.mdx.

Suggested fix

Add the package-shipped form to the ID Generation section, next to the local-file form, with one line on when each applies (workspace/local files vs. export-reachable npm package files). The section's existing callout already states deployment pinning correctly ("changing IDs won't break old workflows from running, but will prevent runs from being upgraded"), so only the ID-form table/list needs the addition.

Related: #3152, #3153. Found during a docs sweep while building the Mastra integration.

主要语言
TypeScript
星标
2.5k
派生
401
平均合并
2 天 36 分钟
30 天内合并 PR
150

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 有 Pull Request 模板
  • 没有贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

vercel/workflow 的其他 Issue

查看 vercel/workflow 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。