Publish a changelog entry

Your changelog is a list of release notes your customers see in the widget’s News tab and on your changelog page.

Write an entry

1. Open Changelog and select New entry.
2. Give it a title in Entry title.
3. Add tags such as New or Integrations, separated by commas.
4. Write the notes under Body in Markdown. Check them in the Preview tab.
5. Under Linked feedback, pick the feedback posts this release delivers.

Entries start as drafts, visible only to your team.

Publish

Select Publish. Three things happen:

• The entry appears on your changelog and in the widget.
• Every linked post is marked Shipped and moves to the Shipped column of your roadmap.
• A notification is queued for each customer who voted for a linked post.

The notification is queued but not emailed yet, so customers do not receive an email for now.

Take it back

You can move a published entry back to draft. The entry disappears from the widget and the changelog page. Linked posts stay shipped.

Public feeds

Published entries are also available as JSON, without a key, at https://app.tirver.com/api/public/WORKSPACE/changelog, with WORKSPACE replaced by your workspace address name. With an API key you can read entries, drafts included, at /api/v1/changelog. See changelog entries.

Writing good release notes

• Lead with what changed for the customer, not how you built it.
• Keep each entry about one change.
• Link to the help article that explains it.