raimon49/pip-licenses

Changelog and Release Notes - Single source of truth?

開放

#272 建立於 2026年1月21日

 (5 則留言) (0 個反應) (1 位負責人)Python (58 個分叉)auto 404
help wantedquestion

倉庫指標

星標
 (372 顆星)
PR 合併指標
 (平均合併 15天 2小時) (30 天內合併 1 個 PR)

描述

I suggest a single source of truth to document changes. Currently:

  1. CHANGELOG.md
  2. GitHub Releases page

Wouldn't it make sense to avoid duplication? How about keeping GitHub Releases and discarding CHANGELOG.md? This would imply that:

  • the contents of CHANGELOG.md are not appended to README.md any more, removing the need for a dynamic README while building sdist,
  • and on the PyPI project page, changes would only be accessible through the existing Releases link - but that's what "all" projects do.

Are repository maintainers able to modify release notes GitHub Releases page after the fact? I am asking because it would allow to align this page with the contents of CHANGELOG.md and then get rid of CHANGELOG.md.

貢獻者指南