Internal: Document site version compatibility contract - #9457
Merged
Conversation
samohovets
enabled auto-merge (squash)
July 22, 2026 11:10
Contributor
There was a problem hiding this comment.
ℹ️ No critical issues — one rough edge in the documented contract.
Reviewed changes — add inline comments documenting when and how to bump siteVersion, and cross-reference the two files that currently hardcode '11'.
- Document the site version compatibility contract — explain in
packages/renderer/src/set-props-and-env.tsthatrequiredVersionshould only be bumped on backwards-incompatible bundle changes, and cross-reference the emitted value inpackages/studio-shared/src/studio-html.ts. - Mirror the note in the HTML emitter — add the same guidance above
window.siteVersion = '11'inpackages/studio-shared/src/studio-html.tswith a reference back to the renderer.
Kimi K2 (free via Pullfrog for OSS) (Claude Opus not used — the program covers this model; add its provider key to run your pick) ｜ 𝕏
| timeoutInMilliseconds: actualTimeout, | ||
| }); | ||
|
|
||
| // Increment this value when the generated bundle format or behavior changes |
Contributor
There was a problem hiding this comment.
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'; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
11Verification
bunx oxfmt packages/studio-shared/src/studio-html.ts packages/renderer/src/set-props-and-env.ts --writebun run buildbun run stylecheckgit diff --checkCloses #9456