[LTP] [PATCH 5/5] doc: Update release procedure

[Petr Vorel]

Hi Li,

> Hi Petr,

...
> > -1. Tag the git
> > +1. Release eve work
> > +-------------------
> > +
> > +a. Collecting the (must have) patch list for new release
> > +b. Reviewing and merging the patch list of (a.)
> > +c. Widely testing, explicitly post results
> > +d. Tiny fix according to release testing
> > +e. Writing release note
> > +
> > +2. Tag the git
> >  --------------

> > +Use './tools/tag-release.sh' script, which creates the tag and push it to
> > github.
> >  [source,sh]
> >  --------------------------------------------------------------------
> > -cd ltp
> > -echo YYYYMMDD > VERSION
> > -git commit -s -m 'LTP YYYYMMDD' VERSION
> > -git tag -a YYYYMMDD -m 'LTP YYYYMMDD'
> > ---------------------------------------------------------------------

> What about adding those manual steps into tag-release.sh as code comments?
> That'd be helpful to people who never do release work to try that first
> time.

Good point, makes sense.
I suppose you mean to bput them at the top like this:

#!/bin/sh
# Copyright (c) 2023 Petr Vorel <pvorel@suse.cz>
# Create tarballs and metadata for uploading after tagging release.
# https://github.com/linux-test-project/ltp/wiki/LTP-Release-Procedure 
# echo YYYYMMDD > VERSION
# git commit -s -m 'LTP YYYYMMDD' VERSION
# git tag -a YYYYMMDD -m 'LTP YYYYMMDD'
set -e
...
Because there are comments at the top of each "section" (e.g. # git clone
(local))

...
> > -cd ..
> > -git clone ltp ltp-full-YYYYMMDD
> > -cd ltp-full-YYYYMMDD
> > -# Update mce-inject submodule
> > -git submodule init
> > -git submodule update
> > -# Generate configure script
> > -make autotools
> > -# Prepare the archives
> > -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

> I suggest adding these into create-tarballs-metadata.sh comments as well.

# git clone ltp ltp-full-YYYYMMDD && cd -
# git submodule update --init
# make autotools
# 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
# sha256sum ltp-full-YYYYMMDD.tar.xz > ltp-full-YYYYMMDD.tar.xz.sha256

(Adding all checksums would look to me quite verbose (6 lines), but I can add
them.)

Kind regards,
Petr