[ ] You've included unit or integration tests for your change, where applicable.
[ ] You've included inline docs for your change, where applicable.
[ ] There's an open issue for the PR that you are making. If you'd like to propose a change, please open an issue to discuss the change or find an existing issue.
Summary of the changes
Added Automation for Release Notes
Description
Added a .github/release.yml template to automatically generate and categorize the release notes using PR titles and labels.
Also updated the release procedure because generating the release notes requires the tag to exist.
NOTE: To those merging PRs, it will make releases easier if we address the following before merging PRs:
Change the title to concisely describe the change in the PR (keep in mind it will be a line item in the release notes)
Add a label to categorize (or ignore) the PR using the following table:
GitHub Label
Action
notes:ignore
Removes the PR from the release notes
notes:breaking-change
Categorizes the PR under "Breaking Changes"
notes:new-feature
Categorizes the PR under "New Features"
notes:bug-fix
Categorizes the PR under "Bug Fixes"
notes:performance-improvement
Categorizes the PR under "Performance Improvements"
notes:website-or-documentation
Categorizes the PR under "Website and API Documentation"
Summary of the changes
Added Automation for Release Notes
Description
Added a
.github/release.ymltemplate to automatically generate and categorize the release notes using PR titles and labels.Also updated the release procedure because generating the release notes requires the tag to exist.