-
-
Notifications
You must be signed in to change notification settings - Fork 228
ENH: Auto Populate Changelog #919
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: develop
Are you sure you want to change the base?
ENH: Auto Populate Changelog #919
Conversation
Add changelog.yml for processing merged PRs.
BUG: Fix of Floating Point Precision Errors.
Added new section for main features of RocketPy.
BUG: Fix of Floating Point Precision Errors/Warnings
Added emphasis to the community invitation.
MNT: Adjusted README
Added import statement example for RocketPy classes.
Update README with RocketPy import example
Update .gitignore
Update README with aerodynamic models section
Removed entry for floating point precision errors from changelog.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR introduces an automated workflow to populate the CHANGELOG.md file when pull requests are merged to the develop branch, addressing issue #905 where contributors previously had to manually add their PR titles to the changelog. The automation uses GitHub Actions to detect merged PRs, categorize them based on labels, and insert appropriately formatted entries into the correct CHANGELOG sections.
Key changes:
- Automated CHANGELOG.md updates via GitHub Actions workflow triggered on PR merge
- Updated documentation to reflect the new automated process and clarify PR naming conventions
- Self-documenting entry in CHANGELOG.md for this enhancement
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 9 comments.
| File | Description |
|---|---|
.github/workflows/changelog.yml |
New GitHub Actions workflow that automatically updates CHANGELOG.md based on PR labels, adding entries to appropriate sections (Added/Changed/Fixed) with correct prefixes (ENH/BUG/MNT/DOC/TST) |
docs/development/style_guide.rst |
Updated PR naming guidelines to clarify that PR titles should not include acronym prefixes, as the workflow adds them automatically based on labels |
docs/development/first_pr.rst |
Updated CHANGELOG documentation to inform contributors that entries are auto-generated from PR titles when merged, rather than manually added |
CHANGELOG.md |
Added self-referential entry for this PR demonstrating the new automated format with "ENH:" prefix |
Codecov Report✅ All modified and coverable lines are covered by tests. 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 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
Note to Self: improve documentation to explicitly re-route contributors on how to compose PRs. |
Pull request type
Checklist
CHANGELOG.mdhas 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
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.