Menu
▾
▴
[Plplot-cvs] SF.net SVN: plplot:[11379] trunk/README.Release_Manager_Cookbook
|
From: <hba...@us...> - 2010-12-19 23:26:48
|
Revision: 11379
http://plplot.svn.sourceforge.net/plplot/?rev=11379&view=rev
Author: hbabcock
Date: 2010-12-19 23:26:40 +0000 (Sun, 19 Dec 2010)
Log Message:
-----------
Put the various sections of the release manager cookbook into a more logical order.
Modified Paths:
--------------
trunk/README.Release_Manager_Cookbook
Modified: trunk/README.Release_Manager_Cookbook
===================================================================
--- trunk/README.Release_Manager_Cookbook 2010-12-18 19:11:30 UTC (rev 11378)
+++ trunk/README.Release_Manager_Cookbook 2010-12-19 23:26:40 UTC (rev 11379)
@@ -1,184 +1,15 @@
INDEX
-(1) GNU Privacy Guard (gpg).
-(2) Creating a test tarball from trunk.
-(3) Install and test a local copy of the PLplot website.
-(4) Upload the local website to SourceForge.
-(5) Creating a PLplot Release.
+(1) Creating a PLplot Release.
+(2) Install and test a local copy of the PLplot website.
+(3) Upload the local website to SourceForge.
+(A1) GNU Privacy Guard (gpg).
+(A2) Creating a test tarball from trunk.
-(1) GNU Privacy Guard (gpg)
-A brief summary of developer relevant gpg commands, see also:
-http://webber.dewinter.com/gnupg_howto/
-man gpg
+--- Main ---
-create a new key:
-gpg --gen-key
+(1) Creating a PLplot Release:
-list keys so that you can find the ID of the key you created:
-gpg --list-keys
-
-upload your (public) key to GPG key server so that others can obtain it to
-verify your signature on the release tarball.
-gpg --send-keys 6C58D1AC
-(where 6C58D1AC is replaced with the appropriate value from the list-keys
-command)
-
-(2) (Optional) Creating a test tarball from trunk
-
-This step is only required if you have some concerns about how
-recent changes may have affected the generated source tarball, and you want
-to generate that tarball and test it _before_ you create a tag for the
-release. (The release process for the tag below also generates a tarball
-from the tag directory and tests it which is why this trunk version of the
-same is optional.)
-
-cd /tmp
-/path-to-trunk-source/scripts/make_tarball.sh \
--w https://plplot.svn.sourceforge.net/svnroot/plplot
--c -i /tmp/trunk_install -t trunk 2>&1 | tee build.log
-
-The above exports the current trunk
-and uses
-
-/tmp/plplot-dist-prep/build_dir
-
-to build the distribution source tarball
-
-and uses
-
-/tmp/plplot-dist-prep/ctest_build_dir
-
-to configure and build PLplot from the unpacked tarball, ctest the build
-tree, and install the built PLplot in /tmp/trunk_install
-
-Here are the *.out files generated by this process which should be checked.
-
-/tmp/plplot-dist-prep/build_dir/cmake.out
-/tmp/plplot-dist-prep/build_dir/make_prebuild_dist.out
-/tmp/plplot-dist-prep/build_dir/make_package_source.out
-/tmp/plplot-dist-prep/ctest_build_dir/cmake.out
-/tmp/plplot-dist-prep/ctest_build_dir/make.out
-/tmp/plplot-dist-prep/ctest_build_dir/ctest.out
-/tmp/plplot-dist-prep/ctest_build_dir/make_install.out
-
-Here is how the install location should be checked:
-
-cd /tmp/trunk_install/share/plplotX.Y.Z/examples
-make >& make_examples.out
-./plplot-test.sh --help #to see what kinds of tests can be run
-./plplot-test.sh --device=psc
-./plplot-test.sh --device=pscairo
-./plplot-test.sh --device=pngcairo
-./plplot-test.sh --device=png
-
-etc. Check the results with, e.g.,
-
-display x01c.pngcairo.01
-display x08c.pscairo
-
-where "display" is the general image viewer from the imagemagick suite
-of programmes.
-
-(3) Install and test a local copy of the PLplot website.
-
-You should always generate and install from scratch a local copy of the
-PLplot website on some ssh-accessible machine (normally your local machine).
-
-If necessary, update the examples list in
-scripts/htdocs-gen_plot-examples.sh. That list is used to generate the
-website example-related files and copy the results to the website. The list
-automatically controls what example source code is configured (for source
-code that needs that), as well as what example plots and example thumbnails
-are generated. The list also automatically controls what examples-related
-files are copied to the website.
-
-Update the project web page, including the examples: edit
-www/examples.php to reflect the forthcoming release version number and
-any changes to the examples themselves (i.e. pages added or removed
-from an existing example or entirely new examples).
-
-Edit PROJECT_NUMBER in doc/Doxyfile.in to reflect the release
-version number.
-
-The above changes may be committed now or later in the release process
-(see "IMPORTANT: commit all local changes to the repository." below)
-since the script, scripts/generate_website.sh uses the local source
-tree where that script resides (including all local changes) as the
-source tree for generating the website.)
-
-Run (on a Linux host that is capable of building the documentation
-for the source tree that has all local changes)
-
-scripts/generate_website.sh
-
-with no arguments. The script asks you four questions, gives you a chance
-to verify your answers, then does all the rest of it (downloading a
-throwaway copy of the PLplot source code, building the documentation,
-generating the announcements that are part of the base website, uploading
-the base website, uploading the documentation, building the examples,
-running the examples, uploading the example source code and example results)
-automatically. I (AWI) tested this script using the four answers
-
-Summary:
-USERNAME = irwin
-GROUPNAME = irwin
-HOSTNAME = raven
-WEBSITE_PREFIX = /home/irwin/public_html/plplot
-
-(raven is my local computer name, and /home/irwin/public_html is a location
-where I can put various websites). You can check for errors (e.g., due
-to missing commands that need to be installed) by running
-
-find /tmp/plplotdoc -name '*.out' |xargs grep -i error
-
-You should install both apache and PHP on your computer. For Debian Testing
-(a.k.a. squeeze) that is done (as root) by installing libapache2-mod-php5
-and enabling user directories using the command
-
-a2enmod userdir
-
-and editing /etc/apache2/mods-available/php5.conf as indicated in that
-file to allow user directories for php. I am not sure, but I believe
-from some google results I found that editing of that file is also
-necessary on modern versions of Ubuntu in order to allow php-based websites
-like that of PLplot to work when installed in local user directories.
-
-(When user directories are enabled this way, for the above case
-/home/irwin/public_html/plplot/htdocs, browses as
-http://raven/~irwin/plplot/htdocs/.)
-
-I test http://raven/~irwin/plplot/htdocs/ by clicking on most links, checking
-the documentation looks good, checking the examples look good and the
-source code for each language for examples is accessible, etc.
-
-(4) Upload the local website to SourceForge.
-
-Once you are satisfied with the local website, you should upload it to
-SourceForge with rsync.
-
-For the above WEBSITE_PREFIX, here is what worked for me from my computer
-with the hostname of raven where that WEBSITE_PREFIX directory was
-created.
-
-rsync -av --delete \
-/home/irwin/public_html/plplot/htdocs/ \
-airwin,pl...@we...:htdocs
-
-Adjust for your username and WEBSITE_PREFIX. The ",plplot" part of the
-username makes sure you have the right group permissions and default website
-directory location for PLplot.
-
-N.B. the trailing slash on the source directory is essential and means rsync
-the contents of this directory with the contents of the destination htdocs
-directory. Without the trailing slash you would rsync the the contents of
-the source directory with the contents of the htdocs/htdocs destination
-directory which is not what you want to do.
-
-N.B. the --dry-run option for rsync is a god-send and tells you exactly what
-will happen without actually doing it.
-
-(5) Creating a PLplot Release
-
Update the README.release file.
Update the docbook documentation to reflect any new drivers or new
@@ -344,7 +175,7 @@
b. Update README.release file to reflect significant changes made between
the current release and the last release.
-Update the web page following the instructions in sections (3) and (4)
+Update the web page following the instructions in sections (2) and (3)
Publicity for the release announcement.
@@ -352,4 +183,179 @@
Barbara Irwin: linuxtoday.com, lwn.net, lxer.com
-DONE!!!
+
+(2) Install and test a local copy of the PLplot website:
+
+You should always generate and install from scratch a local copy of the
+PLplot website on some ssh-accessible machine (normally your local machine).
+
+If necessary, update the examples list in
+scripts/htdocs-gen_plot-examples.sh. That list is used to generate the
+website example-related files and copy the results to the website. The list
+automatically controls what example source code is configured (for source
+code that needs that), as well as what example plots and example thumbnails
+are generated. The list also automatically controls what examples-related
+files are copied to the website.
+
+Update the project web page, including the examples: edit
+www/examples.php to reflect the forthcoming release version number and
+any changes to the examples themselves (i.e. pages added or removed
+from an existing example or entirely new examples).
+
+Edit PROJECT_NUMBER in doc/Doxyfile.in to reflect the release
+version number.
+
+The above changes may be committed now or later in the release process
+(see "IMPORTANT: commit all local changes to the repository." below)
+since the script, scripts/generate_website.sh uses the local source
+tree where that script resides (including all local changes) as the
+source tree for generating the website.)
+
+Run (on a Linux host that is capable of building the documentation
+for the source tree that has all local changes)
+
+scripts/generate_website.sh
+
+with no arguments. The script asks you four questions, gives you a chance
+to verify your answers, then does all the rest of it (downloading a
+throwaway copy of the PLplot source code, building the documentation,
+generating the announcements that are part of the base website, uploading
+the base website, uploading the documentation, building the examples,
+running the examples, uploading the example source code and example results)
+automatically. I (AWI) tested this script using the four answers
+
+Summary:
+USERNAME = irwin
+GROUPNAME = irwin
+HOSTNAME = raven
+WEBSITE_PREFIX = /home/irwin/public_html/plplot
+
+(raven is my local computer name, and /home/irwin/public_html is a location
+where I can put various websites). You can check for errors (e.g., due
+to missing commands that need to be installed) by running
+
+find /tmp/plplotdoc -name '*.out' |xargs grep -i error
+
+You should install both apache and PHP on your computer. For Debian Testing
+(a.k.a. squeeze) that is done (as root) by installing libapache2-mod-php5
+and enabling user directories using the command
+
+a2enmod userdir
+
+and editing /etc/apache2/mods-available/php5.conf as indicated in that
+file to allow user directories for php. I am not sure, but I believe
+from some google results I found that editing of that file is also
+necessary on modern versions of Ubuntu in order to allow php-based websites
+like that of PLplot to work when installed in local user directories.
+
+(When user directories are enabled this way, for the above case
+/home/irwin/public_html/plplot/htdocs, browses as
+http://raven/~irwin/plplot/htdocs/.)
+
+I test http://raven/~irwin/plplot/htdocs/ by clicking on most links, checking
+the documentation looks good, checking the examples look good and the
+source code for each language for examples is accessible, etc.
+
+
+(3) Upload the local website to SourceForge:
+
+Once you are satisfied with the local website, you should upload it to
+SourceForge with rsync.
+
+For the above WEBSITE_PREFIX, here is what worked for me from my computer
+with the hostname of raven where that WEBSITE_PREFIX directory was
+created.
+
+rsync -av --delete \
+/home/irwin/public_html/plplot/htdocs/ \
+airwin,pl...@we...:htdocs
+
+Adjust for your username and WEBSITE_PREFIX. The ",plplot" part of the
+username makes sure you have the right group permissions and default website
+directory location for PLplot.
+
+N.B. the trailing slash on the source directory is essential and means rsync
+the contents of this directory with the contents of the destination htdocs
+directory. Without the trailing slash you would rsync the the contents of
+the source directory with the contents of the htdocs/htdocs destination
+directory which is not what you want to do.
+
+N.B. the --dry-run option for rsync is a god-send and tells you exactly what
+will happen without actually doing it.
+
+
+--- Appendix ---
+
+(A1) GNU Privacy Guard (gpg)
+A brief summary of developer relevant gpg commands, see also:
+http://webber.dewinter.com/gnupg_howto/
+man gpg
+
+create a new key:
+gpg --gen-key
+
+list keys so that you can find the ID of the key you created:
+gpg --list-keys
+
+upload your (public) key to GPG key server so that others can obtain it to
+verify your signature on the release tarball.
+gpg --send-keys 6C58D1AC
+(where 6C58D1AC is replaced with the appropriate value from the list-keys
+command)
+
+
+(A2) (Optional) Creating a test tarball from trunk
+
+This step is only required if you have some concerns about how
+recent changes may have affected the generated source tarball, and you want
+to generate that tarball and test it _before_ you create a tag for the
+release. (The release process for the tag below also generates a tarball
+from the tag directory and tests it which is why this trunk version of the
+same is optional.)
+
+cd /tmp
+/path-to-trunk-source/scripts/make_tarball.sh \
+-w https://plplot.svn.sourceforge.net/svnroot/plplot
+-c -i /tmp/trunk_install -t trunk 2>&1 | tee build.log
+
+The above exports the current trunk
+and uses
+
+/tmp/plplot-dist-prep/build_dir
+
+to build the distribution source tarball
+
+and uses
+
+/tmp/plplot-dist-prep/ctest_build_dir
+
+to configure and build PLplot from the unpacked tarball, ctest the build
+tree, and install the built PLplot in /tmp/trunk_install
+
+Here are the *.out files generated by this process which should be checked.
+
+/tmp/plplot-dist-prep/build_dir/cmake.out
+/tmp/plplot-dist-prep/build_dir/make_prebuild_dist.out
+/tmp/plplot-dist-prep/build_dir/make_package_source.out
+/tmp/plplot-dist-prep/ctest_build_dir/cmake.out
+/tmp/plplot-dist-prep/ctest_build_dir/make.out
+/tmp/plplot-dist-prep/ctest_build_dir/ctest.out
+/tmp/plplot-dist-prep/ctest_build_dir/make_install.out
+
+Here is how the install location should be checked:
+
+cd /tmp/trunk_install/share/plplotX.Y.Z/examples
+make >& make_examples.out
+./plplot-test.sh --help #to see what kinds of tests can be run
+./plplot-test.sh --device=psc
+./plplot-test.sh --device=pscairo
+./plplot-test.sh --device=pngcairo
+./plplot-test.sh --device=png
+
+etc. Check the results with, e.g.,
+
+display x01c.pngcairo.01
+display x08c.pscairo
+
+where "display" is the general image viewer from the imagemagick suite
+of programmes.
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
