Agent skill · software engineering · remotion-dev
v5-breaking-changes
Implement or review a Remotion 5 breaking change while the v4 and v5 release lines still share code. Use when v4 behavior and public types must remain compatible on main, but flipping the central v5 flag should activate a new runtime behavior, default, or TypeScript API.
Why this skill is useful
Provides specific implementation patterns and TypeScript API management for handling breaking changes between Remotion v4 and v5 that the AI wouldn't reliably generate on its own.
What it needs
About 2k tokens when loaded. Last updated 2026-08-06. 55,698 stars on the source repository.
What this skill does
Remotion 5 Breaking Changes Use the central compile-time flag in packages/core/src/v5-flag.ts: Preserve the compile-time flag Keep the flag as the literal false as const on the v4/main release line. Do not turn it into an environment variable, runtime option, or general boolean. Its literal type selects the public TypeScript API as well as runtime behavior. Do not introduce another v5 flag. Inside packages/core, import the flag from v5-flag.ts. From another package, use NoReactInternals.ENABLEV5BREAKINGCHANGES from remotion/no-react so all packages use the same value. When the v5 release line is cut, changing this one constant to true as const must activate the v5 runtime behavior and public TypeScript API together. Gate runtime behavior Branch defaults and behavior on the central flag while preserving the existing v4 path: An explicit user value should continue to take precedence unless the v5 API intentionally removes that value. Keep runtime validation aligned with the selected public type so JavaScript callers and callers bypassing TypeScript get the v5 behavior too. Gate public types For a breaking signature or options change, select the entire incompatible part with a conditional type based on the literal flag: The v4 branch must expose the compatible API. The v5 branch must expose only the intended v5 API; do not leave removed fields optional or union both versions together. Use these existing implementations as references: packages/renderer/src/v5-required-input-props.ts for required options in v5. packages/renderer/src/open-browser.ts for removing an option from a public type while retaining v4 compatibility. packages/google-fonts/src/base.ts for pairing a conditional public type with runtime enforcement. Document every user-facing break Add or update the corresponding entry in packages/docs/docs/5-0-migration.mdx. State: what changed in v5; the v4 behavior or signature; how users should migrate; replacement code or options where useful. …
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills remotion-dev/v5-breaking-changes