From 371b4cfa342eab0e919f8fc79172368fb50d0da1 Mon Sep 17 00:00:00 2001 From: Marc Herbert Date: Wed, 6 Oct 2021 17:23:48 +0000 Subject: [PATCH 1/2] HOWTO-new-release.md: add release notes instructions A link to the original release notes should be enough. It's always possible and easy to say more if needed. Signed-off-by: Marc Herbert --- HOWTO-new-release.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/HOWTO-new-release.md b/HOWTO-new-release.md index ff96880..0a6bcce 100644 --- a/HOWTO-new-release.md +++ b/HOWTO-new-release.md @@ -78,8 +78,12 @@ Release - Only after the final sof-bin pull request has been merged, generate and upload the official release tarball to - https://github.com/thesofproject/sof-bin/releases - This page lets you create a new tag. + https://github.com/thesofproject/sof-bin/releases This page lets you + create a new tag. In text box for the release notes, add a link to + the release notes for the same tag in the other, _sof_ source repo. + Example: + + See release notes at https://github.com/thesofproject/sof/releases/tag/v1.9 If you realize you made a mistake in something already merged or released, always increase the version number and start rebuilding From ca3112f8a2ccf92f4c894a807c839468bffd1653 Mon Sep 17 00:00:00 2001 From: Marc Herbert Date: Wed, 6 Oct 2021 17:29:07 +0000 Subject: [PATCH 2/2] Add instructions to test ./install.sh in the tarball Signed-off-by: Marc Herbert --- HOWTO-new-release.md | 4 +++- install.sh | 6 ++++++ 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/HOWTO-new-release.md b/HOWTO-new-release.md index 0a6bcce..ed5f3a9 100644 --- a/HOWTO-new-release.md +++ b/HOWTO-new-release.md @@ -69,7 +69,9 @@ Release Do not publish this test tarball before your final sof-bin pull request has been merged. Extract this test tarball you just generated - and have a look at its content. + and test its short `./install.sh` script. Move your older firmware + directories first or override the install destination, see how at the + top of the script. - Submit the sof-bin pull request(s). A single pull request is normally enough but sometimes you may want to quickly share the community files diff --git a/install.sh b/install.sh index d8c34f1..d133337 100755 --- a/install.sh +++ b/install.sh @@ -1,5 +1,11 @@ #!/bin/sh +# Keep this script as short as possible _and_ optional - some +# distributions don't use it at all. +# +# The entire installation process belongs to sof/installer/ in the +# main repo where any developer can use it and fix it. + set -e # Default values, override on the command line