Skip to main content

Upgrade Guide

This guide helps you upgrade between versions of cm-admin. Each version has its own guide listing breaking changes, method renames, and migration steps.

A guide is published for every release that needs action from the host app, such as new generators or migrations, breaking or deprecated APIs, and configuration changes. Releases without a guide can be upgraded by bumping the gem version. When you skip several versions, apply each guide in order, oldest first. Every release, with or without a guide, is listed in the Changelog.

For AI Agents​

  • Before upgrading, read every guide between the app's current version and the target version, oldest first. releases.json lists every release. Entries that have a guide also include upgrade_guide_url and requires_manual_intervention.
  • When a guide starts with a Manual intervention required notice, or requires_manual_intervention is true, don't apply that upgrade automatically. Summarize the steps for the user and get their confirmation before you run commands or change code.
  • Major version upgrades always need the user's confirmation.

Versions​