raimon49/pip-licenses
Changelog and Release Notes - Single source of truth?
Offen
#272 geöffnet am 21.01.2026
help wantedquestion
Repository-Metriken
- Stars
- (372 Sterne)
- PR-Merge-Metriken
- (PR-Metriken ausstehend)
Beschreibung
I suggest a single source of truth to document changes. Currently:
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.mdare not appended toREADME.mdany 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.