feat(migrate): add dryRun to context

[nkgentile]

Description

When running a migration, there may be side-effects like calling a third-party API, or using client to make Sanity requests. A developer may wish to log those effects rather than actually executing them in a dry run.

import { defineMigration } from "sanity/migrate";

/**
 * Run this migration with
 * `npx sanity migration run my-migration`
 */
export default defineMigration({
  title: "my-migration",

  // pass whether the migration is a dry-run as context
  async *migrate(documents, { dryRun }) {
    for await (const document of documents()) {
      if(dryRun) {
        // Only log the effect
        console.log(`Something happened`)
      } else {
        // Execute the side-effect
        await thirdPartyRequest();
      }
      // ... do something with the document, maybe yield patches
    }
  },
});

What to review

Testing

I manually tested that the flag comes through the context in both async generator and object definition formats

Notes for release

Adds a dryRun flag to the context argument in migration scripts

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
page-building-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 31, 2024 8:45am
performance-studio	✅ Ready (Inspect)	Visit Preview		May 31, 2024 8:45am
test-compiled-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 31, 2024 8:45am
test-next-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 31, 2024 8:45am
test-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 31, 2024 8:45am

1 Ignored Deployment

Name	Status	Preview	Comments	Updated (UTC)
studio-workshop	⬜️ Ignored (Inspect)	Visit Preview		May 31, 2024 8:45am

[vercel]

@nkgentile is attempting to deploy a commit to the Sanity Team on Vercel.

A member of the Team first needs to authorize it.

[bjoerge]

Very useful – thanks @nkgentile!