migration-guidance

Use when changing how a v3 public API maps to v4, editing migration annotations, or regenerating migration/v3-to-v4.md.

Install
npx skills add 'https://github.com/Effect-TS/effect/tree/main/.agents/skills/migration-guidance'
Download bundle ↓
main · 90695b0Scanned 2026-09-15

Contributors

GitHub-linked commit authors for this SKILL.md at the saved revision. Co-authors and history before file renames are not included.

File history ↗

generation.md

generation.mdBrowse 3 files
View on GitHub
← Back to SKILL.md

Generated Migration Reference

migration/v3-to-v4.md is generated. Check annotations and regenerate using explicit committed refs containing the change:

pnpm api-diff --base-ref origin/v3 --head-ref HEAD --check
pnpm api-diff --base-ref origin/v3 --head-ref HEAD --write-doc migration/v3-to-v4.md

The API diff reads refs through detached worktrees. If the API change is uncommitted, HEAD does not contain it. Update known annotation IDs, defer the check and regeneration, and report the limitation. Do not create a temporary commit solely to run the tool.

Referenced from SKILL.md