fix: add CHANGELOG.rst and enable semantic-release changelog - #70
Merged
Conversation
Set up automated changelog generation for python-semantic-release as part of the Open edX Python repo modernization effort: openedx/public-engineering#506 - Add `CHANGELOG.rst` with the `.. changelog-insertion-marker` that python-semantic-release updates on each release. - Add `[tool.semantic_release.changelog]` config (`mode = "update"`, `insertion_flag = ".. changelog-insertion-marker"`, and `default_templates` pinning `changelog_file = "CHANGELOG.rst"` / `output_format = "rst"`) to `pyproject.toml`. - Drop the `changelog: "false"` input from the Run Semantic Release step in `release.yml` so the changelog is generated on release. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #70 +/- ##
=======================================
Coverage 82.17% 82.17%
=======================================
Files 48 48
Lines 1419 1419
Branches 110 110
=======================================
Hits 1166 1166
Misses 221 221
Partials 32 32
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
salman2013
approved these changes
Aug 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
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.
Set up automated changelog generation for python-semantic-release, part of the Open edX Python repo modernization effort: openedx/public-engineering#506
Changes
CHANGELOG.rstwith the.. changelog-insertion-markerthat python-semantic-release updates on each release.[tool.semantic_release.changelog]config topyproject.toml—mode = "update",insertion_flag = ".. changelog-insertion-marker", anddefault_templatespinningchangelog_file = "CHANGELOG.rst"/output_format = "rst".changelog: "false"input from the Run Semantic Release step inrelease.ymlso PSR generates the changelog on release.Effect
On each release, PSR inserts the new version's notes at the marker in
CHANGELOG.rst. Thechangelog: "false"flag and this feature are mutually exclusive, so the flag is removed.Release note
Uses a
fix:commit type so PSR cuts a release for this change.🤖 Generated with Claude Code