projectmesa / mesa-frames

Extension of mesa for performance and scalability
https://projectmesa.github.io/mesa-frames
Apache License 2.0
14 stars 5 forks source link

Create release.yml file for automatic release notes generation #95

Closed EwoutH closed 2 months ago

EwoutH commented 2 months ago

Adds a configuration file .github/release.yml that lets GitHub automatically draft release notes based on the labels attached to PRs that will be included in that release. These drafted release notes can form a consistent basis for our changelog and manually expanded with context for certain PRs if needed.

The currently proposed labels are experimental, breaking, feature, enhancement, bug, docs, ci, testing, dependency, maintenance and packaging. The last five are grouped in the changelog under Maintenance 🔧.

For this to work nicely, it's important that all merged PRs have one of these labels attached to them and that the PR titles are sufficiently descriptive.

codecov[bot] commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Please upload report for BASE (main@73a5024). Learn more about missing BASE report.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #95 +/- ## ======================================= Coverage ? 91.19% ======================================= Files ? 14 Lines ? 2193 Branches ? 0 ======================================= Hits ? 2000 Misses ? 193 Partials ? 0 ```

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

adamamer20 commented 2 months ago

Wonderful, I wanted to add that! Thanks @EwoutH!

adamamer20 commented 2 months ago

@EwoutH Can a PR have 2 different labels (eg. docs and bugs)?

EwoutH commented 2 months ago

Yes, but the top one takes precedence. For example, breaking is currently at the top, so it takes precedence over all other labels.

So you can reorder them if you like another priority.