From 0391c0de820ccb82e6fd27a4b417772d5aa433dd Mon Sep 17 00:00:00 2001 From: "James O. D. Hunt" Date: Mon, 12 Feb 2024 10:01:23 +0000 Subject: [PATCH 1/2] packaging: Add twistie to release notes shortlog MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Add a "twistie" / arrow (`▶`) that the user can click on to see the full list of commits _if they want to_. This way, the release notes become easier to read and we can display information below the shortlog which would (probably) normally not be seen due to the huge long list of commits. Fixes: #9075. Signed-off-by: James O. D. Hunt --- tools/packaging/release/release-notes.sh | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/tools/packaging/release/release-notes.sh b/tools/packaging/release/release-notes.sh index c21c70364..d1006387e 100755 --- a/tools/packaging/release/release-notes.sh +++ b/tools/packaging/release/release-notes.sh @@ -75,9 +75,19 @@ changes() { echo "**FIXME - message this section by hand to produce a summary please**" echo "### Shortlog" + + echo "
" + echo "Click the icon to show the list of commits included in this release" + + # XXX: Essential to have at least one blank line here. It forces + # GitHub to show each commit on a separate line. + echo + for cr in $(git log --merges "${previous_release}".."${new_release}" | grep 'Merge:' | awk '{print $2".."$3}'); do git log --oneline "$cr" done + + echo "
" } print_release_notes() { From 8c72abe38dce18655bf7d3e8a9d6c9ba16d76600 Mon Sep 17 00:00:00 2001 From: "James O. D. Hunt" Date: Mon, 12 Feb 2024 10:02:24 +0000 Subject: [PATCH 2/2] packaging: Add link to survey in release notes Add a link in the release notes to the Kata Container survey, to advertise it, and hopefully encourage users to take the survey. Fixes: #9074. Signed-off-by: James O. D. Hunt --- tools/packaging/release/release-notes.sh | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/tools/packaging/release/release-notes.sh b/tools/packaging/release/release-notes.sh index d1006387e..078fd5398 100755 --- a/tools/packaging/release/release-notes.sh +++ b/tools/packaging/release/release-notes.sh @@ -104,6 +104,17 @@ EOF ## ${repo} Changes $(changes) +## Survey + +Please take the Kata Containers survey: + +- https://openinfrafoundation.formstack.com/forms/kata_containers_user_survey + +This will help the Kata Containers community understand: + +- how you use Kata Containers +- what features and improvements you would like to see in Kata Containers + EOF popd >>/dev/null rm -rf "${tmp_dir}/${repo}"