Appendix E. How to package and release OpenACS

  1. Update documentation version numbers:

    1. Update /packages/acs-core-docs/www/xml/variables.ent with the new version number and regenerate all HTML docs

    2. Update /readme.txt with the new version number

    3. Commit changes

  2. Check out the whole cvs tree. 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 openacs-4

    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
    
  3. Tag the tree.

    cd /var/tmp/openacs-4
    cvs tag -F openacs-5-0-0a1
    

    Note that 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>".

    Tag dotLRN. Since the dotLRN 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 -F dotlrn-2-0-0a1 ); done
    
  4. Make the tarball

    • openacs-core. 

      1. 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
        
      2. 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. 

      1. 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
        
      2. 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
        
      3. 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
        
  5. Test the new tarball

  6. Update openacs.org frontpage, bug-tracker versions, project page, etc.

  7. 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 this whole process...

release script missing
($Id: releasing-openacs.html,v 1.6.2.4 2003/12/16 13:58:42 joela Exp $)
View comments on this page at openacs.org