Software Licensing – Changelogs

The Software Licensing extension has a built-in mechanism for associating a changelog with a Download. This makes it easy to keep the changelog updated as well as easy to see on the web for any Download.

Creating a changelog

When editing a Download in the admin area, find the Licensing meta box.  Make sure licenses are created for this Download by checking the checkbox.

One of the features that will appear when licensing is enabled is a large WYSIWYG text box. Create your changelog in this box.

As your changelog grows in length, you may find that it would be beneficial to reduce the length of the changelog when providing it via the `get_version` API request. As of Software Licensing 3.6.10, changelogs now support the ‘Read More’ tag, which will truncate the changelog when viewed over the API only. A URL to the full changelog will be placed at the end of the truncated changelog. Just insert following at the appropriate point in your changelog:

Viewing a changelog

To view the changelog of a Download that has one, first visit the product page for that Download.

Then add this to the end of the URL:

?changelog=1

And then the page will show the changelog.