The changelog

The Changelog is where you announce what you shipped. Each entry is a product update you publish to your users: a single feature, a fix, or a batch of changes rolled up into weekly or monthly release notes. Once an entry is live, it appears in your widget and on your public portal, and subscribers can be notified about it. You write entries one at a time and decide, per entry, when it goes out and who sees it. Some teams post every notable change on its own; others collect a week’s or a month’s worth of updates into a single release note. The changelog supports both.

​

Read the changelog list

The Changelog screen lists every entry in your workspace, grouped by its state. The count next to the title tells you how many entries you have in total. Entries fall into three sections, shown in this order: Each section header shows the number of entries in it, and you can collapse a section by clicking its header. Your collapsed or expanded choice is remembered on this device, so the list opens the same way next time. What each row shows depends on the entry’s state:

• Published rows show the entry’s page views, the average reaction from users, and the publish date.
• Scheduled rows show a clock and the date the entry is set to go live.
• Draft rows are simply marked Draft.

Every row also shows the entry title, its category if it has one, and its ID. Click any row to open the entry in the editor. To add a new entry, use New entry in the top right. For the full walkthrough of writing and publishing, see Create changelog entries.

​

Filter the list

As your changelog grows, the header controls narrow the list down to what you want to see. None of these filters change your entries or what your users see: they only change your own view of the list.

​

Filter by status

The tabs next to the title switch the list between entry states. Your tab choice is remembered on this device.

​

Filter by category

If you sort your updates into categories (for example New, Improved, or Fixed), the filter icon in the header narrows the list to a single category. Click it, then choose a category, or choose All categories to clear the filter. The categories you see here are the ones set up for your workspace. Categories are shared with your feedback board: see Categories to add or edit them.

​

Search entries

Click the Search icon to open a search box and type to find an entry by keyword. Search combines with the active status tab and category filter, so you can search within a filtered list.

​

Related