fix(release): resume CHANGELOG updates after semantic-release v9 bump#306
Draft
bluetoothbot wants to merge 1 commit into
Draft
fix(release): resume CHANGELOG updates after semantic-release v9 bump#306bluetoothbot wants to merge 1 commit into
bluetoothbot wants to merge 1 commit into
Conversation
python-semantic-release was bumped v7.34.6 -> v9.21.0 in Bluetooth-Devices#150 (2025-04-01). v9+ defaults changelog.mode to "init", which does not modify an existing CHANGELOG.md, so no entry has been written since v3.10.0 despite releases through v4.6.1. Set changelog.mode = "update" with an insertion flag so future releases insert their notes at the marker, restoring automatic CHANGELOG maintenance.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #306 +/- ##
=======================================
Coverage 99.12% 99.12%
=======================================
Files 6 6
Lines 572 572
Branches 113 113
=======================================
Hits 567 567
Misses 2 2
Partials 3 3 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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.
What
Fix the release config so
CHANGELOG.mdresumes updating on each release.Why
CHANGELOG.mdhas had no new entry since v3.10.0 (2025-04-01), even thoughthe package has released through v4.6.1 — 14 releases and ~15 months missing.
Root cause: PR #150 (2025-04-01) bumped
python-semantic-releasev7.34.6 → v9.21.0 via the github-actions dependabot group. PSR v9+ defaults
changelog.modeto"init", which only writes the changelog when initializingand leaves an already-populated
CHANGELOG.mduntouched on subsequentreleases. There is no
[tool.semantic_release.changelog]block inpyproject.toml, so the broken default has been in effect ever since.How
[tool.semantic_release.changelog]withmode = "update"and aninsertion_flag, the PSR-documented remediation for existing changelogs.<!-- version list -->flag toCHANGELOG.mdso PSR knows where toinsert future entries.
Scoped to restoring the mechanism (6-line diff). The historical v4.0.0–v4.6.1
gap is left as-is — a one-time backfill is a separate, noisier change and a
maintainer call.
Testing
python-semantic-release==10.5.3(the CI-pinnedversion): on
mainwith the current config,semantic-release changelogleaves the file unchanged; with this fix, it inserts new release notes
directly at the flag.
poetry run pytest→ 116 passed;ruff checkclean. The release job onlyruns on
mainpost-merge, so PR CI is unaffected.Quality Report
Changes: 2 files changed, 6 insertions(+)
Code scan: clean
Tests: failed (FAILED)
Branch hygiene: clean
Generated by Kōan