Module guide
Release notes
The Atlas product changelog, in the app and on its own page.
Overview
Records every shipped release. Platform Super Admins draft and publish, and everybody signed in can read. A short panel announces each new release in the app once, and the account menu can summon it at any time. The full archive lives at /release-notes.
Highlights
The capabilities worth knowing before you dive in.
Important to know
Limits, permissions, and sharp edges to keep in mind.
- Release notes are global in scope, so every workspace reads the same feed.
- Only platform Super Admins can create, edit, publish or delete a release note. Workspace owners and administrators, like everybody else signed in, can read the published ones.
- Turning the announcements off stops the automatic panel only. The account menu still opens the newest release, and the archive at /release-notes is always available.
- The email subscription is for product updates only. It is separate from incident emails on the status page, and one address can hold both. Each release is emailed once, and every email carries an Unsubscribe link.
How to use it
The primary workflow, start to finish.
- As a platform Super Admin, go to /release-notes/admin to draft a release.
- Select Publish. The release appears at /release-notes immediately and begins announcing itself in the app.
- To read the newest release at any time, open the account menu and select What is new.
- To stop the automatic announcement, open Settings, then Notifications, and turn off In-app release announcements. The same switch turns it back on.
- To get releases by email, open the public changelog page, enter your address under Get it by email, select Subscribe, and open the confirmation email. Nothing is sent until you confirm.
FAQ
- What does Do not show again do?
- It turns the automatic announcement off for your account, for every future release. It is not a per-release dismissal. To turn it back on, open Settings, then Notifications, and enable In-app release announcements.
- I turned announcements off. Can I still read the release notes?
- Yes. The account menu item What is new opens the newest release whatever your setting says, and the full archive is always at /release-notes.
- What does Remind me next login do?
- It hides the panel for the rest of the current session only. Signing out and back in shows it again. It changes no stored preference.
- Can I stop one workspace from seeing a release note?
- No. Release notes are global in scope, so every workspace reads the same feed. Write them for the whole audience, and keep anything workspace specific in a channel that supports it.
- Why did publishing a release note report a conflict?
- The version string must be valid semantic versioning and must be unique. Publishing a version that already exists reports a conflict rather than creating a second entry. Increment the version and publish again.
- How do I get release notes by email?
- Open the public changelog page, enter your address under Get it by email and select Subscribe. Atlas sends a confirmation email that says it is for product updates, and you start receiving releases once you select Confirm subscription. Each release is emailed once, in your browser language, with a link to read it and a link to unsubscribe. The RSS and JSON feeds on the same page need no account.
- Does subscribing to release notes also send me incident emails?
- No. The changelog subscription is for product updates only. Incident emails come from the subscription on the public status page. One address can hold both, and Unsubscribe in an email ends that subscription.
- Why does Atlas say a new version is available?
- A tab that stays open while a new version of Atlas is released keeps running the old one, so it shows none of the changes. Atlas checks for a newer version when you return to the tab and every ten minutes, and offers Refresh when there is one. Save your work first: changes you have not saved on that page are lost when it refreshes.
Automate this module
Everything on this screen is scriptable. Drive it from the REST API, or let an AI agent run it through the MCP server.
Was this page helpful?