Skip to content

Commit c19dc14

Browse files
committed
docs: add scriv-managed changelog, backfill fork releases
Adds a CHANGELOG.md managed with scriv (fragments in changelog.d/), provides scriv in the flake dev shell, and records the fork's Lua 5.1 FFI release line. Where the upstream PureScript changelog existed it is preserved below the fork section. The AGENTS.md Releasing note now points at the scriv flow instead of "no changelog entry". Part of the ecosystem-wide changelog adoption (purescript-lua/purescript-lua#101); canon in package-set ADR 0009.
1 parent 1a288b8 commit c19dc14

4 files changed

Lines changed: 40 additions & 2 deletions

File tree

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ A bare `function … end` or an unparenthesised expression fails to parse.
4848

4949
## Releasing
5050

51-
Tag-driven, with no GitHub Release or changelog entry. The full conventions live in the [package-set repo](https://github.com/purescript-lua/purescript-lua-package-sets/blob/master/CONTRIBUTING.md): push an annotated tag on `master`, bump this fork's `version` in the package set's `src/packages.json`, refresh `latest-compatible-sets.json`, and push a `psc-*` set tag.
51+
Tag-driven. The full conventions live in the [package-set repo](https://github.com/purescript-lua/purescript-lua-package-sets/blob/master/CONTRIBUTING.md): write a `changelog.d/` fragment for any `src/` change, run `scriv collect --version <tag>` and commit the updated `CHANGELOG.md`, then push an annotated tag on `master`, bump this fork's `version` in the package set's `src/packages.json`, refresh `latest-compatible-sets.json`, and push a `psc-*` set tag.
5252

5353
## Decisions
5454

CHANGELOG.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,34 @@
11
# Changelog
22

3-
Notable changes to this project are documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
3+
Notable changes to this Lua fork of `purescript-enums` are recorded here. The fork
4+
tracks its own release line (Lua 5.1 FFI on the [pslua](https://github.com/purescript-lua/purescript-lua)
5+
compiler); the upstream PureScript history is preserved below. The format
6+
is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and
7+
fork entries are assembled from fragments in `changelog.d/` with
8+
[scriv](https://scriv.readthedocs.io/) on each release.
9+
10+
<!-- scriv-insert-here -->
11+
12+
## v6.1.2 - 2026-06-15
13+
14+
### Fixed
15+
16+
- `toCharCode` is length-guarded, so a lone code-unit byte no longer crashes
17+
(#102).
18+
19+
## v6.1.1 - 2026-06-15
20+
21+
### Fixed
22+
23+
- `Data.Enum` `toCharCode`/`fromCharCode` handle UTF-8 `Char` code points
24+
(#79, #80).
25+
26+
<!-- scriv-end-here -->
27+
28+
---
29+
30+
The sections below are inherited from the upstream PureScript project and
31+
predate the Lua fork.
432

533
## [Unreleased]
634

changelog.d/scriv.ini

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
[scriv]
2+
format = md
3+
md_header_level = 2
4+
categories = Added, Changed, Fixed, Removed
5+
# Hyphen separator (Keep a Changelog style), not scriv's default em dash, so
6+
# collected entries match the hand-written backfill. The `%` are doubled
7+
# because scriv reads this file with configparser interpolation, which treats a
8+
# bare `%` specially; `%%` is an escaped literal `%`.
9+
entry_title_template = {%% if version %%}{{ version }} - {%% endif %%}{{ date.strftime('%%Y-%%m-%%d') }}

flake.nix

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@
4444
nixfmt-rfc-style
4545
pslua.packages.${system}.default
4646
purs-bin.purs-0_15_16
47+
scriv
4748
spago-bin.spago-1_0_4
4849
treefmt
4950
];

0 commit comments

Comments
 (0)