Skip to content

chore: towncrier - #16

Merged
HaoZeke merged 1 commit into
mainfrom
chore/towncrier
Nov 16, 2026
Merged

HaoZeke merged 1 commit into
mainfrom
chore/towncrier

Conversation

@HaoZeke

@HaoZeke HaoZeke commented Nov 16, 2026

Copy link
Copy Markdown
Collaborator

Moves the changelog to towncrier, with the same towncrier.toml as zig-common apart from name and the pull-request link.

The 14 "Unreleased" entries become 12 fragments in changelog.d/; two pairs where the second bullet continues the first are merged. A changelog.yml workflow, copied from eb-local with SHA-pinned actions, fails a PR that adds no fragment. The docs test now also scans changelog.d/ for design-note ids.

zig build test (34/34), the unit suite, the TESTMAP check and the strict docs build pass.

towncrier.toml is zig-common's: the five fragment types, the start
string and ignore = [], with this repository's name and pull request
links. CHANGELOG.md keeps its released sections, and its Unreleased
entries move to changelog.d/ as orphan fragments named after the branch
that added them. The section heading now carries the type, so the "Fix:"
and "Docs:" prefixes go. Two entries refer back to the one before them
("that rewrite", "that checkout"); each pair stays one fragment, since
towncrier sorts orphan fragments by their text.

.github/workflows/changelog.yml is the fragment check of eb-local and
eb-stack with this repository's action pins: it drafts the notes with
towncrier 26.9.0 and fails on a fragment whose name has no type.
RELEASING.md runs towncrier build at release, the README says that a
change adds a fragment, and the design-note id scan covers changelog.d/.
@HaoZeke
HaoZeke merged commit c44b8ad into main Nov 16, 2026
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant