DF Runtime Migration Notes Template
Release Summary
- Release date:
YYYY-MM-DD - Affected packages:
@designful/df-player-web,@designful/df-runtime-core, ... - Breaking level:
minor | major
Deprecations Added
| Deprecated API | Replacement API | Warning Since | Planned Removal |
|---|---|---|---|
oldApi() | newApi() | vX.Y.Z | vA.B.0 |
Behavior Changes
List behavior-level changes that do not necessarily rename APIs:
- playback/render-loop ordering updates
- event emission order changes
- default option precedence changes
Required Migration Steps
- Replace deprecated APIs with replacements.
- Verify event ordering assumptions in integration tests.
- Verify runtime/player options against latest defaults.
- Re-run
npm run lintand relevant runtime/docs tests.
Compatibility Test Checklist
- Public API surface snapshot updated
- Deprecated alias warning flow covered by tests
- Interaction parity tests still pass
- Pre-ready command queue tests still pass
Example Before/After
// Before
player.startRenderLoop()
player.dispose()
// After
player.startRendering()
player.destroy()