feat(learn/userland-migrations): add intro #7764
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
There was a problem hiding this comment.
Pull Request Overview
This PR adds a new introductory documentation page for Node.js userland migrations.
- Introduces a new markdown page with an overview of userland migrations.
- Provides code examples demonstrating how to run a migration and the resulting source modifications.
Codecov ReportAll modified and coverable lines are covered by tests ✅
✅ All tests successful. No failed tests found. Additional details and impacted files@@ Coverage Diff @@
## main #7764 +/- ##
==========================================
+ Coverage 75.10% 75.40% +0.29%
==========================================
Files 98 96 -2
Lines 7914 7867 -47
Branches 196 192 -4
==========================================
- Hits 5944 5932 -12
+ Misses 1969 1934 -35
Partials 1 1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Co-authored-by: Copilot <[email protected]> Signed-off-by: Jacob Smith <[email protected]>
|
|
||
| # Userland Migrations | ||
|
|
||
| Node.js provides migrations for "userland" code to facilitate adoption of new features and upgrading source-code affected by breaking changes. These are done in collaboration with [`codemod`](https://www.codemod.com), who also work with other major projects like Next.js, React, and Tailwind. Node.js's migrations live in the [`github://nodejs/userland-migrations`](https://github.com/nodejs/userland-migrations) repository and are overseen by the [`@userland-migrations`](https://github.com/orgs/nodejs/teams/userland-migrations) team. |
There was a problem hiding this comment.
What is "userland" code?
(I mean, I know what it is, but does the user?)
|
|
||
| Node.js provides migrations for "userland" code to facilitate adoption of new features and upgrading source-code affected by breaking changes. These are done in collaboration with [`codemod`](https://www.codemod.com), who also work with other major projects like Next.js, React, and Tailwind. Node.js's migrations live in the [`github://nodejs/userland-migrations`](https://github.com/nodejs/userland-migrations) repository and are overseen by the [`@userland-migrations`](https://github.com/orgs/nodejs/teams/userland-migrations) team. | ||
|
|
||
| Official migrations are published under the `@nodejs` namespace within the [codemod registry](https://codemod.com/registry?framework=node.js). These have been reviewed and/or authored by Node.js collaborators. There are also unofficial migrations available which have not been reviewed by Node.js. |
There was a problem hiding this comment.
| Official migrations are published under the `@nodejs` namespace within the [codemod registry](https://codemod.com/registry?framework=node.js). These have been reviewed and/or authored by Node.js collaborators. There are also unofficial migrations available which have not been reviewed by Node.js. | |
| Official migrations are published under the [`@nodejs` namespace within the codemod registry](https://codemod.com/registry?framework=node.js&author=nodejs). These migrations have been reviewed and/or authored by Node.js collaborators. There are also unofficial migrations available which have not been reviewed by members of the Node.js Foundation. |
There was a problem hiding this comment.
The author query param is a…bug. They're supposed to be "authored" by the actual github username; there's supposed to be a different param for "official". Codemod are working on it. So I think for now, better to not put anything and update it with the correct params when they're ready?
Re "node.js foundation": there is no such thing as "node.js foundation". There's the node.js project and there's the OpenJS Foundation. Perhaps "members of the Node.js project"?
There was a problem hiding this comment.
Re "node.js foundation": there is no such thing as "node.js foundation". There's the node.js project and there's the OpenJS Foundation. Perhaps "members of the Node.js project"?
That's what I meant, sorry
So I think for now, better to not put anything and update it with the correct params when they're ready?
Got it!
There was a problem hiding this comment.
Cool. Np. I'll update that wording tomorrow 🙂
Co-authored-by: Aviv Keller <[email protected]> Signed-off-by: Jacob Smith <[email protected]>
|
@JakobJingleheimer put this part of learn sestion under user land team in the codeowner |
|
|
||
| # Userland Migrations | ||
|
|
||
| Node.js provides migrations for "userland" (what you write vs node's own) source-code to facilitate adoption of new features and upgrading source-code affected by breaking changes. These are done in collaboration with [`codemod`](https://www.codemod.com), who also work with other major projects like Next.js, React, and Tailwind. Node.js's migrations live in the [`nodejs/userland-migrations`](https://github.com/nodejs/userland-migrations) repository and are overseen by the [`@nodejs/userland-migrations`](https://github.com/orgs/nodejs/teams/userland-migrations) team. |
There was a problem hiding this comment.
user land team is private it's will be a 404 if not in node gh org
There was a problem hiding this comment.
It looks like all teams within the nodejs org are private. Maybe it's not terribly important that it 404s for non-members? At least for members it can still have utility.
Co-authored-by: Augustin Mauroy <[email protected]> Signed-off-by: Jacob Smith <[email protected]>
There does not appear to be a section in codeowners for that. Are you asking me to add one there? |
yeah I mean ad the end of code owners we should add user land migration |
Description
Validation
Related Issues
Resolves #7267
Check List