RocketPy icon indicating copy to clipboard operation
RocketPy copied to clipboard

ENH: Auto Populate Changelog

Open Malmahrouqi3 opened this issue 3 weeks ago • 2 comments

Pull request type

  • [x] Code changes (bugfix, features)

Checklist

  • [x] Tests for the changes have been added (if needed)
  • [x] Docs have been reviewed and added / updated
  • [x] CHANGELOG.md has been updated (if relevant)

Current behavior

#905 where contributors have to write down manually their PRs' title in the changelog.

New behavior

POC: Simply put, multiple branches (changelog-update{6-10}) were create with negligible changes, then merged into the main branch (changelog-update). The CHANGELOG.md was populated as requested in (IS #905), see the CHANGELOG.md. With bare titles and assigned labels, they were put into their corresponding sections along with prefixes.

Breaking change

  • [ ] Yes
  • [x] No

Additional information

The only observed issue is concurrency of the workflow runs, where some might fail even though each run is ~10s to resolve just trigger re-run or do not merge at 10 PR/s. Further, this can also be resolved with concurrency to sequence the runs but not needed whatsoever. Lastly, please leave a clearance line between the section title and the top PR.

Malmahrouqi3 avatar Dec 10 '25 01:12 Malmahrouqi3

Codecov Report

:white_check_mark: All modified and coverable lines are covered by tests. :white_check_mark: Project coverage is 81.08%. Comparing base (9cf3dd4) to head (c932654). :warning: Report is 24 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #919      +/-   ##
===========================================
+ Coverage    80.27%   81.08%   +0.80%     
===========================================
  Files          104      107       +3     
  Lines        12769    13812    +1043     
===========================================
+ Hits         10250    11199     +949     
- Misses        2519     2613      +94     

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

:rocket: New features to boost your workflow:
  • :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

codecov[bot] avatar Dec 11 '25 21:12 codecov[bot]

Note to Self: improve documentation to explicitly re-route contributors on how to compose PRs.

Malmahrouqi3 avatar Dec 11 '25 21:12 Malmahrouqi3