From 195ba0c680626de4bacebecf5150cd6516206c87 Mon Sep 17 00:00:00 2001 From: Bozhidar Batsov Date: Mon, 26 Oct 2026 22:36:27 +0200 Subject: [PATCH] Keep each CHANGELOG entry on one line The release notes are the version's section of the CHANGELOG, and GitHub shows every newline in them as a line break, so the wrapped entries came out broken mid-sentence in 0.1.0's notes. --- CHANGELOG.md | 42 +++++++++++------------------------------- doc/hacking.md | 5 +++-- 2 files changed, 14 insertions(+), 33 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a566997..0653a51 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,34 +8,14 @@ Initial release. ### Features -- Checks for what clients need from a server's replies to `describe`, - unknown ops, sessions, `eval` and `stdin`, and for every message the - server sends (the `wire.*` checks). -- [#4](https://github.com/nrepl/proof/pull/4): Client profiles, which send - what CIDER, Calva, Conjure, vim-fireplace, REPLy and neorepl send while - connecting and evaluating code - ([#6](https://github.com/nrepl/proof/pull/6), - [#8](https://github.com/nrepl/proof/pull/8)). -- Profiles for nREPL, Babashka, ClojureCLR, Basilisp, jank, dialtone and - repartee, which come with proof, and expected failures that can't go - stale. -- `proof matrix`, which builds a compatibility matrix out of the JSON - reports of several servers. -- [#1](https://github.com/nrepl/proof/pull/1): `proof proxy`, which checks - what a client sends to a server, with `-record` for starting a client - profile ([#5](https://github.com/nrepl/proof/pull/5)). -- [#2](https://github.com/nrepl/proof/pull/2): `proof serve`, a server for - the tests of clients that can behave like other servers - ([#3](https://github.com/nrepl/proof/pull/3)). -- [#10](https://github.com/nrepl/proof/pull/10): Binaries for Linux, macOS - and Windows on every release, and a GitHub Action for running proof in the - CI of a server. -- [#11](https://github.com/nrepl/proof/pull/11): Checks for `interrupt`, and - scenarios for nREPL's interrupt bugs in `proof serve`. -- [#12](https://github.com/nrepl/proof/pull/12): Checks for `load-file`, and - `load-file` in `proof serve`. -- [#13](https://github.com/nrepl/proof/pull/13): Checks for completions and - lookups, and nREPL's `completions` and `lookup` in `proof serve`. -- [#14](https://github.com/nrepl/proof/pull/14): Checks for requests that go - wrong: frames that aren't requests, fields of the wrong type and clients - that go away in the middle of an eval. +- Checks for what clients need from a server's replies to `describe`, unknown ops, sessions, `eval` and `stdin`, and for every message the server sends (the `wire.*` checks). +- [#4](https://github.com/nrepl/proof/pull/4): Client profiles, which send what CIDER, Calva, Conjure, vim-fireplace, REPLy and neorepl send while connecting and evaluating code ([#6](https://github.com/nrepl/proof/pull/6), [#8](https://github.com/nrepl/proof/pull/8)). +- Profiles for nREPL, Babashka, ClojureCLR, Basilisp, jank, dialtone and repartee, which come with proof, and expected failures that can't go stale. +- `proof matrix`, which builds a compatibility matrix out of the JSON reports of several servers. +- [#1](https://github.com/nrepl/proof/pull/1): `proof proxy`, which checks what a client sends to a server, with `-record` for starting a client profile ([#5](https://github.com/nrepl/proof/pull/5)). +- [#2](https://github.com/nrepl/proof/pull/2): `proof serve`, a server for the tests of clients that can behave like other servers ([#3](https://github.com/nrepl/proof/pull/3)). +- [#10](https://github.com/nrepl/proof/pull/10): Binaries for Linux, macOS and Windows on every release, and a GitHub Action for running proof in the CI of a server. +- [#11](https://github.com/nrepl/proof/pull/11): Checks for `interrupt`, and scenarios for nREPL's interrupt bugs in `proof serve`. +- [#12](https://github.com/nrepl/proof/pull/12): Checks for `load-file`, and `load-file` in `proof serve`. +- [#13](https://github.com/nrepl/proof/pull/13): Checks for completions and lookups, and nREPL's `completions` and `lookup` in `proof serve`. +- [#14](https://github.com/nrepl/proof/pull/14): Checks for requests that go wrong: frames that aren't requests, fields of the wrong type and clients that go away in the middle of an eval. diff --git a/doc/hacking.md b/doc/hacking.md index 3700a2b..86facd5 100644 --- a/doc/hacking.md +++ b/doc/hacking.md @@ -382,5 +382,6 @@ Releasing a new version of proof is a very simple process: The Release workflow takes it from there. It builds the binaries with `script/build-release` and publishes them in a GitHub release, whose -notes are the version's section of the CHANGELOG. If you edit that -section later, update the notes of the release as well. +notes are the version's section of the CHANGELOG. GitHub keeps all the +newlines in the notes, so each CHANGELOG entry goes on a single line. If +you edit that section later, update the notes of the release as well.