Changelog

Changelog — optional user-facing "What's new"

Changelog generation is off by default. Read this skill only when the app's agent-native.config.ts enables changelog.enabled; otherwise do not create pending entries for ordinary app changes.

Every template app keeps a CHANGELOG.md of the 100 most recent user-facing release sections and a changelog/ folder of dated entry files for the complete history. The top-level file links to that folder for older updates at the end of the file. The in-app command menu (Cmd+K → "What's new") and settings page read both surfaces together, so folder-backed history remains visible without making the top-level file grow forever.

Package release histories follow the same compact shape: the 100 newest package release sections stay in the root CHANGELOG.md, while older sections live in changelog/archive/CHANGELOG.md. The package archive is nested so it cannot be mistaken for a new app entry by the Vite changelog loader.

When to add an entry

Add an entry whenever you ship something a user of that app would notice:

• a new capability or surface,
• a visible improvement (speed, layout, copy, defaults),
• a bug fix that affects behavior they'd see.

Do not add entries for refactors, internal tooling, tests, dependency bumps, or anything invisible to the end user. The changelog is product notes, not a commit log — write it the way you'd describe the change to a customer.

How to add an entry

From the app directory (the template you changed):

agent-native changelog add "Recordings can be trimmed before sharing" --type added
agent-native changelog add "Faster transcript search" --type improved
agent-native changelog add "Fixed a crash when opening an empty folder" --type fixed

--type is one of added, improved, fixed, changed, removed, security (aliases like feature, bugfix, enhancement are accepted). This writes changelog/<date>-<slug>.md — one file per change, so parallel work never conflicts. You can also hand-write that file; the frontmatter is just:

---
type: added
date: 2026-06-23
---
Recordings can be trimmed before sharing.

Writing good entries

• One user-facing sentence, present tense, no internal jargon or file names.
• Lead with the benefit ("Recordings can be trimmed…"), not the mechanism.
• Markdown is allowed (bold, links) but keep it short — it renders as a bullet.

Releasing

release refreshes the recent 100-section window in CHANGELOG.md from every dated entry in changelog/. It deliberately keeps the folder files as the canonical history, so rerunning the command is safe and older updates remain available to the app and to repository readers:

agent-native changelog release            # refreshes today's recent window
agent-native changelog list               # preview pending + released

Releasing is usually done at deploy/merge time to keep the top-level summary current. The in-app surface imports CHANGELOG.md?raw, and the core Vite plugin merges adjacent changelog/*.md entries into that raw markdown at dev/build time, so new app notes appear in What's new automatically. Refreshing the committed app-facing 100-entry window still happens when agent-native changelog release or pnpm changelog:compact runs. Package Changesets are wired to run pnpm changelog:compact automatically in the Version Packages workflow, which also moves older package releases into changelog/archive/CHANGELOG.md.

Wiring the in-app surface (once per template)

Templates already get the rendering for free from @agent-native/core. To expose it in an app:

1. Command menu — pass the app's own changelog to CommandMenu:

   import changelog from "../CHANGELOG.md?raw";
   // ...
   <CommandMenu open={cmdkOpen} changelog={changelog}>
     {/* existing groups */}
   </CommandMenu>
   

   This adds a "What's new" entry with an unseen-release dot and an in-app dialog — no other wiring needed.

2. Settings (optional) — drop the card on the settings page:

   import { ChangelogSettingsCard } from "@agent-native/core/client/changelog";
   import changelog from "../CHANGELOG.md?raw";
   // ...
   <ChangelogSettingsCard markdown={changelog} />
   

CHANGELOG.md?raw is inlined by Vite at build time, so this works on every host with no server route or runtime file access.

Checklist

• changelog.enabled is true and the change is user-visible? Run agent-native changelog add "…".
• New template UI? Pass changelog to its CommandMenu and seed a CHANGELOG.md.
• Releasing/deploying? Optional: agent-native changelog release refreshes the recent top-level window while retaining the folder history.