Skip to content

fix: add CHANGELOG.rst and enable semantic-release changelog - #70

Merged
farhan merged 1 commit into
mainfrom
re-add-changelog
Aug 20, 2026
Merged

fix: add CHANGELOG.rst and enable semantic-release changelog#70
farhan merged 1 commit into
mainfrom
re-add-changelog

Conversation

@farhan

@farhan farhan commented Aug 20, 2026

Copy link
Copy Markdown
Contributor

Set up automated changelog generation for python-semantic-release, part of the Open edX Python repo modernization effort: openedx/public-engineering#506

Changes

  • Add CHANGELOG.rst with the .. changelog-insertion-marker that python-semantic-release updates on each release.
  • Add [tool.semantic_release.changelog] config to pyproject.tomlmode = "update", insertion_flag = ".. changelog-insertion-marker", and default_templates pinning changelog_file = "CHANGELOG.rst" / output_format = "rst".
  • Drop the changelog: "false" input from the Run Semantic Release step in release.yml so PSR generates the changelog on release.

Effect

On each release, PSR inserts the new version's notes at the marker in CHANGELOG.rst. The changelog: "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

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

codecov Bot commented Aug 20, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.17%. Comparing base (b19a7a5) to head (08edf88).

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           
Flag Coverage Δ
unittests 82.17% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 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.

@farhan
farhan merged commit b183eff into main Aug 20, 2026
8 checks passed
@farhan
farhan deleted the re-add-changelog branch August 20, 2026 11:17
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