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

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#3,154 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

@Mohith26 đang làm issue này rồi.

Từ ngày 28/7/2026.

  • #3161 của @Mohith26 — đang mở

Đánh giá

Độ khó
1/5
Thời gian dự kiến
Dưới một giờ
Mức phù hợp với người mới
90/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Ít trao đổi
Công nghệ
typescript
Lĩnh vực
documentation

Hướng nghiên cứu

Mở how-it-works/code-transform.mdx và tìm phần “ID Generation” tại v4:309-329 hoặc v5:311-329. So sánh dạng dành cho tệp cục bộ của phần này với dạng được đóng gói và phát hành do packages/builders/src/module-specifier.ts:370-402 tạo ra, sau đó ghi lại khi nào mỗi dạng được áp dụng để hoàn thiện phần này.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
TypeScript
Star
2.5k
Fork
401
Merge trung bình
2 ngày 36 phút
Pull request đã merge (30 ngày)
150

Chuẩn bị môi trường

  • Không có Dockerfile hay tệp Docker Compose
  • Có mẫu pull request
  • Không có hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của vercel/workflow

Tất cả issue của vercel/workflow

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.