Function defineWorkflows

Remarks

The Blueprints API must register this package's workflowProvider before it can deploy the resulting sanity.workflow resource. Until that server registration ships, deploy definitions with sanity workflows deploy.

Share the authored deployment with defineWorkflowConfig — do not pass a parsed config.deployments[n] (that type leaves the floor unverified so commands that do not submit definitions can load a missing entry).

// shared.ts
import type {WorkflowDeploymentInput} from '@sanity/workflow-engine'
import {articleReview} from './definitions'

export const prod = {
  expectedMinReaderModel: 4,
  name: 'prod',
  tag: 'prod',
  workflowResource: {type: 'dataset', id: 'acme.workflows'},
  definitions: [articleReview],
} satisfies WorkflowDeploymentInput

// sanity.workflow.ts
import {defineWorkflowConfig} from '@sanity/workflow-engine/define'
import {prod} from './shared'

export default defineWorkflowConfig({deployments: [prod]})

// sanity.blueprint.ts
import {defineBlueprint} from '@sanity/blueprints'
import {defineWorkflows} from '@sanity/workflow-blueprint'
import {prod} from './shared'

export default defineBlueprint({
  resources: [defineWorkflows(prod)],
})
Copy