From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from picard.linux.it (picard.linux.it [213.254.12.146]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 4996AE743EC for ; Fri, 29 Sep 2023 05:31:02 +0000 (UTC) Received: from picard.linux.it (localhost [IPv6:::1]) by picard.linux.it (Postfix) with ESMTP id B58983CBA8B for ; Fri, 29 Sep 2023 07:31:00 +0200 (CEST) Received: from in-4.smtp.seeweb.it (in-4.smtp.seeweb.it [217.194.8.4]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (P-384)) (No client certificate requested) by picard.linux.it (Postfix) with ESMTPS id 8B4B63CBA31 for ; Fri, 29 Sep 2023 07:30:49 +0200 (CEST) Received: from smtp-out1.suse.de (smtp-out1.suse.de [IPv6:2001:67c:2178:6::1c]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by in-4.smtp.seeweb.it (Postfix) with ESMTPS id 627061000C33 for ; Fri, 29 Sep 2023 07:30:47 +0200 (CEST) Received: from imap2.suse-dmz.suse.de (imap2.suse-dmz.suse.de [192.168.254.74]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (P-521) server-digest SHA512) (No client certificate requested) by smtp-out1.suse.de (Postfix) with ESMTPS id F0C5A218E7; Fri, 29 Sep 2023 05:30:46 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=suse.de; s=susede2_rsa; t=1695965446; h=from:from:reply-to:date:date:message-id:message-id:to:to:cc:cc: mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=LyC9q/Qq1Z7cgSxUteuymlvnmoMD8jgoYuDOdkhA3+o=; b=J26XSTt9kwp52NatKVNzj50IEZXcKxiZD/S7mnN8mjOh3yxLCifEBpGuw2UR4sXL8YMCFz HpOieZrflAh7fBMOgl7a84/Whrra87g8okMRf5pbm0FBWpt6yw22PLexEW1MOAbXtQrHOs FWKJrYfAg7w0dwJmDaxCIdZsLLdzqGY= DKIM-Signature: v=1; a=ed25519-sha256; c=relaxed/relaxed; d=suse.de; s=susede2_ed25519; t=1695965446; h=from:from:reply-to:date:date:message-id:message-id:to:to:cc:cc: mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=LyC9q/Qq1Z7cgSxUteuymlvnmoMD8jgoYuDOdkhA3+o=; b=FDKrRE5tyh3irmYcOYKOG/5V5I0GmqARAhJslxXrZ99j9WoGTffzT2/2865Q5AuRi1VkcF Y2h3Z8tHUKdDwJAg== Received: from imap2.suse-dmz.suse.de (imap2.suse-dmz.suse.de [192.168.254.74]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (P-521) server-digest SHA512) (No client certificate requested) by imap2.suse-dmz.suse.de (Postfix) with ESMTPS id 306851377D; Fri, 29 Sep 2023 05:30:45 +0000 (UTC) Received: from dovecot-director2.suse.de ([192.168.254.65]) by imap2.suse-dmz.suse.de with ESMTPSA id RV1pAAVhFmUZGQAAMHmgww (envelope-from ); Fri, 29 Sep 2023 05:30:45 +0000 From: Avinesh Kumar To: Petr Vorel Date: Fri, 29 Sep 2023 11:00:42 +0530 Message-ID: <12123900.MKNY5bReCh@localhost> Organization: SUSE In-Reply-To: <20230927202121.300325-6-pvorel@suse.cz> References: <20230927202121.300325-1-pvorel@suse.cz> <20230927202121.300325-6-pvorel@suse.cz> MIME-Version: 1.0 X-Virus-Scanned: clamav-milter 1.0.1 at in-4.smtp.seeweb.it X-Virus-Status: Clean Subject: Re: [LTP] [PATCH v2 5/6] doc: Update release procedure X-BeenThere: ltp@lists.linux.it X-Mailman-Version: 2.1.29 Precedence: list List-Id: Linux Test Project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Richard Palethorpe , ltp@lists.linux.it Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: ltp-bounces+ltp=archiver.kernel.org@lists.linux.it Sender: "ltp" Hi Petr, Thank you for these scripts and documentation, makes the release process very clear. I didn't try running the scripts but looks fine. Few minor spelling and grammatical nits below: Reviewed-by: Avinesh Kumar for all the patches. On Thursday, September 28, 2023 1:51:20 AM IST Petr Vorel wrote: > * Completely rewrite Release preparation (Cyril). > * Update command examples. > * Document helper scripts. > * Update link to the release announcement. > > Co-developed-by: Cyril Hrubis > Signed-off-by: Petr Vorel > --- > "LTP Release Procedure" wiki page is (temporarily) visible on: > https://github.com/pevik/ltp/wiki/TEST > > doc/LTP-Release-Procedure.asciidoc | 160 +++++++++++++++++++++++++---- > 1 file changed, 138 insertions(+), 22 deletions(-) > > diff --git a/doc/LTP-Release-Procedure.asciidoc > b/doc/LTP-Release-Procedure.asciidoc index cd7682fb8..101a1b8cb 100644 > --- a/doc/LTP-Release-Procedure.asciidoc > +++ b/doc/LTP-Release-Procedure.asciidoc > @@ -1,59 +1,175 @@ > LTP Release Procedure > ===================== > > -This page contains quick summary of what needs to be done to do a LTP > release. It's expected that LTP git is frozen and git HEAD was properly > tested and that LTP git tree is cloned to a directory named 'ltp'. +1. > Release preparations > +----------------------- > + > +The release procedure generally takes a few weeks. In the first week or two > +patches that should go into the release are reviewed and possibly merged. s/two patches/two, patches/ > These +patches are either fixes or patches pointed out by the community. + > +Patch review, when finished, is followed by a git freeze, which is a period > +where only fixes are pushed to the git. During that period community is > +expected to run a LTP pre-release tests, reports problems, and/or send > fixes to +the mailing list. In this period we are especially making sure > that there are +no regressions in the test results on a wide range of > distributions and +architectures. > + > +Once the stabilization period has ended the time has finally come to > proceed +with the release. > > NOTE: The string YYYYMMDD should be substituted to the current date. probably this note should be moved down in the "3. Tag the git and push changes to github" section. > > -1. Tag the git > --------------- > +2. Prepare the release notes > +---------------------------- > + > +Part of the preparation is also to write the release notes, which are then > add +to GitHub release and also send as announcement to various mailing s/add to Github/added to the GitHub s/also send/also sent > list (see below). + s/list/lists > +Have a look at https://lore.kernel.org/ltp/ZGNiQ1sMGvPU_ETp@yuki/ to get > the +idea how it should look. > + > +3. Tag the git and push changes to github > +----------------------------------------- > > [source,sh] > -------------------------------------------------------------------- > cd ltp > echo YYYYMMDD > VERSION > -git commit -s -m 'LTP YYYYMMDD' VERSION > -git tag -a YYYYMMDD -m 'LTP YYYYMMDD' > +git commit -S -s -m 'LTP YYYYMMDD' VERSION > +git tag -s -a YYYYMMDD -m 'LTP YYYYMMDD' > +git push origin master:master > +git push origin YYYYMMDD > -------------------------------------------------------------------- > > -2. Push changes to github > -------------------------- > +NOTE: You can use './tools/tag-release.sh' script to have the above > automated. + It allows you to verify the tag before pushing it and > does other checks. + > [source,sh] > -------------------------------------------------------------------- > -git push > -git push --tags > +$ ./tools/tag-release.sh > +===== git push ===== > +echo "new tag: 'YYYYMMDD', previous tag: '20230127'" > +tag YYYYMMDD > +Tagger: Person-who-released LTP > +Date: Tue May 16 07:08:27 2023 +0200 > + > +LTP YYYYMMDD > +-----BEGIN PGP SIGNATURE----- > + > +iQJDBAABCAAtFiEEIBb+pIWLHDazLoM6wN7C7nLzOl8FAmRjD8sPHHB2b3JlbEBz > +... > +-----END PGP SIGNATURE----- > + > +commit 3ebc2dfa85c2445bb68d8c0d66e33c4da1e1b3a7 > +gpg: Signature made Tue 16 May 2023 07:08:08 AM CEST > +gpg: using RSA key 2016FEA4858B1C36B32E833AC0DEC2EE72F33A5F > +... > +Primary key fingerprint: 2016 FEA4 858B 1C36 B32E 833A C0DE C2EE 72F3 3A5F > +Author: Person-who-released LTP > +Date: Tue May 16 07:08:08 2023 +0200 > + > + LTP YYYYMMDD > + > + Signed-off-by: Person-who-released LTP > + > +diff --git a/VERSION b/VERSION > +index af4c41fec..ae488c0e7 100644 > +--- a/VERSION > ++++ b/VERSION > +@@ -1 +1 @@ > +-20230127 > ++YYYYMMDD > + > +Please check tag and signature. Proceed? [N/y]: y > +Pushing changes to upstream git. Proceed? [N/y]: y > +Enumerating objects: 1, done. > +Counting objects: 100% (1/1), done. > +Writing objects: 100% (1/1), 811 bytes | 811.00 KiB/s, done. > +Total 1 (delta 0), reused 1 (delta 0), pack-reused 0 > +To github.com:linux-test-project/ltp.git > + * [new tag] YYYYMMDD -> YYYYMMDD > -------------------------------------------------------------------- > > -3. Prepare tarballs > -------------------- > +4. Prepare tarballs and metadata documentation > +---------------------------------------------- > + > [source,sh] > -------------------------------------------------------------------- > +# clone already clonned git repository to new folder > cd .. > git clone ltp ltp-full-YYYYMMDD > cd ltp-full-YYYYMMDD > -# Update mce-inject submodule > -git submodule init > -git submodule update > + > +# update all submodules > +git submodule update --init > + > # Generate configure script > make autotools > -# Prepare the archives > + > +# Generate tarballs > cd .. > tar -cjf ltp-full-YYYYMMDD.tar.bz2 ltp-full-YYYYMMDD --exclude .git > tar -cJf ltp-full-YYYYMMDD.tar.xz ltp-full-YYYYMMDD --exclude .git > + > +# Generate checksums > +md5 ltp-full-YYYYMMDD.tar.xz > ltp-full-YYYYMMDD.tar.xz.md5 > +sha1 ltp-full-YYYYMMDD.tar.xz > ltp-full-YYYYMMDD.tar.xz.sha1 > +sha256sum ltp-full-YYYYMMDD.tar.xz > ltp-full-YYYYMMDD.tar.xz.sha256 > + > +# Generate metadata documentation > +./configure --with-metadata-generator=asciidoctor > +make -C metadata > +cp -v docparse/metadata.html ../metadata.YYYYMMDD.html > -------------------------------------------------------------------- > > -4. Upload the tarballs to GitHub > --------------------------------- > +NOTE: You can use './tools/create-tarballs-metadata.sh' script to have the > + above automated. All generated files are placed in ltp-release- YYYYMMDD > + directory. > > -Click on 'releases' then switch to 'tags' then click on 'Add release notes' > there should be 'Attach binaries ...' link at the bottom of the page. > +[source,sh] > +-------------------------------------------------------------------- > +$ ./tools/create-tarballs-metadata.sh > +===== git clone ===== > +Cloning into 'ltp-full-YYYYMMDD'... > +done. > +===== Update submodules ===== > +Submodule 'tools/kirk' (https://github.com/linux-test-project/kirk.git) > registered for path 'tools/kirk' +Submodule 'tools/ltx/ltx-src' > (https://github.com/linux-test-project/ltx.git) registered for path > 'tools/ltx/ltx-src' +Submodule 'tools/sparse/sparse-src' > (git://git.kernel.org/pub/scm/devel/sparse/sparse.git) registered for path > 'tools/sparse/sparse-src' +... > +===== Generate configure script ===== > +sed -n '1{s:LTP-:m4_define([LTP_VERSION],[:;s:$:]):;p;q}' VERSION > > m4/ltp-version.m4 +aclocal -I m4 > +autoconf > +autoheader > +automake -c -a > +configure.ac:21: installing './compile' > +... > +make[1]: Leaving directory > '/home/foo/ltp-release-YYYYMMDD/ltp-full-YYYYMMDD/testcases/open_posix_test > suite' +===== Generate tarballs ===== > +===== Generate checksums ===== > +===== Generate metadata documentation ===== > +checking for a BSD-compatible install... /usr/bin/install -c > +... > +asciidoctor -d book metadata.txt -b xhtml > +make[1]: Leaving directory > '/home/foo/ltp-release-YYYYMMDD/ltp-full-YYYYMMDD/docparse' +make: Leaving > directory '/home/foo/ltp-release-YYYYMMDD/ltp-full-YYYYMMDD/metadata' > +'docparse/metadata.html' -> > '/home/foo/ltp-release-YYYYMMDD/metadata.YYYYMMDD.html' +Generated files > are in '/home/foo/ltp-release-YYYYMMDD', upload them to github > +-------------------------------------------------------------------- > > -Don't forget to upload md5 and sha-1 sums for the tarballs as well. > +5. Upload the generated files to GitHub > +--------------------------------------- > + > +Click on 'releases' then switch to 'tags', then click on 'Add release > notes'. +There should be 'Attach binaries ...' link at the bottom of the > page. + > +Don't forget to upload checksums for the tarballs and metadata > documentation as well. > > 5. Send release announcement > ---------------------------- > > -Have a look at http://sourceforge.net/p/ltp/mailman/message/34429656/ to > get the idea how it should look. - > The announcement is send to: s/send/sent > > * ltp at lists.linux.it > @@ -64,4 +180,4 @@ CCed to: > > * lwn at lwn.net > * akpm at linux-foundation.org > -* torvalds at linux-foundation.org. > \ No newline at end of file > +* torvalds at linux-foundation.org. -- Regards, Avinesh -- Mailing list info: https://lists.linux.it/listinfo/ltp