Releasing OpenACS

OpenACS Core and .LRN Update Translations Update Version Numbers The version numbers in the documentation and in the packages must be updated. This should only happen after a release candidate is approved. .LRN: this must be repeated for .LRN modules (dotlrn-core in the dotlrn cvs tree) and for any modified modules in the .LRN prerequisites (dotlrn-prereq in openacs cvs tree). My current working model is that I bulk-update .LRN and OpenACS core but that I don't touch dotlrn-prereq modules - I just use the most recent release and it's up to individual package developers to tag and release those packages when they change. This model is already broken because following it means that dotlrn-prereqs don't get new translations. Update /var/lib/aolserver/service0/packages/acs-core-docs/www/xml/variables.ent with the new version number. Add new section in /var/lib/aolserver/service0/packages/acs-core-docs/www/xml/for-everyone/release-notes.xml Regenerate all HTML docs cd /var/lib/aolserver/service0/packages/acs-core-docs/www/xml make Update /var/lib/aolserver/service0/readme.txt with the new version number Update version number in all of the core packages. Here's a bash/perl script which works but could be made easier to use. Run it from /var/lib/aolserver/service0/packages: #!/bin/sh # run this file from ../packages to renumber all .info version numbers #--------------------------------------------------------------------- # here's what we're looking for #--------------------------------------------------------------------- # <version name="5.1.0d1" url="http:blahblah/acs-kernel-5.1.0d1.apm"> # <provides url="acs-kernel" version="5.1.0d1"/> #--------------------------------------------------------------------- # here's what we don't want to touch #--------------------------------------------------------------------- # <requires url="acs-kernel" version="5.0.0b4"/> #--------------------------------------------------------------------- for dir in `find -name *.info` do perl -p -i -e 's/name="5\.0\.0"/name="5\.1\.0d1"/' $dir perl -p -i -e 's/-5\.0\.0.apm"/-5\.1\.0d1.apm"/' $dir perl -p -i -e 's/(provides.*version)="5\.0\.0"/\1="5\.1\.0d1"/' $dir done Commit changes to CVS Rubuild the Changelog Rebuild the Changelog. I use a tool called cvs2cl. Run this command from the package root to automatically generate a Changelog file in the same dir: cd /var/lib/aolserver/service0 perl /var/tmp/cvs2cl/cvs2cl.pl -F oacs-5-0 --delta openacs-5-0-0-final:oacs-5-0 Commit changes Tag the files in CVS The steps to this point should have ensured that the head of the current branch contains the full set of code to release. Now we need to tag it as the code to be released. Check out OpenACS Core. The files must be checked out through a cvs account with write access and should be a checkout from the release branch. In this example, we are assuming this is being done as a local user on openacs.org (which make the checkout and tagging operations much faster). cd /var/tmp cvs -d /cvsroot checkout -r oacs-5-0 acs-core If doing .LRN, repeat with the dotlrn cvs tree. cd /var/tmp mkdir dotlrn-packages cd dotlrn-packages cvs -d /dotlrn-cvsroot checkout -r dotlrn-2-0 dotlrn-all Tag the tree. If it's a final release of core, move or create the appropriate openacs-major-minor-compat tag. (Ie, if releasing 5.0.3 final, move the openacs-5-0-compat flag.) cd /var/tmp/openacs-4 cvs tag -F openacs-5-0-0a1 cvs tag -F openacs-5-0-compat Branching When we feature-freeze on HEAD as part of the release process, we are blocking new development. To avoid this, we branch the code at this point, so that new work can continue on HEAD while the branch is stabilized for release. However, branching means that bug fixes have to be synchronized between HEAD and the branch, and bug fixes tend to be more frequent right at this time. Therefore, our actual branch point is as late as possible - essentially, we do not branch until and unless new feature work is actively blocked by the feature freeze. Branching is almost the same as tagging, except for the flag and slightly different tag nomenclature. To see the list of old branches, cvs status -v somefile. cvs tag -b oacs-5-0 If doing .LRN: Since the .LRN packages aren't all in one module, we iterate through all of the modules. Log in first (cvs login) so that you don't have to log in for each module. cd /var/tmp/dotlrn-packages for dir in *; do ( cd $dir && cvs tag dotlrn-2-0-2-final ); done for dir in *; do ( cd $dir && cvs tag -F openacs-5-0-compat ); done Note that for the compat tag we use the -F flag which will force the tag to the new version (just in case someone has created the tag already on another version). Excercise care when doing this since you don't want to inadvertently move a prior release tag. Also if the tagging goes horribly wrong for some reason you can delete the tag via "cvs tag -d <symbolic_tag>". Make the tarball(s) openacs-core Go to a new working space and export the tagged files. mkdir /var/tmp/tarball cd /var/tmp/tarball cvs -d /cvsroot export -r openacs-5-0-0a1 acs-core Generate the tarball. cd /var/tmp/tarball mv openacs-4 openacs-5.0.0a1 tar cz -f openacs-5.0.0a1.tar.gz openacs-5.0.0a1 dotlrn Go to a new working space and export the tagged files. (was getting errors here trying to use -d, so gave up and just moved things from openacs-4 to openacs at the end) mkdir /var/tmp/dotlrn-tarball cd /var/tmp/dotlrn-tarball cvs -d /cvsroot export -r openacs-5-0-0a1 acs-core cd /var/tmp/dotlrn-tarball/openacs-4/packages cvs -d /cvsroot export -r openacs-5-0-0a1 dotlrn-prereq cvs -d /dotlrn-cvsroot export -r dotlrn-2-0-0a1 dotlrn-core Copy the dotlrn install.xml file, which controls which packages are installed on setup, to the root location: cp /var/tmp/dotlrn-tarball/openacs-4/packages/dotlrn/install.xml \ /var/tmp/dotlrn-tarball/openacs-4 Generate the tarball cd /var/tmp/dotlrn-tarball mv openacs-4 dotlrn-2.0.0a1 tar cz -f dotlrn-2.0.0a1.tar.gz dotlrn-2.0.0a1 Test the new tarball(s) Download the tarballs just created and install them and make sure everything looks okay and that automated tests pass. Update Web site Update the different places on OpenACS.org where we track status. Release Status for the current version - something like http://openacs.org/projects/openacs/5.0/milestones Home page of openacs.org Post a new news item Clean Up Clean up after yourself. cd /var/tmp rm -rf tarball dotlrn-tarball dotlrn-packages openacs-5.0.0a1 Here is a shell script that automates packaging the tarball (it's a bit out of date with the new steps - I've been doing everything manually or with little throwaway scripts as detailed above until the process is stabilized). release script missing ($Id: releasing-openacs.xml,v 1.16 2004/03/11 09:16:56 joela Exp $)