Upgrading

Versioning policy

karaoke-cms follows semantic versioning. Breaking changes only happen on major version bumps (1.0, 2.0, …). Patch and minor releases within a major version are safe to apply.

Current version: v0.x (pre-1.0). While in v0.x, breaking changes may occur on minor version bumps (0.16 → 0.17, etc.). Once 1.0 ships, the standard semver guarantee applies.

How to upgrade

Update all karaoke-cms packages together. Using pnpm:

pnpm update @karaoke-cms/astro \
  @karaoke-cms/module-blog \
  @karaoke-cms/module-docs \
  @karaoke-cms/module-tags \
  @karaoke-cms/module-seo \
  @karaoke-cms/module-search \
  @karaoke-cms/module-comments \
  @karaoke-cms/theme-default

Or with npm:

npm update @karaoke-cms/astro \
  @karaoke-cms/module-blog \
  @karaoke-cms/module-docs \
  @karaoke-cms/module-tags \
  @karaoke-cms/module-seo \
  @karaoke-cms/module-search \
  @karaoke-cms/module-comments \
  @karaoke-cms/theme-default

After upgrading, clear the Astro content cache and verify the build:

rm -rf apps/website/.astro
pnpm dev
# or for a full production verification:
pnpm build

Where to find breaking changes

• CHANGELOG.md in the karaoke-cms GitHub repository — full release history with breaking change notices
• /reference/70.changelog — rendered changelog on this site

Check the CHANGELOG entry for each version you are skipping over before upgrading across multiple minor versions.

Migration guides

No migration guide yet — we are still in v0.x. Check the CHANGELOG for what changed in each release. Breaking changes are clearly marked.

When 1.0 ships, a migration guide will be published here.