Skip to content
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

Release notes should not include PRs #2074

Closed
npatki opened this issue Jun 17, 2024 · 0 comments · Fixed by #2083
Closed

Release notes should not include PRs #2074

npatki opened this issue Jun 17, 2024 · 0 comments · Fixed by #2083
Assignees
Labels
maintenance Tasks related to infrastructure & dependencies
Milestone

Comments

@npatki
Copy link
Contributor

npatki commented Jun 17, 2024

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

  • Only issues should be tagged in the release notes, not PRs
  • The Miscellaneous section should only include issues that are NOT tagged as feature request or bug
@npatki npatki added internal The issue doesn't change the API or functionality maintenance Tasks related to infrastructure & dependencies labels Jun 17, 2024
@amontanez24 amontanez24 removed the internal The issue doesn't change the API or functionality label Jun 20, 2024
@amontanez24 amontanez24 self-assigned this Jul 9, 2024
@amontanez24 amontanez24 added this to the 1.15.0 milestone Jul 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Tasks related to infrastructure & dependencies
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants