This guide describes how to provide changelog texts with add-ons. Changelogs are used to tell store administrator about bugfixes and new features in the new version of a add-on before update.
Changelogs in the update interface
Changelogs will be shown to the store administrator on the pre-update page, where all downloaded components are listed:
Click on the Button "Changelog" will open a panel with changelogs text.
There are no strict rules on changelog format other than it must a plain text file with name changelog.txt. We suggest the following markup:
<yyyy-mm-dd date> - [<type>] <Short description>. #<Issue No.> (<Assignee>) <Subsystem>
2022-08-05 - [Bug] Product sorting on the search page in the Customer area was working incorrectly. #BUG-1234 (Maxim Kuznetsov) #Search
2022-08-05 - [Feature] Added the magic button "Make everything OK". #TASK-1234 (Maxim Kuznetsov) #Core
2022-08-07 - [Change] Refactoring of the very important feature. #TASK-1111 (Vasily Pupkine)
Where to put changelogs?
All changelog files must placed inside
modules/<DEV-CODE>/<MODULE-NAME>/docs/version_info folder in a tree structure like this:
│ ├── changelog.txt
Here '5.5' folder is the major (product) version, '0.0' and '0.1' child folders stand for minor.build version and the files are named as
changelog.txt. Read more about X-Cart versioning here.
Everything that's left is to pack your add-on build and submit it to the X-Cart Marketplace.