Skip to content

Latest commit

 

History

History

README.md

Release-notes corpus for akm help migrate

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/.

Adding notes for a new release

  1. Create <version>.md in this directory (e.g. 0.7.0.md).
  2. 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.
  3. The file ships with the published package via package.jsonfiles[] and is resolved at runtime from either src/ or dist/, so no code change is required.
  4. 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).