docs: prepare v0.12.0 release notes, changelog, and docs version#708
Merged
Conversation
Resume the Keep a Changelog format (dormant since v0.8.10) with a v0.12.0 section, and add standalone GitHub release notes covering the changes since v0.11.3 plus the pending fix stack. Highlights: two offset data-loss fixes (#606/#707, #316/#692), the re-added confluent-kafka driver, Python 3.14 support (3.8/3.9 dropped), OpenTracing/OpenTelemetry made optional, and a live-broker CI harness. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01HHPL4VFWQRQPpjR1gXSKyL
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #708 +/- ##
=======================================
Coverage 94.15% 94.15%
=======================================
Files 104 104
Lines 11136 11136
Branches 1201 1201
=======================================
Hits 10485 10485
Misses 550 550
Partials 101 101 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
PR #683 (codecov.yml with a 1% coverage threshold) was closed without merging, so remove it from the changelog and release notes to keep the v0.12.0 change list accurate. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01HHPL4VFWQRQPpjR1gXSKyL
`docs/conf.py` hardcoded `version_dev='1.1'` / `version_stable='1.0'` - robinhood-era values that never matched faust-streaming's 0.x line, so the published GitHub Pages docs advertised the wrong version. Derive the documented major.minor from `faust.__version__` (which setuptools_scm resolves from the git tag), so the docs always report the real version and this can't silently drift between releases. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01HHPL4VFWQRQPpjR1gXSKyL
Per review, the v0.12.0 changelog/release notes should describe only what is already on master, not work still in open PRs. - Remove the not-yet-merged items: the offset-commit data-loss fixes (#606/#707, #316/#692), the optional OpenTracing/OpenTelemetry extras (#685/#686, #688/#681), web_application_options (#704), and the reported-issue fix stack (#693-#703, #705). These will be added back as they merge. - Add a Dependencies section noting the current runtime/client libraries: mode-streaming >= 0.4.0, aiokafka >= 0.10.0 (compatible with recent 0.13/0.14 releases), the new confluent-kafka >= 2.0.0 for faust[ckafka], and the faust-cchardet fork replacing unmaintained cchardet. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01HHPL4VFWQRQPpjR1gXSKyL
Replace the UNRELEASED placeholder with the release date and drop the now-satisfied "set the date at tag time" note. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01HHPL4VFWQRQPpjR1gXSKyL
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Release-prep documentation for v0.12.0. No product code changes —
versioning is setuptools_scm-driven, so the git tag is the version; this PR
prepares the human-facing notes and makes the docs report the right version.
Scope: merged-only. The changelog/release notes describe only what is
already on
master. Not-yet-merged work — the offset-commit data-loss fixes(#606/#707, #316/#692), the optional OpenTracing/OpenTelemetry extras
(#685/#686, #688),
web_application_options(#704), and the reported-issue fixstack (#693–#703, #705) — has been removed and will be folded in as it merges.
CHANGELOG.md— resumes the Keep a Changelog format (dormant sincev0.8.10) with a
## [v0.12.0]section (Added / Changed / Fixed /Dependencies) and a
v0.11.3...v0.12.0compare link. Date left asUNRELEASED; set it at tag time.RELEASE_NOTES_v0.12.0.md— standalone GitHub release notes withhighlights and a Breaking changes / upgrade notes section.
docs/conf.py— Sphinx docs version now derived fromfaust.__version__(setuptools_scm / git tag) instead of the hardcoded robinhood-era
1.1/1.0, so the published Pages docs report the real version.Merged highlights in v0.12.0
confluent://,faust[ckafka]).aredisreplaced byredis-py(Replace aredis with redis-py #635).Dependencies noted
mode-streaming >= 0.4.0,aiokafka >= 0.10.0(compatible with recent0.13/0.14 — fix: support aiokafka 0.13.0 which removed api_version parameter #674, fix(aiokafka): keep Faust assignor for changelog tables; drop Python 3.9 #682), new
confluent-kafka >= 2.0.0forfaust[ckafka],and the
faust-cchardetfork replacing unmaintainedcchardet.Tagging checklist (for the maintainer)
UNRELEASEDdate inCHANGELOG.mdto the tag date.v0.12.0on master and push — setuptools_scm picks up the version, thewheel/publish job runs, and the rebuilt Pages docs report
0.12.RELEASE_NOTES_v0.12.0.mdinto the GitHub Release.🤖 Generated with Claude Code