Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(publishing-guide): add publish with studio option #1343

Merged
merged 1 commit into from
Sep 30, 2024
Merged

docs(publishing-guide): add publish with studio option #1343

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion apps/docs/sharing/publishing-codemods.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This guide will walk you through the steps needed to publish codemods to [Codemo
There are three ways to publish codemods to Codemod Registry:
1. [publishing a codemod package](#option-1-publishing-a-codemod-compatible-package-recommended)
2. [publishing from source file](#option-2-publishing-a-codemod-from-source-file)
3. publishing with Codemod Studio (Coming soon)
3. [publishing with Codemod Studio](#option-3-publishing-with-codemod-studio)

<Tip>
Publishing codemods to the registry is especially useful for framework/library builders. With features like shareable codemod deep links and Codemod CLI & IDE extenion, your users can adopt your latest releases with one click, straight from your migration doc. <Tooltip tip="MSW V2 migration">[See example ->](https://mswjs.io/docs/migrations/1.x-to-2.x/#codemods)</Tooltip>
Expand Down Expand Up @@ -62,6 +62,21 @@ Creating and publishing a [Codemod-compatible package](/building-codemods/packag
</Step>
</Steps>

### Option 3: Publishing with Codemod Studio

After building a codemod with Codemod Studio, you can instantly publish it to your private registry to quickly run it over your local project(s).

To do so, you can click `Run with CLI`. After publishing the codemod, you will be able to run the codemod using Codemod CLI while being logged in with the same user used on Codemod Studio.

To run the codemod, you can simply copy the exported command in the pop-up modal and run the command on any local codebase of your choice.

<video
autoPlay
loop
className="w-full aspect-video"
src="/images/codemod-studio/studio-publish.mp4"
></video>

## Unpublishing codemods

To unpublish a codemod from Codemod Registry, you can use the [`codemod unpublish` command](/deploying-codemods/cli#codemod-unpublish).
Loading