Author: bugman
Date: Mon Sep 8 20:40:59 2014
New Revision: 25705
URL: http://svn.gna.org/viewcvs/relax?rev=25705&view=rev
Log:
Shifted the Release_Checklist document into docs/devel/ to hide it from users.
Added:
trunk/docs/devel/Release_Checklist
- copied unchanged from r25704, trunk/docs/Release_Checklist
Removed:
trunk/docs/Release_Checklist
Removed: trunk/docs/Release_Checklist
URL:
http://svn.gna.org/viewcvs/relax/trunk/docs/Release_Checklist?rev=25704&view=auto
==============================================================================
--- trunk/docs/Release_Checklist (original)
+++ trunk/docs/Release_Checklist (removed)
@@ -1,238 +0,0 @@
-Testing
-=======
-
-Compile the C modules for the major line (trunk) by typing:
-
-$ scons
-
-and then run the test suite on all possible architectures to make sure the
release is ready:
-
-$ relax --test-suite
-
-
-
-Tagging
-=======
-
-Make a copy of the current head to the tags directory using a command such
as:
-
-$ svn cp -F svn_msg svn+ssh://bugman@xxxxxxxxxxx/svn/relax/trunk
svn+ssh://bugman@xxxxxxxxxxx/svn/relax/tags/2.0.1
-
-In the commit message file 'svn_msg', have a header line which says 'relax
version 2.0.1.', followed by a short description of the release. Checkout
the tagged version with:
-
-$ svn co svn+ssh://bugman@xxxxxxxxxxx/svn/relax/tags/2.0.1
-
-
-
-Version number
-==============
-
-Change the version number in file 'version.py' and commit the change.
-
-
-
-PDF manual
-==========
-
-Build the PDF version of the relax user manual, add it to the repository,
commit all changes, and clean up the temporary files by typing:
-
-$ scons user_manual_pdf
-$ svn add docs/relax.pdf
-$ svn ci
-$ scons clean
-
-Copy the PDF manual to the mirror directory for the relax download site for
uploading in one of the steps below.
-
-
-
-CHANGES file
-============
-
-Review the SVN logs and add an entry into the CHANGES file (in the 'docs/'
directory) for the current release. Create three sections titled 'Features',
'Changes', and 'Bugfixes'. The 'devel_scripts/log_converter.py' script can
be used to generate the documentation, which will need major editing (the
starting revision is from the CHANGES merge of the previous release):
-
-$ svn log -v -r18314:HEAD > log
-$ ./devel_scripts/log_converter.py log > log_formatted
-
-The result should be modified and every line checked. Bugs should be in the
'Bugfixes' section only if it affects previous relax releases, otherwise it
should be in the 'Changes' section. The following should be removed: minor,
insignificant, and unidentifiable changes such as "Import fix." (this is
highly subjective); all exclamation marks; message IDs for mailing list
posts; svnmerge commits; the messages of all reverted commits; all revision
numbers such as 'r19899' or the word 'revision'; the names and email
addresses of committers or patch providers; and all email addresses.
Spelling should be checked and proper punctuation used throughout, including
two spaces after a period. Missing spaces after punctuation due to the
log_converter.py script need to be corrected. Commit the changes. Port the
revision back into the main line.
-
-
-
-Distribution files
-==================
-
-Package bundling
-----------------
-
-Bundle minfx and bmrblib by checking out the latest stable release tags, for
example:
-
-$ svn co svn+ssh://bugman@xxxxxxxxxxx/svn/minfx/tags/1.0.10/minfx
-$ svn co svn+ssh://bugman@xxxxxxxxxxx/svn/bmrblib/tags/1.0.3/bmrblib
-
-
-Source files
-------------
-
-Generate the source distribution files (and their GPG signatures) by typing:
-
-$ scons source_dist key=xxxxx
-
-where xxxxx is the name of your GPG key.
-
-
-Binary files
-------------
-
-Generate the binary distribution files for each platform (and their GPG
signatures) by typing:
-
-$ scons binary_dist key=xxxxx
-
-
-Signing
--------
-
-If the key is not supplied, or incorrectly supplied, the distribution file
will be created but not signed. To sign the file later, type:
-
-$ gpg --detach-sign --default-key xxxxx relax-2.0.1.GNU-Linux.x86_64.tar.bz2
-
-
-Other files
------------
-
-Build other distribution packages by checking out the tag and bundling minfx
and bmrblib:
-
-$ svn co svn+ssh://bugman@xxxxxxxxxxx/svn/relax/tags/2.0.1
-$ cd 2.0.1
-$ svn co svn+ssh://bugman@xxxxxxxxxxx/svn/minfx/tags/1.0.10/minfx
-$ svn co svn+ssh://bugman@xxxxxxxxxxx/svn/bmrblib/tags/1.0.3/bmrblib
-$ scons binary_dist key=xxxxx
-
-Or:
-
-$ svn co http://svn.gna.org/svn/relax/tags/2.0.1
-$ cd 2.0.1
-$ svn co http://svn.gna.org/svn/minfx/tags/1.0.10/minfx
-$ svn co http://svn.gna.org/svn/bmrblib/tags/1.0.3/bmrblib
-$ scons binary_dist
-
-
-
-Upload
-======
-
-Move the distribution files and their signatures to the mirror directory for
the relax download site. This directory should contain all the files and
directories accessible from 'http://download.gna.org/relax/'. First make
sure the mirror directory contains all of the files so that the next command
does not accidentally delete files:
-
-$ rsync -av --progress --no-perms --rsh="ssh"
bugman@xxxxxxxxxxxxxxxx:/upload/relax/ .
-
-Then rsync the entire directory contents to download.gna.org/upload/relax/
using the command:
-
-$ rsync --delete -av --progress --no-perms --partial --rsh="ssh" .
bugman@xxxxxxxxxxxxxxxx:/upload/relax/
-
-The upload script simplifies the upload process:
-
-$ ./upload
-
-
-
-Website
-=======
-
-Downloads
----------
-
-Modify the http://www.nmr-relax.com/download.html webpage to point to the
newest version of relax. Update the MD5 checksums and file sizes on the
download page. Commit the updates.
-
-
-Manual
-------
-
-Create the HTML version of the manual with the command:
-
-$ scons user_manual_html
-
-Replace the old manual with the new in the http://www.nmr-relax.com/manual
SVN repository (http://svn.gna.org/viewcvs/relax/website) and commit the new
manual.
-
-
-API documentation
------------------
-
-Create the API documentation for the current version with the command:
-
-$ scons api_manual_html
-
-Replace the old API documentation in the http://www.nmr-relax.com/api SVN
repository (http://svn.gna.org/viewcvs/relax/website), update the
api/index.html file and commit the new files. If a new minor version is
being released, create a new directory such as api/3.1/, copy the files
there, and then edit the api/index.html file to add the new version.
-
-
-
-Gna!
-====
-
-Add the version number to the bug tracker field 'Release' at
https://gna.org/bugs/admin/field_values.php?group=relax.
-
-
-
-FSF directory
-=============
-
-Update the version number in the FSF directory
(http://directory.fsf.org/wiki/Relax).
-
-
-
-Announcement
-============
-
-Compose and edit the message on the relax wiki, then post the release
message to the relax-announce mailing list and as a news item on the relax
Gna! website.
-
-
-Wiki
-----
-
-Create a new release page at the URL http://wiki.nmr-relax.com/Relax_x.y.z.
Use, for example, http://wiki.nmr-relax.com/Relax_3.3.0 as a guide. The
basic page structure is as follows:
-
- {{lowercase title}} - Start with this to allow the title to be in
lowercase. The URL on a wiki always starts with a capital, but the title can
be changed to lowercase in this way.
- = Description = - Create this section by writing a detailed and full
description of the release. Add internal wiki links and external links, for
example to the relax manual web pages for the user functions.
- = Download = - Create this section with links for downloading the
release (simply copy the text from an older release).
- = CHANGES file = - Create this section by cutting and pasting the part
of the CHANGES file for this release. Convert the Features, Changes, and
Bugfixes titles to the subsection format == Features ==, == Changes ==, and
== Bugfixes ==. Strip all leading whitespace from the full list of changes
so that the wiki can format the text.
- = See also = - Finally create this section which simply contains the
text [[Category:Release_Notes]].
-
-
-Mailing list
-------------
-
-On the relax-announce mailing list (relax-announce att gna.org), write the
release announcement by:
-
- - Copy the 'Description' and 'Download' text from the wiki. Do not
include the section titles and remove any wiki markup.
- - At the end, add a section titled 'The full list of changes is:' and
cut and paste the part of the CHANGES file for this release. Do not use the
wiki text for this.
- - Include links to the trackers in the full list of changes, if not
already present.
-
-
-Gna! news item
---------------
-
-The steps are:
-
- - Log into Gna! and go to https://gna.org/news/submit.php?group=relax.
- - Cut and paste all of the wiki text. Delete the initial lower case
title formatting text, the final 'See also' section, and any wiki markup.
- - Use the Savane markup to format the text (recipe #236,
https://gna.org/cookbook/?func=detailitem&item_id=236).
- - As the Savane markup for sectioning is the same as the wiki, the
section titles = Description =, = Download =, and = Full list of changes = do
not need to be modified (except changing the text 'CHANGES file' to 'Full
list of changes'). The same for the subtitles == Features ==, == Changes ==,
and == Bugfixes ==. The leading whitespace from the full list of changes
must be stripped, but this should already be done in the wiki text.
- - Item references such as bug #7641, task #3122, etc. are automatically
converted into links, therefore remove all links to the trackers.
- - The Gna! news items are often truncated, so start a new thread for the
rest of the message, responding to that thread for each block of release
notes via the [ Reply ] link at the bottom of the page.
-
-
-Cross-linking
--------------
-
-For better indexing by search engines, cross-link all the release
announcements. It may take a few days for all the links to be created. For
example for relax 3.1.7:
-
- Official release notes: http://wiki.nmr-relax.com/Relax_3.1.7
- Gna! news item: https://gna.org/forum/forum.php?forum_id=2448
- Gmane: http://article.gmane.org/gmane.science.nmr.relax.announce/53
- Mail Archive:
http://www.mail-archive.com/relax-announce%40gna.org/msg00047.html
- Local archives:
https://mail.gna.org/public/relax-announce/2014-03/msg00001.html
- MARC: http://marc.info/?l=relax-announce&m=139509874209089&w=2
-
- Softpedia also has information about the newest relax releases:
- Softpedia for GNU/Linux:
http://linux.softpedia.com/get/Science/relax-22351.shtml and
http://linux.softpedia.com/progDownload/relax-Download-22351.html
- Softpedia for MS Windows:
http://www.softpedia.com/get/Science-CAD/relax-project.shtml and
http://www.softpedia.com/progDownload/relax-Download-210902.html
- Softpedia for Mac OS X:
http://mac.softpedia.com/get/Math-Scientific/Edward-relax.shtml and
http://mac.softpedia.com/progDownload/relax-Download-124418.html
-
-Not all of these links may work, and
r25705 - in /trunk/docs: Release_Checklist devel/Release_Checklist