#------------------------------------------------------------------------------
# SourceForge
#

This project is stored on SourceForge as http://sf.net/projects/log4sh. The
source code can be accessed using the following information.

* Subversion
$ svn co https://log4sh.svn.sourceforge.net/svnroot/log4sh/trunk log4sh

Subversion may also be browsed via a web browser at
http://svn.sourceforge.net/log4sh

#------------------------------------------------------------------------------
# Making a release
#

For these steps, it is assumed we are working with release 1.3.6.

Steps:
* run the unit tests
* write release notes
* update version
* finish changelog
* check all the code in
* tag the release
* export the release
* create tarball
* md5sum the tarball and sign with gpg
* update website
* post to SourceForge and Freshmeat

RUN THE UNIT TESTS

Run make with the 'test-prep' option to create the test/ directory. Change
there and run the tests. Record the output into the
website/testresults/<version>/ directory so that they can be posted to the
website. Repeate this for each of the supported OSes.

$ make test-prep
...
$ cd test
$ ./run-test-suite 2>&1 |tee .../testresults/1.3.7/Linux-Ubuntu_Edgy-6.10.txt
...

WRITE RELEASE NOTES

Again, pretty self explainatory. Use one of the release notes from a previous
release as an example.

To get the versions of the various shells, do the following:
Cygwin
  bash:  $ bash --version
  ksh:   actually pdksh
  pdksh: look in the downloaded Cygwin directory
Linux
  bash:  $ bash --version
  dash:  look at installed version
  ksh:   $ ksh --version
  pdksh: $ strings /bin/pdksh |grep 'PD KSH'
  zsh:   $ zsh --version
Solaris 10
  sh:    not possible
  bash:  $ bash --version
  ksh:   $ strings /usr/bin/ksh |grep 'Version'

UPDATE VERSION

Edit the log4sh source code, and change the version number in the comment, as
well as in the __LOG4SH_VERSION variable. Next, edit the src/docbook/log4sh.xml
file, edit the version in the <title> element, and make sure there is a
revision section for this release.

FINISH DOCUMENTATION

Make sure that any remaning changes get put into the CHANGES.txt file.

Finish writing the RELEASE_NOTES.txt. Once it is finished, run it through the
'fmt' command to make it pretty.

$ fmt -w 80 RELEASE_NOTES-1.3.6.txt >RELEASE_NOTES-1.3.6.txt.new
$ mv RELEASE_NOTES-1.3.6.txt.new RELEASE_NOTES-1.3.6.txt

We want to have an up-to-date version of the documentation in the release, so
we'd better build it.

$ pwd
.../log4sh/source/1.3
$ make docs
...
$ cp -p build/log4sh.html doc
$ svn ci -m "" doc/log4sh.html

CHECK IN ALL THE CODE

This step is pretty self-explainatory

TAG THE RELEASE

$ pwd
.../log4sh/source
$ ls
1.2  1.3
$ svn cp -m "Release 1.3.6" \
1.3 https://log4sh.svn.sourceforge.net/svnroot/log4sh/tags/source/1.3.6

EXPORT THE RELEASE

$ pwd
.../log4sh/builds
$ svn export \
https://svn.sourceforge.net/svnroot/log4sh/tags/source/1.3.6 log4sh-1.3.6

CREATE TARBALL

$ tar cfz ../releases/log4sh-1.3.6.tgz log4sh-1.3.6

MD5SUM THE TARBALL AND SIGN WITH GPG

$ cd ../releases
$ md5sum log4sh-1.3.6.tgz >log4sh-1.3.6.tgz.md5
$ gpg --default-key kate.ward@forestent.com --detach-sign log4sh-1.3.6.tgz

UPDATE WEBSITE

Again, pretty self-explainatory.

Once that is done, make sure to tag the website so we can go back in time if
needed.

$ pwd
.../log4sh
$ ls
source  website
$ svn cp -m "Release 1.3.7" \
website https://log4sh.svn.sourceforge.net/svnroot/log4sh/tags/website/20060916

Now, copy the website into place

$ rsync -aP --delete --exclude '.svn' website/ sf.net:www/projects/log4sh

POST TO SOURCEFORGE AND FRESHMEAT

http://sourceforge.net/projects/log4sh/
http://freshmeat.net/

#------------------------------------------------------------------------------
# Testing a release
#

To test a release, shUnit unit tests are included. Prepare the test
environment, and then you can run the tests. Hopefully all of the tests will
pass with a 100% success rate.

$ make test-prep
$ cd test
$ ./run-test-suite

To determine what release an OS is running, try the following:

:Mac OS X:     $ /usr/bin/sw_vers |grep ProductVersion |cut -f2
:Linux Ubuntu: $ ( . /etc/lsb-release; echo ${DISTRIB_DESCRIPTION} ${DISTRIB_CODENAME} )

#------------------------------------------------------------------------------
# Related documentation
#

JUnit
  http://www.junit.org
log4j
  http://logging.apache.org
Introduction to the Syslog Protocol
  http://www.monitorware.com/Common/en/Articles/syslog-described.php
The BSD syslog Protocol
  http://www.ietf.org/rfc/rfc3164.txt


$Revision: 564 $