universal-suite-changelog

Single source of truth for the Universal Suite changelog. Every product (Universal PDF, Webinar, Exports, Cyber Assess, Ergo Assess) reads from this one file via the @unisim/sdk useChangelog() hook.

Why one file

Users see one suite version (CalVer YYYY.MM.N) regardless of which product they're in. When they open the version chip in PDF, the latest entry might be Ergo Assess: Added new method — that's the goal.

Editing

1. Open changelog.json.
2. Add a new release at the TOP of the releases array (newest first).
3. Use the next CalVer version: if today is 2026-06, and the latest release is 2026.05.6, the next is 2026.06.1.
4. Each entry needs product, type, summary. Validate locally:

   npm install
   npm run validate

5. Commit. CI publishes to changelog.unisim.co.uk on push to main.
6. To trigger an npm release of @unisim/changelog, prefix the commit message with release: (e.g. release: 2026.06.1 — new Cyber Assess module).

Allowed product values

suite, pdf, webinar, exports, cyber_assess, ergo_assess

Allowed type values

added, changed, fixed, removed, deprecated, security

Distribution

• Runtime fetch: every product calls https://changelog.unisim.co.uk/changelog.json via the SDK
• Build-time fallback: @unisim/changelog npm package bundles the same JSON for offline / cache-miss scenarios

Versioning scheme

CalVer (YYYY.MM.N):

• YYYY — calendar year
• MM — month, zero-padded
• N — release number within that month, starting at 1

Example: 2026.05.6 is the 6th suite release in May 2026.