sdv-dev / SDV

Synthetic data generation for tabular data
https://docs.sdv.dev/sdv
Other
2.21k stars 287 forks source link

Release notes should not include PRs #2074

Closed npatki closed 1 week ago

npatki commented 2 weeks ago

Problem Description

We currently have an automated script that creates the release notes for each SDV release. This script is meant to mention all issues that we've included in the release (based off the milestone), and sort them as feature request, bug, or miscellaneous based on the tag.

But in practice, we see that the "Miscellaneous" section actually contains PRs, not issues. This is confusing because each PR should already be attached to an issue -- meaning that the bug or feature it represents is already included in the release notes. It leads to doubly mentioning the bug or feature.

Eg. In the 1.14.0 release notes we see PR #2043 linked under Miscellaneous. But this PR is fixing issue #2031 which is already listed under bugs.

Expected behavior