docs: add workflow import migration note to README - #1192
Conversation
ReviewThanks for adding the migration note — a heads-up here is helpful for anyone who maintains custom workflows. The PR is tiny and low-risk (README-only, no code), but flagging two issues that should be fixed in a follow-up: 1. Broken anchor linkThe link targets GitHub renders that heading's anchor as Fix: either update the link to 2. API name in the note doesn't match the documented APIThe note says:
But the workflows README (and the surrounding Example 4 body) describes the API as Fix: rephrase to refer to Other categories
Once the anchor and the API name are corrected, the migration note will do its job. Small follow-up PR recommended since this already merged. |
Summary
Adds a temporary warning to the root README alerting users to a breaking change in workflow authoring that may require updates to custom workflows using the old import API.
Key Changes
⚠️callout block in the README's workflow section noting that custom workflows importing other workflows by registered name or path object need to be migratedpackages/workflows/README.mdfor migration instructionsMigration Context
This note accompanies the breaking change introduced in #1181 (
feat(workflows)!: TypeBox-native input/output schemas). Workflow imports now use standard TypeScript module imports and pass compiled workflow definitions to.import(workflow, { as? })rather than importing by registered name or path object.