CHANGELOG: Migrate from single file to split files for ease of maintenance

Signed-off-by: Siddharth Chandrasekaran <sidcha.dev@gmail.com>

Author: sidcha

.github/workflows/release.yml

@@ -43,6 +43,7 @@ jobs:
           py_version="$(perl -ne 'print $1 if (/^project_version = "(\d+\.\d+\.\d+)"/)' python/setup.py)"
           platformio_version="$(perl -ne 'print $1 if (/^  "version": "(\d+\.\d+\.\d+)",$/)' library.json)"
           config_version="$(perl -ne 'print $1 if (/^#define PROJECT_VERSION\s+"(\d+\.\d+\.\d+)"/)' platformio/osdp_config.h)"
+          release_file="CHANGELOG/RELEASE-${tag}.md"
 
           for declared in "${cmake_version}" "${py_version}" "${platformio_version}" "${config_version}"; do
             if [[ "${declared}" != "${version}" ]]; then
@@ -51,14 +52,15 @@ jobs:
             fi
           done
 
-          if ! grep -q -E "^v${version} " CHANGELOG; then
-            echo "CHANGELOG is missing an entry for ${tag}" >&2
+          if [[ ! -f "${release_file}" ]]; then
+            echo "CHANGELOG is missing ${release_file} for ${tag}" >&2
             exit 1
           fi
 
-          perl -e 'local $/; $_=<>; print $1 if (/-{4,}\n+\d+.*?\n+(.*?)\n+v\d+\./sg)' CHANGELOG > RELEASE.txt
+          python3 scripts/changelog_tool.py validate --file "${release_file}" --expected-version "${tag}" --quiet
+          python3 scripts/changelog_tool.py notes --file "${release_file}" --output RELEASE.txt
           if [[ ! -s RELEASE.txt ]]; then
-            echo "Failed to extract release notes from CHANGELOG" >&2
+            echo "Failed to extract release notes from ${release_file}" >&2
             exit 1
           fi
 

.github/workflows/reusable-ci.yml

@@ -10,6 +10,15 @@ on:
   workflow_call:
 
 jobs:
+  Changelog:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v5
+      with:
+        submodules: recursive
+    - name: Validate changelog files
+      run: python3 scripts/changelog_tool.py validate --dir CHANGELOG --quiet
+
   CmakeBuild:
     runs-on: ubuntu-latest
     steps:

CHANGELOG CHANGELOG/CHANGELOG.legacyCHANGELOG renamed to CHANGELOG/CHANGELOG.legacy

@@ -0,0 +1,12 @@
+---
+release_date: 2019-11-15
+release_version: v0.1-alpha
+---
+
+libosdp has reached a point where all the primary featured are in place.
+
+## Known limitations
+
+- Master key management is missing
+- Install mode stuffs need to be ironed out
+- comset command needs to be handled correctly

CHANGELOG/RELEASE-v0.1-alpha.md

@@ -0,0 +1,16 @@
+---
+release_date: 2019-11-29
+release_version: v0.2-beta-1
+---
+
+Release notes for v0.2-beta-1.
+
+## Features
+
+- Master key management in CP and PD
+- Many small issue fixes
+
+## Known limitations
+
+- install mode stuffs need to be ironed out comset command needs to be
+- handled correctly

CHANGELOG/RELEASE-v0.2-beta-1.md

@@ -0,0 +1,21 @@
+---
+release_date: 2019-12-15
+release_version: v0.3-beta-2
+---
+
+Release notes for v0.3-beta-2.
+
+## Features
+
+- Added new tool osdpctl to create, manage and control osdp devices
+- Add PD context to CP logs for clarity
+
+## Enhancements and fixes
+
+- Fix PD stale pointer issue in osdp_setup
+- Fix MAC generation bug in Secure Channel
+- Fix Data offset bug in Secure Channel
+- Fix issues reported by -Wimplicit-fallthrough
+- Fix memleak in PD command queue alloc
+- Fix wrap around bug in cmd_queue
+- Fix many clang static code analysis issues

CHANGELOG/RELEASE-v0.3-beta-2.md

@@ -0,0 +1,18 @@
+---
+release_date: 2020-01-17
+release_version: v0.4-beta-3
+---
+
+Release notes for v0.4-beta-3.
+
+## Fixes
+
+- fix unhandled reply-code bug
+- fix issue where reader goes permanent reader offline
+- retry SC after OSDP_PD_SC_RETRY_SEC when possible
+- fix USE_SCBKD inversion bug
+- fix bug in MAC add/check for SCS_15
+
+## Notes
+
+- This tag has CP mode verified with HID RK40 readers. This can act as reference point for all PD change validation hereafter.

CHANGELOG/RELEASE-v0.4-beta-3.md

@@ -0,0 +1,17 @@
+---
+release_date: 2020-05-29
+release_version: v1.0.0
+---
+
+This is the first release of libosdp. It has been in pre-release for a
+long time now and has been tested sufficiently well for a first release.
+Rate of bug fixes has gone down significantly.
+
+## Features
+
+- Supports OSDP CP mode of operation
+- Supports OSDP PD mode of operation
+- Supports Secure Channel for communication
+- Ships a tool: osdpctl to consume and library and setup/manage osdp devices
+- Documents key areas in the protocol that are of interest for consumers of this library.
+- So far, this library's CP implementation has been tested with multiple OSDP PDs including HID's devices and found to be working as expected. The PD implementation has been tested with it's own CP counterpart so this some level of confidence on the that too.

CHANGELOG/RELEASE-v1.0.0.md

@@ -0,0 +1,24 @@
+---
+release_date: 2020-06-28
+release_version: v1.1.0
+---
+
+This release bumps up the minor number as the contract has changed. It
+introduces 2 major changes (first 2 in enhancements). The rest is all
+re-organization and fixes.
+
+## Enhancements
+
+- In PD Change app notification of incoming commands to polling to simplify API
+- Replace circular buffer command queue with linked list queue
+- Add SC status and status query methods
+- Add assert guards for exposed methods
+- Cleanup osdp.h by splitting it into multiple files
+- Split cmake rules into subdirectories
+
+## Fixes
+
+- Add PD address to REPLY_COM in pd_build_reply
+- Fix fd leak in read_pid
+- Fix missing null char at atohstr()
+- Fix memory under-alloc due to operator precedence issues

CHANGELOG/RELEASE-v1.1.0.md

@@ -0,0 +1,37 @@
+---
+release_date: 2020-08-15
+release_version: v1.2.0
+---
+
+This release marks the first HEAD of initial PD support in Zephyr RTOS upstream
+(https://github.com/zephyrproject-rtos/zephyr). Lot of changes to coding style
+were made to upstream the PD sources without too much variation to the one here.
+
+## Enhancements
+
+- Add support for sphinx documentation builds see: https://libosdp.gotomain.io
+- Add a macro switch to disable Secure Channel
+- Add utils git-submodule and delete all copied ad-hoc utils from this repo
+- Add pkg-config file for libosdp
+- PD: When seq number 0 is received, invalidate SC status
+- Add github actions workflows for tests and release
+- Rewrite PD and CP fsm for zephyr integration
+- osdpctl: rewrite rs232.c into utils/serial.c
+- osdpctl: remove pid file in osdpctl stop. Also check return code of kill
+- Produce source and binary tarballs with cPack
+- Bring changes from zephyr PD, post review and apply it to CP as well
+- Control the externally exposed library symbols using `EXPORT` macro
+
+## Fixes
+
+- Make all internal methods static; scope all globals with `osdp_`
+- Add colors for various log levels of libosdp
+- Refactor all reference to struct osdp_pd as 'pd' everywhere
+- Fix static analysis issues identified by Xcode
+- travis: switch to Ubuntu 18.04 bionic for testing
+- osdpctl: Fix bug in `hex2int()`
+- osdpctl: Fix bug in load_scbk(); test key_store feature
+- osdpctl make config as the first argument for all commands
+- Fix sequence number 0 sent by CP does not reset connection in PD
+- osdpctl: Make PD message queue channel owner, responsible for cleanup
+- osdpctl: Fix segfault on channel cleanup code