MCPInstall

v5-breaking-changes

by remotion-devMedia & Creative

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.

Installs
390
Last 24h
—
Trending rank
—
Security
Not audited

Install

Works with every agent the skills CLI supports.

npx skills add https://github.com/remotion-dev/remotion --skill v5-breaking-changes
  1. 01

    Install

    Run the command in your project. The CLI asks which agents to install for.

  2. 02

    Describe the task

    Ask your agent for something this skill covers. It loads v5-breaking-changes automatically when relevant.

  3. 03

    Review the result

    The agent follows the SKILL.md steps, scripts and references bundled with the skill.

SKILL.md

The instructions your agent reads when the skill is triggered.

Remotion 5 Breaking Changes

Use the central compile-time flag in packages/core/src/v5-flag.ts:

export const ENABLE_V5_BREAKING_CHANGES = false as const;

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.ENABLE_V5_BREAKING_CHANGES 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:

const effectiveValue =
	value ??
	(NoReactInternals.ENABLE_V5_BREAKING_CHANGES ? v5Default : v4Default);

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:

type VersionedOptions =
	typeof NoReactInternals.ENABLE_V5_BREAKING_CHANGES extends true
		? V5Options
		: V4Options;

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.

Verify the change

Before finishing, check that:

  1. With the flag left as false as const, v4 runtime behavior and public types remain compatible.
  2. Changing only the central flag to true as const selects both the v5 runtime path and v5 public types.
  3. Runtime validation agrees with the conditional TypeScript API.
  4. The migration guide includes the user-facing change.
  5. Focused builds, existing tests, linting, and formatting pass for every affected package.

Do not commit the flag flipped merely to test v5. Restore it to false as const on the shared v4/main line.

The compatibility branches may be removed after v5 no longer shares its implementation with v4.

Source: Remotion 5.0 masterplan implementation mechanism.

FAQ

What does the v5-breaking-changes skill do?

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.

How do I install v5-breaking-changes?

Run npx skills add https://github.com/remotion-dev/remotion --skill v5-breaking-changes in your project. The skills CLI detects the agents you use and copies the skill into the right folder. For Claude Code you can also place the skill folder at ~/.claude/skills/v5-breaking-changes/ (personal) or .claude/skills/v5-breaking-changes/ (project).

Which AI agents can use v5-breaking-changes?

Any agent that supports the open Agent Skills format (a folder with a SKILL.md file), including Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Windsurf, Cline, OpenCode and more.

Is v5-breaking-changes safe to install?

No partner security audit is available yet. Skills can run commands and scripts, so read the SKILL.md and any bundled files before installing.

Who maintains v5-breaking-changes?

It is published by remotion-dev in remotion-dev/remotion. It has 390 recorded installs.

More from remotion-dev/remotion

View all →

web-renderer-test

remotion-dev/remotion

Add explicitly requested web renderer tests or update existing ones for implementation changes.

OfficialTesting & QA2.8K installs

writing-docs

remotion-dev/remotion

Guides for writing and editing Remotion documentation. Use when adding docs pages, editing MDX files in packages/docs, or writing documentation content.

OfficialDocs & Writing2.7K installs

video-report

remotion-dev/remotion

Generate a report about a video

OfficialMedia & Creative2.7K installs

add-sfx

remotion-dev/remotion

Add a new sound effect to @remotion/sfx

OfficialMedia & Creative2.6K installs

docs-demo

remotion-dev/remotion

Add an interactive demo to the Remotion documentation. Use when creating a new component for docs pages.

OfficialDocs & Writing2.4K installs

add-expert

remotion-dev/remotion

Add a new expert to the Remotion experts page

OfficialMedia & Creative2.4K installs

Popular media & creative skills

View category →

hyperframes

heygen-com/hyperframes

Read first to make, edit, animate or render any video with HyperFrames (HTML rendered to video), including launch films, explainers, music videos, charts, maps, vertical clips, title cards, captions and overlays. Holds the render contract, the work loop and what each kind of video needs.

Media & Creative1.2M installs

media-use

heygen-com/hyperframes

Get or make any media for a HyperFrames video - music, sound effects, images, icons, logos, voiceover, avatar and generated video, transcripts, cutouts, colour grades and looks - with HeyGen or free local tools, and mix placed audio. Also for footage that looks dark, flat or dull, or should be stylized or hidden.

Media & Creative1.1M installs

hyperframes-registry

heygen-com/hyperframes

About 450 ready-made HyperFrames blocks and components installed as editable source - transitions, overlays, titles, kinetic type, captions, charts, map overlays, 3D, camera moves. Use it before hand-building any named visual (CRT scanlines, glitch, film grain, a chart); also for hyperframes add and catalog.

Media & Creative1M installs

hyperframes-creative

heygen-com/hyperframes

Non-animation creative direction for HyperFrames videos. Use for design spec (frame.md / design.md) handling, palettes, typography, narration, beat planning, audio-reactive visuals, composition patterns, and brand / style decisions. For atomic motion patterns and scene blueprints, use hyperframes-animation.

Media & Creative916.5K installs

ai-video-generation

101-skills/superpowers

Generate AI videos with Google Veo, Seedance 2.0, HappyHorse, Wan, Grok and 40+ models via inference.sh CLI. Models: Veo 3.1, Veo 3, Seedance 2.0, HappyHorse 1.0, Wan 2.5, Grok Imagine Video, OmniHuman, Fabric, HunyuanVideo. Capabilities: text-to-video, image-to-video, reference-to-video, video editing, lipsync, avatar animation, video upscaling, foley sound. Use for: social media videos, marketing content, explainer videos, product demos, AI avatars. Triggers: video generation, ai video, text to video, image to video, veo, animate image, video from image, ai animation, video generator, generate video, t2v, i2v, ai video maker, create video with ai, runway alternative, pika alternative, sora alternative, kling alternative, seedance, happyhorse

Media & Creative881.5K installs

ai-image-generation

101-skills/superpowers

Generate AI images with GPT-Image-2, FLUX, Gemini, Grok, Seedream, Reve and 50+ models via inference.sh CLI. Models: GPT-Image-2, FLUX Dev LoRA, FLUX.2 Klein LoRA, Gemini 3 Pro Image, Grok Imagine, Seedream 4.5, Reve, ImagineArt. Capabilities: text-to-image, image-to-image, inpainting, LoRA, image editing, upscaling, text rendering. Use for: AI art, product mockups, concept art, social media graphics, marketing visuals, illustrations. Triggers: flux, image generation, ai image, text to image, stable diffusion, generate image, ai art, midjourney alternative, dall-e alternative, text2img, t2i, image generator, ai picture, create image with ai, generative ai, ai illustration, grok image, gemini image, gpt image, openai image, chatgpt image

Media & Creative880.3K installs