Versions and support
From 1.0.0, SonicFrame follows Semantic Versioning: the number of a version says what it may change, so you can update without reading the code again.
What each number means
| A new version like | May bring |
|---|---|
| 1.0.1 (patch) | Fixes only. Nothing you use changes, except a behavior that was wrong. |
| 1.1.0 (minor) | New features, each off until you turn it on, and new names for old ones, which keep working. Your code goes on working as it is. |
| 2.0.0 (major) | The only kind of version where something you use can stop working. Every such change is listed in advance in the Upgrade guide. |
What the promise covers
Everything the docs describe:
-
the four entries and what they export:
sonicframe,sonicframe/player,sonicframe/analysisandsonicframe/record; - the options, methods, events and types in the Reference;
-
the
<sonic-player>and<sonic-recorder>tags, their attributes and theirsonicframe:events; - the CSS variables and the plugin API.
It does not cover what the docs leave out: the elements
and class names inside a player, the exact pixels of a
drawing, files imported from inside
dist/ instead of through an entry, and the
words a screen reader hears, which may get clearer in
any version.
Defaults stay
A new version does not change how your page looks or behaves by default: every new feature starts off, and a default changes only in a major version, or to fix a bug.
Old names keep working
When a name changes, the old one keeps working, the same way, until the next major version:
- it is marked as deprecated, so your editor strikes it through and says what to use;
- when a page gives both, the new name wins;
- the changelog lists it under Deprecated.
The Upgrade guide lists every old name and what 2.0 will remove.
Which versions get fixes
Fixes, security fixes included, go into the latest 1.x release. The 0.x versions get none; moving from 0.8 to 1.0 changes nothing in your code.
Found a vulnerability? Report it privately, as SECURITY.md explains, rather than in a public issue.
How a version is published
Every version from 1.0.0 is published to npm by the repository's own GitHub workflow, never from a personal computer. npm adds a provenance statement saying from which repository and commit the package was built, and shows it on the package's page. To check the packages installed in your project:
npm audit signatures