Index: openacs-4/packages/acs-core-docs/www/releasing-openacs.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/releasing-openacs.html,v diff -u -r1.14 -r1.15 --- openacs-4/packages/acs-core-docs/www/releasing-openacs.html 24 Feb 2004 17:42:25 -0000 1.14 +++ openacs-4/packages/acs-core-docs/www/releasing-openacs.html 27 Feb 2004 11:20:52 -0000 1.15 @@ -1,17 +1,39 @@ -Chapter�16.�How to package and release OpenACS

Chapter�16.�How to package and release OpenACS

Table of Contents

How to Update the OpenACS.org repository
How to Update the translations
  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. +Chapter�16.�How to package and release OpenACS

      Chapter�16.�How to package and release OpenACS

      1. Update version numbers:

        1. Update /packages/acs-core-docs/www/xml/variables.ent with the new version number. +

        2. Add new section in /packages/acs-core-docs/www/xml/for-everyone/release-notes.xml +

        3. Regenerate all HTML docs

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

        5. 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 the tarball root:

          #!/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
        6. 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/log/aolserver/service0
          +perl /var/tmp/cvs2cl/cvs2cl.pl -F oacs-5-0 --delta openacs-5-0-0-final:oacs-5-0
        7. Commit changes -

      2. Check out the whole cvs tree. The files must be checked +

    4. 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 openacs-4

      Repeat with the dotlrn cvs tree.

      cd /var/tmp
      +cvs -d /cvsroot checkout -r oacs-5-0 acs-core

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

      cd /var/tmp/openacs-4
      +
    6. 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

      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 @@ -22,8 +44,7 @@ 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>".

    7. 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
          +cvs -d /cvsroot export -r openacs-5-0-0a1 acs-core
        3. 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