Introduce release notes header template #6873
Conversation
fabriziomello
added
release
enhancement
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #6873 +/- ##
==========================================
+ Coverage 80.06% 80.98% +0.91%
==========================================
Files 190 198 +8
Lines 37181 37286 +105
Branches 9450 9734 +284
==========================================
+ Hits 29770 30197 +427
- Misses 2997 3191 +194
+ Partials 4414 3898 -516 ☔ View full report in Codecov by Sentry. |
fabriziomello
force-pushed
the
introduce_release_notes_template
branch
from
7b1870c to
72bb953
Compare
fabriziomello
changed the title
This PR introduce the release notes header template using Jinja [1]. Also improved the script to merge changelogs to include the upcoming .unreleased/RELEASE_NOTES_HEADER.md.j2 where we'll actually write the release notes header for the next release.
fabriziomello
force-pushed
the
introduce_release_notes_template
branch
from
72bb953 to
620a137
Compare
| In addition, it includes these noteworthy features: | ||
| * feature 1 | ||
| * feature 2 | ||
| * feature N |
There was a problem hiding this comment.
We should probably add a flag in the release files which ones are major and should end up as highlighted.
| echo | ||
| fi | ||
|
|
||
| echo_changelog '**Features**' '^Implements:' |
There was a problem hiding this comment.
Here we can have a separate "Major Feature" field or something similar as a separate section.
There was a problem hiding this comment.
This is something that we can improve in the future. In the current release process we always mention major features in the release notes header.
| This release contains performance improvements and bug fixes since | ||
| the {{ release_previous }} release. We recommend that you upgrade at the next | ||
| available opportunity. |
There was a problem hiding this comment.
Text probably needs to be slightly different depending on whether it is a patch release or a minor release and whether there are urgent fixes, something like:
- We recommend that you upgrade immediately
- We recommend that you upgrade at earliest available opportunity
- We recommend that you upgrade as next convenient opportunity
There was a problem hiding this comment.
Yes we can, but this is only a template file for reference. The unreleased release notes header will be placed in .unreleased/RELEASE_NOTES_HEADER.md.j2 where we'll really write the text that will be used for release PR and GH page. Have a look in other PR #6874.
This PR introduce the release notes header template using Jinja [1]. Also improved the script to merge changelogs to include the upcoming .unreleased/RELEASE_NOTES_HEADER.md.j2 where we'll actually write the release notes header for the next release.
Disable-check: force-changelog-file