Release docs#677
Conversation
|
Before you submit for review:
If you did not complete any of these, then please explain below. |
There was a problem hiding this comment.
This look great. One suggestion: we could make the release note generation more structured by standardizing the source filenames to <#PR>..md (eg 668.performance.md, 659.newfeature.md). The workflow can then automatically group entries by tag (e.g., Performance, New Features, Bug Fixes) in the release notes (making it more structured) instead of relying on manual order. It also makes it easy to add a link to the corresponding PR in the notes itself for easy reference.
|
Great idea @r-devulap, pushed changes to that effect now |
|
Awesome, do we want to regenerate the 4.0.0.RC8 release notes based on the PR/Tag format? |
| | `performance` | Performance Improvements | | ||
| | `bugfix` or `fix` | Bug Fixes and Issue Resolutions | | ||
| | `docs` | Documentation and Tutorials | | ||
| | `testing` | Testing Enhancements | |
There was a problem hiding this comment.
Add bench for benchmarks related?
This PR adds a skeleton for adding robust release notes for all features included in a specific release, as well as a github action for combining individual contributor release notes into a single release-wide markdown file to be included as a release artifact.