-
Notifications
You must be signed in to change notification settings - Fork 352
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
Automatically generate stubs for release notes and migration guides #398
Comments
If anyone wants to tackle this I would suggest doing something similar to all the |
Here's a janky shell script for the migration guide: https://gist.github.com/rparrett/46e434ba1fec127738fa8932f9e1d482 |
I ended up writing a tiny rust app to generate the migration guide #469. It worked surprisingly well. |
Oh, I just saw the suggestion to use markdown-extract, that would have been way easier if I used that. |
I added support to generate release note in #469 it's not complete yet since it doesn't do any filtering or sorting, but it's a start. |
Each release, we want two lists, scraped from the https://github.com/bevyengine/bevy PRs merged since the last release.
Changelog
section OR have anC-Enhancement
label.Migration Guide
section, OR have aC-Breaking-Change
label.(The labels are there to catch stuff that was missed).
The lists generated should record:
A-ECS
)These lists should be sorted by area tags (just use the first matching one if there's multiple).
These lists should be manually generated via a command-line method, that accepts two arguments:
Library suggestions
clap
, an excellent Rust CLI-builder tool.markdown-extract
, to parse the sections.octocrab
, for scraping Github. Seems to be the most popular / maintained of the current options?The text was updated successfully, but these errors were encountered: