Skip to content

Conversation

cdce8p
Copy link
Collaborator

@cdce8p cdce8p commented Oct 5, 2025

PSR changed the default for changelog generation from init to update with v10.
https://python-semantic-release.readthedocs.io/en/stable/configuration/configuration.html#mode

update does require an insertion flag inside the changelog file. The default for markdown is <!-- version list -->. As this isn't present currently, the changelog file wasn't updated properly for the last releases (0.148.0, 1.0.0).

To fix it

  1. Temporarily add changelog.mode = "init" to the config.
  2. Regenerate the changelog with semantic-release changelog
  3. Remove changelog.mode again
  4. Add <!-- version list --> (the default insertion flag for PSR) to the top of the changelog file.

https://python-semantic-release.readthedocs.io/en/stable/concepts/changelog_templates.html#changelog-templates-migrating-existing-changelog

Copy link

codspeed-hq bot commented Oct 5, 2025

CodSpeed Performance Report

Merging #1628 will not alter performance

Comparing cdce8p:fix-changelog (d170d14) with release-0.x (ec4a0ec)1

Summary

✅ 6 untouched

Footnotes

  1. No successful run was found on release-0.x (b43d039) during the generation of this report, so ec4a0ec was used instead as the comparison base. There might be some changes unrelated to this pull request in this report.

Copy link

codecov bot commented Oct 5, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.76%. Comparing base (ec4a0ec) to head (d170d14).
⚠️ Report is 2 commits behind head on release-0.x.

Additional details and impacted files
@@             Coverage Diff              @@
##           release-0.x    #1628   +/-   ##
============================================
  Coverage        99.76%   99.76%           
============================================
  Files               33       33           
  Lines             3401     3401           
  Branches           461      461           
============================================
  Hits              3393     3393           
  Misses               5        5           
  Partials             3        3           

☔ View full report in Codecov by Sentry.
📢 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.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@bdraco bdraco merged commit 0decc7b into python-zeroconf:release-0.x Oct 5, 2025
41 of 42 checks passed
@cdce8p cdce8p deleted the fix-changelog branch October 5, 2025 12:56
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.

2 participants