[gnuastro-commits] master ae2f274: Minor corrections in release checklist and book

[Mohammad Akhlaghi]

branch: master
commit ae2f274aad4a4d2824f18204287b68b1d4aaa94b
Author: Mohammad Akhlaghi <address@hidden>
Commit: Mohammad Akhlaghi <address@hidden>

    Minor corrections in release checklist and book
    
    In preparation for an alpha release, I went over the checklist and made
    some small corrections while also applying them. In the acknowledgements
    section of the book, I also updated the list of people and moved the
    institutions that hosted the authors into a separate paragraph.
---
 doc/gnuastro.texi         | 24 ++++++++--------
 doc/release-checklist.txt | 72 ++++++++++++++++++++++++++++++++++++-----------
 2 files changed, 69 insertions(+), 27 deletions(-)

diff --git a/doc/gnuastro.texi b/doc/gnuastro.texi
index 414af0a..0a7e776 100644
--- a/doc/gnuastro.texi
+++ b/doc/gnuastro.texi
@@ -1543,17 +1543,19 @@ management of its version controlled source server 
there.
 
 @c To the developers: please keep this in the same order as the THANKS file
 @c (alphabetical, except for the names in the paragraph above).
-We would also like to gratefully thank (in alphabetical order) Roland
-Bacon, Nicolas Bouché, Adrian Bunk, Rosa Calvi, Antonio Diaz Diaz, Raúl
-Infante Sainz, Lee Kelvin, Mohammad-Reza Khellat, Alan Lefor, Guillaume
-Mahler, Francesco Montanari, William Pence, Yahya Sefidbakht, Ole
-Streicher, Ignacio Trujillo, David Valls-Gabaud and Christopher Willmer for
-their useful and constructive comments and suggestions. Finally we should
-thank all the (sometimes anonymous) people in various online forums which
-patiently answered all our small (but important) technical questions. All
-work on Gnuastro has been voluntary, but we are most grateful to the
-following institutions (in chronological order) for hosting us in our
-research:
+We would also like to gratefully thank (in alphabetical order by family
+name) Marjan Akbari, Roland Bacon, Nicolas Bouch@'e, Adrian Bunk, Rosa
+Calvi, Antonio Diaz Diaz, Raúl Infante Sainz, Lee Kelvin, Mohammad-Reza
+Khellat, Alan Lefor, Guillaume Mahler, Francesco Montanari, William Pence,
+Yahya Sefidbakht, Ole Streicher, Ignacio Trujillo, David Valls-Gabaud and
+Christopher Willmer for their useful and constructive comments and
+suggestions. Finally we should thank all the (sometimes anonymous) people
+in various online forums which patiently answered all our small (but
+important) technical questions.
+
+All work on Gnuastro has been voluntary, but the authors are most grateful
+to the following institutions (in chronological order) for hosting us in
+our research:
 
 @quotation
 Ministry of education, culture, sports, science and technology (MEXT), 
address@hidden
diff --git a/doc/release-checklist.txt b/doc/release-checklist.txt
index 365622e..d35aafc 100644
--- a/doc/release-checklist.txt
+++ b/doc/release-checklist.txt
@@ -6,12 +6,14 @@ set of operations to do for making each release. This should 
be done after
 all the commits needed for this release have been completed.
 
 
- - Only in an alpha release (In the next main release they will remain
-   unchanged): update the library version (the values starting with `GAL_'
-   in `configure.ac'). See the `Updating library version information'
-   section of the GNU Libtool manual as a guide.
+ - [ALPHA] Only in the first alpha release after a main release: update the
+   library version (the values starting with `GAL_' in `configure.ac'). See
+   the `Updating library version information' section of the GNU Libtool
+   manual as a guide.
+
+
+ - [ALPHA] Run a spell-check (in emacs with `M-x ispell') on the whole book.
 
- - Run a spell-check (in emacs with `M-x ispell') on the whole book.
 
  - Update the NEWS file (use `git log --reverse gnuastro_vA.B..HEAD').
 
@@ -25,7 +27,11 @@ all the commits needed for this release have been completed.
    people/institutions.
 
 
- - Update the webpage (`doc/gnuastro-top.html') and correct the links.
+ - Make sure THANKS corresponds to the acknowledgements in the book.
+
+
+ - [STABLE] Update the webpage (`doc/gnuastro-top.html') and correct the
+   links.
 
 
  - Commit all these changes and tag the commit:
@@ -45,13 +51,21 @@ all the commits needed for this release have been completed.
      $ make distcheck -j8
 
 
+ - [ALPHA] For alpha, we will only be distributing lzip tarballs. So first
+   remove the `tar.gz' file that was produced by `make distcheck', then
+   make the `tar.lz' that will be distributed.
+
+     $ rm *.tar.gz
+     $ make dist-lzip
+
+
  - [STABLE]: After the `make distcheck' is safely finished, tag the release:
 
      $ git tag -a gnuastro_vX.X
 
 
- - The tag will cause a change in the tarball version. So clean the build
-   directory, and repeat the steps for the final release:
+ - [STABLE] The tag will cause a change in the tarball version. So clean
+   the build directory, and repeat the steps for the final release:
 
      $ rm -rf ./build/*
      $ autoreconf -f
@@ -60,6 +74,7 @@ all the commits needed for this release have been completed.
      $ make distcheck -j8
      $ make dist-lzip
 
+
  - Upload the tarball with the command below: Note that `gnupload'
    uses `ncftpput' which comes with the `ncftp' package. The replaces
    are necessary for the symbolic links.
@@ -68,7 +83,7 @@ all the commits needed for this release have been completed.
 
        $  /path/to/gnulib/build-aux/gnupload --to alpha.gnu.org:gnuastro   \
                --replace --symlink-regex="s/X.X.XXX-XXXX/alpha-latest/"    \
-               gnuastro-X.X.XXX-XXXX.tar.gz
+               gnuastro-X.X.XXX-XXXX.tar.lz
 
    - For a stable release:
 
@@ -76,21 +91,24 @@ all the commits needed for this release have been completed.
                --replace --symlink-regex                                   \
                gnuastro-X.X.tar.gz gnuastro-X.X.tar.lz
 
+
  - [ALPHA]: Now that you have the release number, update the link on the
    main HTML on the webpage (`gnuastro-top.html').
 
- - Build the manual in all the formats and upload everything. Note that you
-   will need to configure Gnuastro in the main source directory to build
-   the full webpage with this script.
+ - [STABLE] Build the manual in all the formats and upload everything. Note
+   that you will need to configure Gnuastro in the main source directory to
+   build the full webpage with this script.
 
        $ ./configure
        $ cd doc
        $ ./forwebpage /path/to/local/copy/of/webpage
 
+
  - Push all the changes and tag to the main repo:
 
     $ git push --follow-tags
 
+
  - Prepare the announcement, this command will calculate the checksums and
    also make the links ready. You just have to add a starting and ending
    similar to previous announcements in a text editor. In the `XXXX', put
@@ -102,14 +120,18 @@ all the commits needed for this release have been 
completed.
               --url-directory=http://XXXX.gnu.org/gnu/gnuastro             \
               --archive-suffix=tar.lz > announcement.txt
 
+
  - After finishing the announcement (adding an intro and NEWS file), run a
    spell-check on it.
 
- - IMPORTANT: double check the changes in the list of authors and the list
-   in THANKS and make sure everyone's contribution is correctly included.
 
- - Announce the release on address@hidden', address@hidden' and
-   Savannah news.
+ - IMPORTANT: In the announcements, double check the changes in the list of
+   authors and the list in THANKS and make sure everyone's contribution is
+   correctly included.
+
+
+ - Announce the release on address@hidden', address@hidden'
+   (only for STABLE) and Savannah news (only for STABLE).
 
 
 
@@ -131,6 +153,7 @@ Steps necessary to Package Gnuastro for Debian.
 
      $ git clone git://anonscm.debian.org/debian-astro/packages/gnuastro.git
 
+
  - If a Git directory exists, then pull any possible changes that already
    exist:
 
@@ -138,17 +161,20 @@ Steps necessary to Package Gnuastro for Debian.
      $ git pull
      $ cd ..
 
+
  - Clean any existing files (if this process was already done for an
    earlier version):
 
      $ rm -f gnuastro_* gnuastro-*
 
+
  - To keep things clean, define Gnuastro's version as a variable (if this
    isn't a major release, we won't use the last four or five characters
    that are the first commit hash characters):
 
      $ export ver=A.B.CCC
 
+
  - Put a copy of the tarball to be packaged in this directory and make a
    standard symbolic link to it (IMPORTANT: the `dash' is changed to an
    `underscore' and an `orig' is added), then go into the cloned directory.
@@ -156,6 +182,7 @@ Steps necessary to Package Gnuastro for Debian.
      $ ln -s gnuastro-$ver-XXXX.tar.gz gnuastro_$ver.orig.tar.gz
      $ cd gnuastro
 
+
  - You need to checkout to the `upstream' branch, clean everything that was
    in it and unpack this release's raw package source files into it as
    shown below.
@@ -166,6 +193,7 @@ Steps necessary to Package Gnuastro for Debian.
      $ mv ../gnuastro-tmp-git .git         # Bring back the `.git' directory.
      $ tar xf ../gnuastro_$ver.orig.tar.gz --strip-components=1
 
+
  - We now need to commit these into the `upstream' branch of the Git
    history, tag it and run `pristine-tar' on it.
 
@@ -174,11 +202,13 @@ Steps necessary to Package Gnuastro for Debian.
      $ git tag upstream/$ver
      $ pristine-tar commit ../gnuastro_$ver.orig.tar.gz
 
+
  - We are done with the `upstream' and `pristine-tar' branches and can
    checkout `master':
 
      $ git checkout master
 
+
  - Again, we need to clean everything that already exists here, except
    `.git' and `debian':
 
@@ -188,10 +218,12 @@ Steps necessary to Package Gnuastro for Debian.
      $ mv ../gnuastro-tmp-git .git         # Bring back the `.git' directory.
      $ mv ../gnuastro-tmp-debian debian    # Bring back the `debian' directory.
 
+
  - Unpack the distribution tarball into the master branch too:
 
      $ tar xf ../gnuastro_$ver.orig.tar.gz --strip-components=1
 
+
  - Update the ChangeLog. But first get all the changes in this version from
    the NEWS file.
 
@@ -202,11 +234,13 @@ Steps necessary to Package Gnuastro for Debian.
      $ git diff NEWS
      $ emacs debian/changelog
 
+
  - Check the current Debian policy version at
    https://www.debian.org/doc/debian-policy/ and update debian/control:
 
      $ emacs debian/control
 
+
  - If the soname of the shared libraries has changed:
 
      - Rename the file `debain/libgnuastroX.install' (set `X' to the new
@@ -214,19 +248,23 @@ Steps necessary to Package Gnuastro for Debian.
 
      - In `debian control, change all the old sonames to the new value.
 
+
  - Update your version of `pbuilder':
 
      $ sudo pbuilder update
 
+
  - Run `pdebuild' to build the package (needs sudo).
 
      $ sudo pdebuild
 
+
  - Run Lintian to check the build.
 
      $ lintian -E -I --pedantic                                         \
                /var/cache/pbuilder/result/gnuastro_$ver-1_amd64.changes
 
+
  - Commit the contents of the new release, make sure everything except the
    `debian' directory is commited (with `git status'):
 
@@ -234,10 +272,12 @@ Steps necessary to Package Gnuastro for Debian.
      $ git status                         # For a visual check
      $ git commit -m "Gnuastro $ver"
 
+
  - Push all the changes to the repository (you can't call `--all' and
    `--tags' together):
 
      $ git push --all
      $ git push --tags
 
+
  - Inform Debian Astro.