Adopt a managed changelog across the whole ecosystem — the pslua compiler (this repo) and every package in the Lua package set — using scriv (fragment files in changelog.d/, assembled into CHANGELOG.md on release). Today nothing here ships a changelog, so neither compiler users nor package consumers can tell what changed between versions — especially painful given the run of FFI fixes (#73–#100) landing across the set.
Scope
- pslua compiler — this repo (
purescript-lua/purescript-lua).
- Set forks (from
purescript-lua-package-sets src/packages.dhall): assert, arrays, console, control, effect, enums, exceptions, foldable-traversable, functions, integers, lazy, lua-ngx, numbers, partial, prelude, refs, safe-coerce, st, strings, unfoldable, unsafe-coerce.
1. scriv setup (each repo)
2. Retroactive backfill
3. Ongoing process
Filed in passing during the pre-release FFI-fix campaign; implementation comes after that campaign lands.
Adopt a managed changelog across the whole ecosystem — the pslua compiler (this repo) and every package in the Lua package set — using scriv (fragment files in
changelog.d/, assembled intoCHANGELOG.mdon release). Today nothing here ships a changelog, so neither compiler users nor package consumers can tell what changed between versions — especially painful given the run of FFI fixes (#73–#100) landing across the set.Scope
purescript-lua/purescript-lua).purescript-lua-package-setssrc/packages.dhall): assert, arrays, console, control, effect, enums, exceptions, foldable-traversable, functions, integers, lazy, lua-ngx, numbers, partial, prelude, refs, safe-coerce, st, strings, unfoldable, unsafe-coerce.1. scriv setup (each repo)
pyproject.toml/setup.cfg/.scriv.toml) — Markdown,changelog.d/fragment dir, categories (Added/Changed/Fixed/Removed).scrivin the dev shell (flakebuildInputs, e.g.python3Packages.scriv) soscriv create/scriv collectwork innix develop.CHANGELOG.mdwith the scriv begin/end markers.AGENTS.md/CONTRIBUTING and an ADR inpurescript-lua-package-sets/docs/adr, alongside the treefmt/hooks/CI canons.2. Retroactive backfill
CHANGELOG.mdentries from existing release tags (one section per tag: date + summary). Prioritise releases from the current FFI-fix campaign:3. Ongoing process
changelog.d/fragment per change (PR checklist / CONTRIBUTING).scriv collect(in/near the annotated-tag release flowrelease.ymlfor forks; for pslua, on its chosen release trigger) soCHANGELOG.mdupdates for every new version.Filed in passing during the pre-release FFI-fix campaign; implementation comes after that campaign lands.