docs: document the package-shipped name@version step ID form - #3161
Open
Mohith26 wants to merge 1 commit into
Open
docs: document the package-shipped name@version step ID form#3161Mohith26 wants to merge 1 commit into
Mohith26 wants to merge 1 commit into
Conversation
The ID Generation section of how-it-works/code-transform.mdx (v4 and v5)
only documented the local-file ID form {type}//{filepath}//{functionName}.
Steps and workflows shipped in export-reachable npm/workspace package files
instead get IDs of the form {type}//{name}[/{subpath}]@{version}//{functionName},
produced by resolveModuleSpecifier() in packages/builders/src/module-specifier.ts
and format_name()/get_module_path() in
packages/swc-plugin-workflow/transform/src/naming.rs.
Document both forms side by side, note when each applies, and clarify that
re-exporting a package's step from local files does not change its ID while
a package version bump does.
Fixes vercel#3154
|
Contributor
|
@Mohith26 is attempting to deploy a commit to the Vercel Labs Team on Vercel. A member of the Team first needs to authorize it. |
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
1 participant
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.
Fixes #3154, reported by @pranaygp.
The ID Generation section of how-it-works/code-transform.mdx (v4 and v5) only documented the local-file ID form
{type}//{filepath}//{functionName}. Steps and workflows shipped in export-reachable package files instead get{type}//{name}[/{subpath}]@{version}//{functionName}, produced by resolveModuleSpecifier() in the builders and format_name() in the SWC plugin.This documents both forms side by side, when each applies, and clarifies that re-exporting a package's step from local files does not change its ID. Content is source-verified against the resolver and plugin naming code.