Skip to content

docs: add data migration scripts section #12975

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.

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

Merged

Conversation

SteelRazor47
Copy link
Contributor

I finally had some free time to add this section on data migration scripts, closes #12738

I copied most of the description from the release notes from v2.3.0, as I found them to be well written, and I simply added a basic example to illustrate the function signature(taken from packages/medusa/src/migration-scripts/migrate-product-shipping-profile.ts).

Let me know if I should change anything. I made sure to run it locally to check that it looked ok(which took me a few minutes, you are supposed to have a .env in www/apps/book otherwise the build fails. Very simple and straightforward but it isn't mentioned in the docs contribution guide, should it be added?)

@SteelRazor47 SteelRazor47 requested a review from a team as a code owner July 16, 2025 10:34
Copy link

changeset-bot bot commented Jul 16, 2025

⚠️ No Changeset found

Latest commit: b053d18

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Jul 16, 2025

Someone is attempting to deploy a commit to the medusajs Team on Vercel.

A member of the Team first needs to authorize it.

@shahednasser shahednasser self-requested a review July 18, 2025 07:28
Copy link
Member

@shahednasser shahednasser left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your contribution! I've added comments for fixes and changes.

SteelRazor47 and others added 2 commits July 18, 2025 10:26
Co-authored-by: Shahed Nasser <[email protected]>
@SteelRazor47
Copy link
Contributor Author

should be all done

Copy link
Member

@shahednasser shahednasser left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM thanks!

@shahednasser shahednasser merged commit ed39a37 into medusajs:develop Jul 18, 2025
24 of 34 checks passed
@SteelRazor47
Copy link
Contributor Author

Thank you for the edits really, now it is much more understandable especially for new users. Always appreciate your work, the medusa docs are some of the best I've seen 👍

@SteelRazor47 SteelRazor47 deleted the docs/data-migration-scripts branch July 18, 2025 11:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

missing docs on how to create data migration scripts
2 participants