Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 8 additions & 14 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,13 @@
# Changelog

Released versions of Rhei. Changes that have not shipped in a release yet live
in the `Unreleased` section of [docs/changelog.md](docs/changelog.md), which
release automation promotes into a numbered section here at release time
(§FS-rhei-distribution.5). Read both to see everything on `main`.

## Unreleased

See [docs/changelog.md](docs/changelog.md#unreleased). It currently carries a
**breaking change**: ticket ids are project-qualified (`1` → `auth.1`), which
changes command output, result artifact filenames, ledgers, logs, snapshot
cache keys, and the `RHEI_TASK_ID` seen by callbacks, and requires a
single-file rhei to be named `<id>.rhei.md`. The entry ends with an
"Upgrading a pre-qualification workspace" checklist — read it before upgrading
a workspace with in-flight runs.
Rhei's changelog is [docs/changelog.md](docs/changelog.md). It carries the
`Unreleased` section and the latest release inline; the release promotes one
into the other and archives the release it displaces under `docs/changelog/`
(§FS-rhei-distribution.5).

Nothing below is maintained by the release. The `0.1.0` notes are kept here
because this is where they were written and the archive entry for that version
is a summary; every release after it is in `docs/changelog.md`.

## 0.1.0 - 2026-05-19

Expand Down
16 changes: 16 additions & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,22 @@

## Unreleased

- **The root `CHANGELOG.md` no longer claims the release maintains it.** It
opened by saying this file's `Unreleased` section is what "release automation
promotes into a numbered section here at release time", citing
§FS-rhei-distribution.5 — which describes a promotion *within*
`docs/changelog.md`, archiving the displaced release under `docs/changelog/`,
and says nothing about the root file. `prepare_changelog_release.py` never
opens it. Documenting a behaviour that never ran, it drifted the whole way: no
`0.2.0`, `0.3.0` or `0.3.1` section, and an `Unreleased` note still announcing
project-qualified ticket ids as a forthcoming breaking change eight days after
they shipped in 0.2.0 — a note that nearly sent 0.3.1 out as a minor bump. The
header now says where the changelog is and that this file is not maintained by
the release, and the stale note is gone. The `0.1.0` section stays:
`docs/changelog/0.1.0.md` is a four-line summary, so this is the only record of
the initial release's feature list and its crates.io naming limitation.
(PR #115)

## 2. [0.3.1] - 2026-08-30

- **The release commit stages `xtask/Cargo.toml`.** `Auto bump` had failed on
Expand Down