Skip to content

Internal: Document site version compatibility contract #9457

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
samohovets merged 1 commit into from
Jul 22, 2026
Merged

Internal: Document site version compatibility contract #9457

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions packages/renderer/src/set-props-and-env.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -282,6 +282,11 @@ const innerSetPropsAndEnv = async ({
timeoutInMilliseconds: actualTimeout,
});

// Increment this value when the generated bundle format or behavior changes

@pullfrog pullfrog Bot Jul 22, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// Increment this value when the generated bundle format or behavior changes
// Increment this value when the generated bundle format or behavior changes
// in a backwards-incompatible way. It is not the Remotion package version and
// should not be bumped for every generated HTML change. Keep it synchronized
// with window.siteVersion in packages/studio-shared/src/studio-html.ts and
// with packages/core/src/index.ts (which types window.siteVersion) by
// incrementing all values together.
const requiredVersion: typeof window.siteVersion = '11';

// in a backwards-incompatible way. It is not the Remotion package version and
// should not be bumped for every generated HTML change. Keep it synchronized
// with window.siteVersion in packages/studio-shared/src/studio-html.ts by
// incrementing both values.
const requiredVersion: typeof window.siteVersion = '11';

if (siteVersion !== requiredVersion) {
Expand Down
5 changes: 5 additions & 0 deletions packages/studio-shared/src/studio-html.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,11 @@ export const studioHtml = ({
<script>window.remotion_packageManager = ${JSON.stringify(packageManager)}</script>
<script>window.remotion_publicFolderExists = ${JSON.stringify(publicFolderExists)};</script>
<script>
// Increment this value when the generated bundle format or behavior changes
// in a backwards-incompatible way. It is not the Remotion package version
// and should not be bumped for every generated HTML change.
// Keep it synchronized with requiredVersion in
// packages/renderer/src/set-props-and-env.ts by incrementing both values.
window.siteVersion = '11';
window.remotion_version = '${VERSION}';
</script>
Expand Down
Loading