From adc86c5fed72a72cb3841c04895c94b1e80676e4 Mon Sep 17 00:00:00 2001 From: Brad Estey Date: Sat, 3 Oct 2026 02:35:47 -0400 Subject: [PATCH] Add versioning and change log. --- CHANGELOG.md | 16 ++++++++++++++++ README.md | 7 +++++++ package.json | 1 + 3 files changed, 24 insertions(+) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..add722d --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,16 @@ +# Changelog + +Versions follow the rules in [README.md](README.md#versioning). + +## Unreleased + +## 1.0.1 + +- Added `feed.like`: likes a chapter or strip. +- Added `feed.comment`: comments on a chapter or strip, with replies. + +## 1.0.0 + +- Creator records: `series`, `chapter`, `cover`, `slice`, `page`, `strip`. +- Reader records: `graph.subscription`, `graph.list`. +- Shared definitions in `defs`. diff --git a/README.md b/README.md index 91e8901..7d224bc 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,13 @@ pnpm lexicon:import # JSON schemas → TypeScript pnpm typecheck ``` +## Versioning + +The schema set is versioned in `package.json`, with changes listed in [CHANGELOG.md](CHANGELOG.md) and each release tagged `vX.Y.Z` in git. + +- Published records exist, so changes must be backward compatible. Bump the minor version for new lexicons, new optional fields, raised caps or new known values, and the patch version for descriptions and docs. +- Removing a field, making one required, renaming one, lowering a cap or changing a type breaks existing records. Make a new lexicon with a new NSID instead (e.g. `work.sequential.chapterV2`). + ## Concepts ### Record Structure diff --git a/package.json b/package.json index 2ef5347..6a65c7b 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,6 @@ { "name": "lexicons", + "version": "1.0.1", "type": "module", "private": true, "engines": { -- 2.51.2