What is a Changelog?
Changelog is a useful tool that lets you publish product updates to your users, and show them that you are listening to them & constantly improving.
Good to know: You can add the Changelog directly into your app using the Changelog Widget and Popup.
How it works
Changelog lets you publish release notes for your users to see in one place.
Your users can subscribe to your changelog by clicking the 'Subscribe to Changelog' button on the top right of your live changelog.
By doing this, they can stay updated with the latest enhancements via email notifications.
Alternatively, you can automate the subscription process using Featurebase API or SDK.
Creating a changelog
Creating a post
Go to Dashboard → Changelog
Click on 'New Changelog' in the top right
Add a featured image, title, and content
Select relevant categories for the update
You can see everything you have shipped on the right side of the editor. This way, you don't have to go digging up every update you made:
Good to know: You can mention people & posts in your changelog release using "@". For example, we use it for minor updates at the end of our releases:
Oh, and don't worry about your work getting lost. Our changelog auto-saves the draft for you.
Publishing and scheduling
Once your post is ready, you can choose 'Publish now' from the top right corner for immediate release.
You also have the option to schedule the update.
Click 'Schedule for later'.
Choose the date and time for the release, and hit the blue 'Schedule' button to confirm.
Backdating posts
Migrating from other tools? You can easily backdate posts by opening the post and selecting the original release date from the upper right-hand corner.
Comments & reactions
Changelog also has comments & reactions, to create a more collaborative environment around your feedback portal.
This also works in the Changelog Popup and the All-In-One widget.
Pro tip: Encourage your users to leave their thoughts at the end of your changelogs!
Configuring changelog
Adding categories
Categories are beneficial for keeping your changelogs organized and user-friendly.
Head to Dashboard → Settings → Changelog
Click on 'New changelog category' in the top right
Enter your new category's name and click 'Add category'
Note: Users with a Premium plan can use user roles to limit the visibility of updates about certain categories.
Disabling changelog comments & reactions
You can completely turn off collaboration features for changelog.
For that, go to Dashboard → Settings → Changelog
Check 'Disable Changelog'
Hiding changelog
There's also a possibility to hide the changelog from your public board completely.
For that go to Dashboard → Settings → Changelog
Select 'Hide Changelog'
Adding it to your app
1. Add a link
The easiest way to share your changelog is by attaching its link to a button or text on your page. This could be anywhere, from the navbar to the footer.
Just copy the URL of your live changelog and paste it where you'd like it on your page.
2. Changelog widget & popup
The second way is to use our neat changelog widget or popup to show the latest updates straight from your app.
You can see it in action from our widget documentation by clicking one of the demo buttons on the top right. This is where you can also learn to set it up.
3. Embed the Changelog view natively on your site
You can also embed your changelog directly into your app in its original form to allow users to submit feedback, vote on features, and view the changelog.
Here's the setup guide for that. 👈
If you've got any questions or need help, feel free to reach out through live chat! ✌️