toruseo / UXsim

Vehicular traffic flow simulator in road network, written in pure Python
https://toruseo.jp/UXsim/docs/
MIT License
138 stars 61 forks source link

Add release.yml file for automatic release notes generation #114

Closed EwoutH closed 3 months ago

EwoutH commented 3 months ago

This PR 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 breaking, experimental, feature, enhancement, bug, docs, ci, testing, dependency, maintenance and packaging. The last four 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.

As an example, we use this over at Mesa to create pretty release notes:

For further reference, see Automatically generated release notes.

toruseo commented 3 months ago

thanks, will try

and glad to see that "measure-coverage" test is successfully skiped