Appendix E. How to package and release OpenACS

Table of Contents

How to Update the OpenACS.org repository
  1. update the version number in packages/acs-core-docs/www/xml/variables.ent, readme.txt, and all core .info files. Regenerate the html documentation and commit all the changes. Update the information in the packages/acs-core-docs/www/xml/for-everyone/release-notes.xml file.

  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, the cvs user on openacs.org is implied from the ssh login information previously set up. It could be overridden via foobar@openacs.org.

    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
    

    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

    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 :pserver:anonymous@openacs.org:/cvsroot export -r openacs-5-0-0a1 acs-core
        mv openacs-4 openacs
      2. Generate the tarball

        cd /var/tmp/tarball
        mv openacs 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 :pserver:anonymous@openacs.org:/cvsroot export \
          -r openacs-5-0-0a1 acs-core
        cd /var/tmp/dotlrn-tarball/openacs-4/packages
        cvs -d :pserver:anonymous@openacs.org:/cvsroot export \
          -r openacs-5-0-0a1 dotlrn-prereq
        cvs -d :pserver:anonymous@dotlrn.openacs.org:/dotlrn-cvsroot export \
          -r dotlrn-2-0-0a1 dotlrn-core
        cd /var/tmp/dotlrn-tarball
        mv openacs-4 openacs
        
      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/packages/dotlrn/install.xml /var/tmp/dotlrn-tarball/openacs
        
      3. Generate the tarball

        cd /var/tmp/tarball
        mv openacs dotlrn-2.0.0a1
        tar cz -f dotlrn-2.0.0a1.tar.gz dotlrn-2.0.0a1
        
  5. Test the new tarball

  6. Update on the site

View comments on this page at openacs.org