Changelog
Changelog
The changelog is where the team writes down what shipped, one release at a time. A release stays a draft until someone publishes it, so notes can be gathered as work lands rather than pieced together later.
In the sidebar under Content → Changelog. Needs: nothing else switched on.
Changelog screen
- Two totals: Releases and Published.
- A table of releases, newest first:
- Version, such as
1.4.0. - Title, with the start of the notes under it.
- Status: "published" or "draft".
- Version, such as
- People who can manage the changelog see a New release button, and Publish or Unpublish, edit and delete on each row.
With no releases yet, the screen says "No releases".
Write a release
- Open Changelog and press New release.
- Fill in the Version (for example
1.4.0) and a Title (for example "Search and filters"). Both are required. - Write the Notes: what changed, in words the reader will understand.
- Save. The release is a draft.
Publish or unpublish a release
- Find the release in the table.
- Press Publish. Its status becomes "published", stamped with the current time.
- To take it back to a draft, press Unpublish.
Drafts are listed beside published releases for everyone who can view the changelog. Publishing does not send the release anywhere. A product landing site that shows a changelog shows published releases only, newest first. Drafts never appear there. See Landing sites.
Edit or delete a release
- Edit a release to change its version, title or notes.
- Delete removes it. There is no undo.
Anyone who can manage the changelog can edit, publish or delete any release, not only the ones they wrote.
Who can do what
| Permission | Label | Lets you |
|---|---|---|
changelog:read | View changelog | See every release, drafts included. |
changelog:write | Manage changelog | Write, edit, publish, unpublish and delete releases. |
See People, roles and permissions.
What happens on its own
Nothing in this module runs on a schedule.
What agents can do
An agent can read the changelog, and draft, edit, publish and delete releases. Writing, editing and publishing are changes, and deleting cannot be undone, so by default each one waits for a person to approve it. See Agents and approvals.
Read only: changelog.list, changelog.get
Write and publish: changelog.create, changelog.update, changelog.publish
Delete (cannot be undone): changelog.delete
changelog.publish stamps the release with the current time unless it is given another date. changelog.update with an empty publish date makes a release a draft again.
Over MCP the same tools are named changelog__list, changelog__publish and so on. See API keys and MCP access.