fix(ci): add CHANGELOG insertion flag for python-semantic-release v10#116
Merged
Conversation
Contributor
Vulnerability Scan: PassedImage: No vulnerabilities found. Commit: 28cc52d |
python-semantic-release v10's default changelog mode inserts new release sections at a `<!-- version list -->` marker in the target file. Our CHANGELOG predates this convention, so the writer silently no-ops when the release workflow generates a new version. Changes: - CHANGELOG.md: add the `<!-- version list -->` marker between the title and the v1.0.0 heading; existing history untouched. - pyproject.toml: move changelog config to `[tool.semantic_release.changelog.default_templates]` to silence the v10 deprecation warning (same option, new section name). No workflow changes required. Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
abubnalitic-nbl
force-pushed
the
fix/release-changelog
branch
from
c69dd9a to
04b3bd4
Compare
ltucker
approved these changes
Apr 20, 2026
ltucker
approved these changes
Apr 20, 2026
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
2 participants
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.
Summary
The first run of the PR-based release workflow opened #115 with
pyproject.tomland__init__.pybumped, but without aCHANGELOG.mdentry. Closed that PR; this fixes the root cause.Root cause
python-semantic-releasev10's default changelogmode = "update"inserts new release sections at a<!-- version list -->marker in the target file. OurCHANGELOG.mdpredates this convention, so the writer silently no-ops when the workflow generates a new version.Changes
CHANGELOG.md— add the<!-- version list -->marker between the title and the first version heading. Existing v1.0.0 / v0.1.0 content is untouched; new release sections are inserted at the marker.pyproject.toml— rename[tool.semantic_release.changelog]to[tool.semantic_release.changelog.default_templates]to silence the v10 deprecation warning. Same option, new section name.No workflow changes required.
Validation
Reproduced locally against
python-semantic-release==10.5.3by applying these changes and running the same command the workflow uses:uvx --from 'python-semantic-release==10.5.3' semantic-release version \ --no-commit --no-push --no-tag --no-vcs-release --skip-buildResult: CHANGELOG.md, pyproject.toml, and init.py are all updated; the v1.1.0 section groups the unreleased commits under Features / Bug Fixes as expected.
Test plan
## v1.1.0section in CHANGELOG.mdv1.1.0tag and GitHub Release🤖 Generated with Claude Code