This directory holds one .md file per release. Each file is the short,
focused migration note that akm help migrate <version> prints to the
terminal. The longform cross-release guides (e.g. v0.5-to-v0.6.md)
live one level up in docs/migration/.
- Create
<version>.mdin this directory (e.g.0.7.0.md). - Write plain text — the content is printed verbatim. Start the body
with a line like
Migration notes for akm v0.7.0, then list the automatic migrations, manual actions, publisher changes, etc. - The file ships with the published package via
package.json→files[]and is resolved at runtime from eithersrc/ordist/, so no code change is required. - Link to the longform guide in the last paragraph if one exists.
Keep each note self-contained: it should tell a user everything they need to upgrade without requiring them to open a browser (the longform guide link is the last resort, not the first).