Skip to content

build(changelog): towncrier news fragments and a draft check - #26

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

HaoZeke merged 1 commit into
mainfrom
fix/towncrier

Conversation

@HaoZeke

@HaoZeke HaoZeke commented Nov 15, 2026

Copy link
Copy Markdown
Collaborator

Release notes go into CHANGELOG.md by hand, so any two pull requests that touch it conflict. eb-local, eessi-arch-guard and rfc9162 take one fragment per change in changelog.d/ and build the section at release with towncrier. This does the same here.

  • towncrier.toml: same fragment types as the other repositories (feature, bugfix, doc, removal, misc), with this changelog's ## X.Y.Z - date heading and its Added/Fixed/Documentation/Removed/Changed section names. ignore = [] makes a misnamed fragment an error instead of a silent skip.
  • CHANGELOG.md gets the <!-- towncrier release notes start --> marker above 0.7.4.
  • .github/workflows/changelog.yml drafts the changelog with the version from Cargo.toml and checks that a misnamed fragment fails.
  • CONTRIBUTING asks for a fragment per pull request and uses towncrier build in release step 5.

towncrier build --draft --version 0.7.4 (towncrier 26.9.0) renders the one fragment, and a file named not-a-fragment.md fails with "Invalid news fragment name". The workflow YAML and towncrier.toml parse. Merge this before the eessi-extend-eb.sh fix, which adds a fragment.

Release notes went into CHANGELOG.md by hand, so any two pull
requests that touch it conflict. The other stackhands repositories
take one fragment per change in changelog.d/ and build the section at
release with towncrier.

towncrier.toml follows theirs, with this changelog's heading and
section names. A workflow drafts the changelog on each pull request,
with the version from Cargo.toml, and checks that a misnamed fragment
fails. CONTRIBUTING asks for a fragment and puts towncrier build in the
release steps.
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