Share updates with changelog

Write, schedule, and publish changelog entries, link shipped feedback, organize entries with labels, and manage visibility and subscriber emails.

JM
James Morton
Written By James MortonLast updated 1 day ago

The changelog lets you announce what you've shipped and connect each update to the feedback that inspired it. This article covers writing, scheduling, and publishing entries, linking feedback posts, labels, and the changelog settings for visibility and email.

Overview

Open Changelog from the admin sidebar. You can:

  • write and publish release notes
  • link entries to the feedback posts they address
  • schedule entries to publish later
  • filter entries by status (draft, scheduled, published)

The changelog is a module. If you don't see it, turn it on in Settings > General under Modules.

Create an entry

  1. Click New entry.
  2. Enter a title and write your content in the rich text editor.
  3. In Entry settings, choose the Status:

Status

What it means

Draft

Saved but not visible to users

Scheduled

Publishes automatically on the date you pick

Published

Live on your public changelog

  1. Optionally add Labels, a Featured image, and Linked posts (see below).
  2. Click Save draft, Schedule, or Publish now.

When an entry is about to publish or be scheduled, Send email to subscribers controls whether subscribers get an email. See Announce a changelog entry.

Tip: Start entries as drafts. Refine the copy and link the related posts, then publish when you're ready.

Show users their feedback was heard by linking the posts an entry addresses.

  1. Open the entry.
  2. In Entry settings, find Linked posts.
  3. Search for the posts this update shipped and select them.

Only posts with a status in the Complete category (for example "Complete") can be linked. On the published entry, users see which posts were addressed, and people subscribed to those posts are notified too.

Edit and delete entries

Click an entry in the list to edit its title, content, status, and settings. Save with Save draft, Save schedule, or Update and publish, depending on its status.

To delete an entry, use the delete action and confirm.

Warning: Deleting a changelog entry is permanent.

Filter and sort entries

Use the Status filter (All, Draft, Scheduled, Published) and sort by Newest or Oldest.

Organize with labels

Labels such as "New", "Improved", or "Fixed" help readers scan for the kind of update they care about.

  1. Go to Settings > Changelog.
  2. In the Labels card, click New label.
  3. Enter a Name and pick a color.
  4. Optionally use Restrict to segments so only certain segments see the label. Leave it empty to show it to everyone.
  5. Click Create label.

Drag labels to reorder them. Deleting a label removes it from every entry. Add labels to an entry from Labels in its Entry settings.

Changelog settings

Settings > Changelog covers everything beyond single entries:

  • Visibility: who can see the changelog, Everyone or Signed-in users
  • Labels: create, edit, and reorder labels
  • Email: whether publishing sends emails, auto-subscribing new users, and importing subscribers

Email subscriptions

Signed-in portal users can subscribe from your public changelog page to get an email whenever you publish. Every changelog email has a one-click unsubscribe that doesn't affect their other notification settings.

In the Email card of Settings > Changelog:

  • Send changelog emails: turn publish emails on or off for the whole workspace
  • Auto-subscribe users: subscribe new users automatically
  • Import subscribers: upload a CSV with an Email column to subscribe an existing list

Tip: Moving from another tool? Import your existing subscriber list instead of asking everyone to subscribe again.

Was this helpful?

Your feedback shapes what we write next.

ā† Previous

Build a public roadmap

Next ā†’

Announce a changelog entry

Related articles

Announce a changelog entryEvery way a published changelog entry reaches people: subscriber emails, in-app notifications, the widget Changelog tab, opening it from your app, Slack, and webhooks.Ship and announceClose the feedback loop when you ship: the feedback-to-changelog pipeline, writing good entries, linking feedback posts, draft and review before publishing, and making completions count.Build a public roadmapCreate roadmaps that fill themselves from post status, board, tags, and ETA, choose status columns or date periods, and control who can see each one.Track progress with statusesUse the default statuses or create your own, choose which ones become roadmap columns, and explain status changes to the people who follow a post.