Skip to content

Bring the changelog up to date, in Keep a Changelog format - #232

Merged
Flix6x merged 4 commits into
mainfrom
docs/231-changelog
Oct 17, 2026
Merged

Flix6x merged 4 commits into
mainfrom
docs/231-changelog

Conversation

@Flix6x

@Flix6x Flix6x commented Oct 16, 2026 •

Copy link
Copy Markdown
Member

Description

Closes #231: the changelog stopped at v0.1.1. It now covers all 48 releases up to v0.9.6, plus an Unreleased section for what is on main since then (#225).

  • Format: Keep a Changelog, in reStructuredText so that the docs keep including it as they are.
    Each version has its release date and a link to its changes since the previous version.
    Entries are grouped under Added, Changed, Deprecated, Removed, Fixed and Security, and end in links to their PRs.
    Breaking changes are marked as such (v0.2.1 moved the exception classes, v0.3.3 made S2 an optional extra).
  • S2 in its own changelog: changes to the S2 integration are listed in CHANGELOG-S2.rst.
    CHANGELOG.rst still has every release, and each release that changed the S2 integration links to its section in the S2 changelog.
    S2 sections link back to releases that also made other changes.
    The links use the anchors GitHub gives the release headings (e.g. #v090--2026-04-21), as the docs are read on GitHub.
    They point at main, so they resolve once this is merged.
    The breaking change that made S2 an optional extra (v0.3.3) is listed in both.
  • Sources: the PRs in each tag range, found from squash-merge, merge and backport commit subjects.
    PRs merged into feature branches (e.g. Add belief_time_measured_instantly parameter to data upload API #140, Add backward-compatible JSON field parsing to asset and sensor methods #165, feat: warn when using aggregate-power flex-context field with server < 0.31.0 #182) are listed under the PR that brought them to main.
    Releases without PRs are described from their commits.
  • Dates: those of the PyPI uploads. Five tags never reached PyPI (v0.1.2, v0.1.3, v0.2.2, v0.2.3, v0.5.2), so they use the tag date and say so.
  • Release history quirks: v0.9.1 to v0.9.3 were backports from a maintenance branch, so v0.9.4 lists only what was new since v0.9.0 and says it also contains those fixes. v0.9.5 is the same commit as v0.9.4.
  • Keeping it current: a PR template with a changelog checkbox, a step in CONTRIBUTING.rst for adding an entry to the right changelog, and release steps for rolling Unreleased over to the new version in both.

Left out of #231's proposal, for later:

  • A CI check that fails when src/ changes without a changelog entry.
  • Taking the GitHub release notes from the changelog instead of generating them from commit messages.

Once this is merged, #230 needs an entry under Unreleased.

How to test

  • Read CHANGELOG.rst, or the rendered changelog page after building the docs (sphinx-build -b html docs docs/_build/html).
  • docutils reports no warnings for CHANGELOG.rst and CHANGELOG-S2.rst.
  • All 35 links between the two changelogs match the heading anchors on GitHub's rendering of this branch's CHANGELOG.rst.

🤖 Generated with Claude Code

https://claude.ai/code/session_01KVweu7HHCzk5yhWTskgjva

Flix6x and others added 2 commits October 17, 2026 00:06
Lists every release from v0.1.0 to v0.9.6, plus what is unreleased on main,
grouped under Added, Changed, Deprecated, Removed, Fixed and Security,
with links to the pull requests and to the changes since the previous release.
Release dates are those of the PyPI uploads, or of the tags for the five versions that never reached PyPI.

Refs #231

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01KVweu7HHCzk5yhWTskgjva
Signed-off-by: F.N. Claessen <felix@seita.nl>
…elease

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01KVweu7HHCzk5yhWTskgjva
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x Flix6x added the documentation Improvements or additions to documentation label Oct 16, 2026
@coveralls

coveralls commented Oct 16, 2026 •

Copy link
Copy Markdown

Coverage Report for CI Build 39041949348

Coverage remained the same at 95.991%

Details

  • Coverage remained the same as the base build.
  • Patch coverage: No coverable lines changed in this PR.
  • No coverage regressions found.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

No coverage regressions found.


Coverage Stats

Coverage Status
Relevant Lines: 923
Covered Lines: 886
Line Coverage: 95.99%
Coverage Strength: 9.6 hits per line

💛 - Coveralls

Flix6x and others added 2 commits October 17, 2026 16:33
CHANGELOG-S2.rst lists the changes to the S2 integration, for each release that made any.
The main changelog keeps every release, and refers to the S2 section of each release that changed the S2 integration;
S2 sections refer back to releases that also made other changes.
The breaking change that made S2 an optional extra is listed in both.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01KVweu7HHCzk5yhWTskgjva
Signed-off-by: F.N. Claessen <felix@seita.nl>
The client docs are read on GitHub, which renders Sphinx roles as raw text and drops their labels.
Link to each release's heading on GitHub instead, by the anchor GitHub gives it.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01KVweu7HHCzk5yhWTskgjva
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
Flix6x merged commit 2aaa5e4 into main Oct 17, 2026
17 checks passed
@Flix6x
Flix6x deleted the docs/231-changelog branch October 17, 2026 15:08
Flix6x added a commit that referenced this pull request Oct 17, 2026
Brings in the updated changelog (#232), to add this PR's entry to.

Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x Flix6x mentioned this pull request Oct 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Bring the changelog up to date, in Keep a Changelog format

2 participants