Based on https://github.com/integrations/terraform-provider-github/issues/1506#issuecomment-1530476255, I added a configuration to customize the auto-generated changelog (release notes). I mainly used the labels with Type: prefix, but added a couple more categories for dependency updates and deprecations. Any changes that don't have one of those labels will go into the "Others" category.
This is purely cosmetic change, but I believe it will make it easier for the users to see what's new and what is more important to them.
Before the change?
All changes in the release notes were listed together under "What's Changed"
After the change?
Release notes will group changes based on the labels assigned to the merged PRs
Pull request checklist
[x] Tests for the changes have been added (for bug fixes / features)
[x] Docs have been reviewed and added / updated if needed (for bug fixes / features)
Resolves #1506
Based on https://github.com/integrations/terraform-provider-github/issues/1506#issuecomment-1530476255, I added a configuration to customize the auto-generated changelog (release notes). I mainly used the labels with
Type:prefix, but added a couple more categories for dependency updates and deprecations. Any changes that don't have one of those labels will go into the "Others" category.This is purely cosmetic change, but I believe it will make it easier for the users to see what's new and what is more important to them.
Before the change?
After the change?
Pull request checklist
Does this introduce a breaking change?