'Change log' element in add-on descriptor file?
I would like the ability to include a change log in an add-on descriptor file (initially for the 'focheck' add-on). A change log would let a user see what has changed and work out whether or not they really want the update. Since I can't do it yet, I'm not sure if the contents would be the first section or the full contents of the change log at: https://github.com/AntennaHouse/focheck/blob/master/ChangeLog.md I could, of course, put the change log in the <xt:description> element, but I see the description as being different from a change log, just as many projects have a ReadMe file and a ChangeLog file. (If it was a separate element, it would also be that little bit easier to automatically update the change log before making a release.) Regards, Tony Graham. -- Senior Architect XML Division Antenna House, Inc. ---- Skerries, Ireland tgraham@antenna.co.jp
Hello Tony, Indeed, you could use "<xt:description>", but I also created a new issue to perhaps add a specialized element (EXM-43054 - for reference purposes). All the best wishes, Sorin Carbunaru oXygen XML On 26-Feb-19 2:12 PM, Tony Graham wrote:
I would like the ability to include a change log in an add-on descriptor file (initially for the 'focheck' add-on). A change log would let a user see what has changed and work out whether or not they really want the update.
Since I can't do it yet, I'm not sure if the contents would be the first section or the full contents of the change log at:
https://github.com/AntennaHouse/focheck/blob/master/ChangeLog.md
I could, of course, put the change log in the <xt:description> element, but I see the description as being different from a change log, just as many projects have a ReadMe file and a ChangeLog file. (If it was a separate element, it would also be that little bit easier to automatically update the change log before making a release.)
Regards,
Tony Graham.
On 27/02/2019 11:01, oXygen XML support wrote:
Indeed, you could use "<xt:description>", but I also created a new issue to perhaps add a specialized element (EXM-43054 - for reference purposes).
Thanks. I later saw that the Git Support add-on puts its change log in the description, but each new release pushes the 'Using the plugin' section further down in the description, which makes it increasingly less likely that people will see the instructions. Regards, Tony Graham. -- Senior Architect XML Division Antenna House, Inc. ---- Skerries, Ireland tgraham@antenna.co.jp
participants (2)
-
oXygen XML support -
Tony Graham