| 1 | # API-CHANGELOG
|
| 2 |
|
| 3 | ## Syntax of the Changelog.txt
|
| 4 |
|
| 5 | ### Example file
|
| 6 | ```
|
| 7 | #
|
| 8 | # This is the changelog for Concerto. It lists all significant changes to
|
| 9 | # functionality and public API.
|
| 10 | #
|
| 11 | #
|
| 12 | Version 0.15.2 {fcb7a3866eb7f9d0b3c46924ae932824} 2017-11-22
|
| 13 | - Extend ParseException with file name
|
| 14 | - Make private number of constructors and removed exceptions from formally documented API
|
| 15 | - Add the introspection APIs, Memory and Filesystem Card store.
|
| 16 |
|
| 17 | Version 0.15.1 {015d225161956eb66be1636cef324c8a} 2017-11-14
|
| 18 | - Add in has to the Card Store
|
| 19 | - Make IdCard constructor public
|
| 20 |
|
| 21 | Version 0.15.0 {bc4416a38d5d8d9d53dd4f5cbe3992aa} 2017-11-08
|
| 22 | - Add IdCard and BusinessNetworkCardStore to public API
|
| 23 |
|
| 24 | ```
|
| 25 |
|
| 26 | ### Specification
|
| 27 |
|
| 28 | - The file is text, utf-8 encoding
|
| 29 | - Comments are indetified by # in the first column
|
| 30 | - Entries are in chronological order with the most recent first
|
| 31 | - Each entry is composed of an indentifier line, starting in column 1, with details after that with comments on the changes.
|
| 32 | - *Identifier Line*
|
| 33 | - Should match this syntax `Version <number> {public api digest} <date>`
|
| 34 | - The version number must match that specified in package.json
|
| 35 | - The public api digest is computed and validated using *api-changelog*
|
| 36 | - Latest public API is available in api.txt.
|
| 37 |
|
| 38 | ## License <a name="license"></a>
|
| 39 | Accord Project source code files are made available under the Apache License, Version 2.0 (Apache-2.0), located in the LICENSE file. Accord Project documentation files are made available under the Creative Commons Attribution 4.0 International License (CC-BY-4.0), available at http://creativecommons.org/licenses/by/4.0/. |
| \ | No newline at end of file |