Skip to content

Collect changelog entries as separate files using towncrier - #600

Merged
dweindl merged 1 commit into
PEtab-dev:mainfrom
dweindl:changelog_0.11_missing
Nov 17, 2026
Merged

dweindl merged 1 commit into
PEtab-dev:mainfrom
dweindl:changelog_0.11_missing

Conversation

@dweindl

@dweindl dweindl commented Nov 17, 2026 •

Copy link
Copy Markdown
Member

Every pull request added its changelog entry at the same place in CHANGELOG.md, so concurrent pull requests conflicted with each other.

Now, each pull request adds its changelog entry as a separate file changelog.d/+<name>.<type>.md (see changelog.d/README.md). At release time, towncrier build --version X.Y.Z collects them into CHANGELOG.md and removes the fragments. The template in changelog.d/template.md.j2 reproduces the existing format (**Fixes** etc., * bullets with 2-space continuation lines). Entries are sorted alphabetically within each category; grouping them (e.g., by PEtab version or module) is done when compiling the release notes. The configuration is in pyproject.toml, and towncrier is added to the test dependency group. The release process in doc/development.rst is updated accordingly.

Entries now link to the pull request only, without "by @user"; contributors can be credited in the release notes.

The unreleased 0.11.0 entry (#578) is moved to changelog.d/, and entries are added for #583, #584, #588, #590, #592 and #595, which did not add one. The behaviour changes from #584 (top-level Boolean expressions are returned as Piecewise) and #592 (stricter PySBModel.pattern_from_string) are listed as breaking changes.

Open pull requests that edit CHANGELOG.md will need to move their entry to a fragment file.

🤖 Generated with Claude Code

@codecov-commenter

codecov-commenter commented Nov 17, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 79.75%. Comparing base (7580974) to head (749c705).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #600   +/-   ##
=======================================
  Coverage   79.75%   79.75%           
=======================================
  Files          70       70           
  Lines        8332     8332           
  Branches     1510     1510           
=======================================
  Hits         6645     6645           
  Misses       1197     1197           
  Partials      490      490           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@dweindl dweindl self-assigned this Nov 17, 2026
@dweindl
dweindl force-pushed the changelog_0.11_missing branch from 06241a1 to 3c17a37 Compare November 17, 2026 08:13
@dweindl dweindl changed the title doc: add missing changelog entries for 0.11.0 Collect changelog entries as separate files using towncrier Nov 17, 2026
@dweindl
dweindl force-pushed the changelog_0.11_missing branch from 3c17a37 to ef8e9bf Compare November 17, 2026 08:20
Every pull request added its changelog entry at the same place in
`CHANGELOG.md`, so concurrent pull requests conflicted with each other.

Now, each pull request adds its entry as a separate file
`changelog.d/+<name>.<type>.md` (see `changelog.d/README.md`). At release
time, `towncrier build --version X.Y.Z` collects them into `CHANGELOG.md`.

The unreleased 0.11.0 entry is moved to `changelog.d/`, and entries are
added for PEtab-dev#583, PEtab-dev#584, PEtab-dev#588, PEtab-dev#590, PEtab-dev#592 and PEtab-dev#595, which did not add one.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@dweindl
dweindl force-pushed the changelog_0.11_missing branch from ef8e9bf to 749c705 Compare November 17, 2026 08:20
@dweindl
dweindl marked this pull request as ready for review November 17, 2026 08:25
@dweindl
dweindl requested a review from a team as a code owner November 17, 2026 08:25
@dweindl
dweindl added this pull request to the merge queue Nov 17, 2026
Merged via the queue into PEtab-dev:main with commit b45a01c Nov 17, 2026
8 checks passed
@dweindl
dweindl deleted the changelog_0.11_missing branch November 17, 2026 13:18
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.

3 participants