Index: openacs-4/packages/acs-core-docs/www/releasing-openacs-core.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/releasing-openacs-core.adp,v diff -u -r1.2 -r1.3 --- openacs-4/packages/acs-core-docs/www/releasing-openacs-core.adp 7 Aug 2017 23:47:52 -0000 1.2 +++ openacs-4/packages/acs-core-docs/www/releasing-openacs-core.adp 8 Nov 2017 09:42:11 -0000 1.3 @@ -17,19 +17,20 @@ translations”

  • -Rebuild the Changelog. Rebuild the +Rebuild 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. We generate two changelogs, one for the minor branch and one for the most recent release. The example below is for OpenACS -5.0.2:

    cd /var/lib/aolserver/$OPENACS_SERVICE_NAME
-cvs2cl -F oacs-5-0 --delta openacs-5-0-0-final:oacs-5-0 -f ChangeLog
-cvs2cl -F oacs-5-0 --delta openacs-5-0-1-final:oacs-5-0 -f ChangeLog-recent
    +5.0.2:

    cd /var/lib/aolserver/$OPENACS_SERVICE_NAME
+cvs2cl -F oacs-5-0 --delta openacs-5-0-0-final:oacs-5-0 -f ChangeLog
+cvs2cl -F oacs-5-0 --delta openacs-5-0-1-final:oacs-5-0 -f ChangeLog-recent

  • -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 +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 @@ -55,14 +56,14 @@ with the new version number and the release date as arguments. Run it from /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages:

     cd /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages
-       ./acs-core-docs/www/files/update-info 5.2.12006-01-16
+       ./acs-core-docs/www/files/update-info 5.2.12006-01-16

  • Install a new site using the modified code and verify that the automated tests pass.

  • Commit changes to CVS

  • -Tag the files in CVS. The steps to +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.

      @@ -71,19 +72,19 @@ 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
+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
-
      
+cvs -d /dotlrn-cvsroot checkout -r dotlrn-2-0 dotlrn-all
+

    1. 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
-
      +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 @@ -96,88 +97,88 @@ the flag and slightly different tag nomenclature. To see the list of old branches, cvs status -v somefile.

      -cvs tag -b oacs-5-0
+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). Exercise 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 +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). Exercise 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>.

    2. Apply the final tag across the tree. First, check out the entire OpenACS tree, getting the most recent stable version of each package. This is most simply -done on openacs.org:

      cd /var/tmp
-cvs -d /cvsroot checkout -r openacs-5-1-compat openacs-4
+done on openacs.org:
      cd /var/tmp
+cvs -d /cvsroot checkout -r openacs-5-1-compat openacs-4
 cd openacs-4
-cvs tag openacs-5-1-2-final
-
      
+cvs tag openacs-5-1-2-final
+

  • Make the tarball(s). 

    • openacs-core. 

      1. -

        Go to a new working space and export the tagged files.

        mkdir /var/tmp/tarball
+
        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
        
+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
-
        +

        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
+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
+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
-
        
+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 \
+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
-
        +

        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 +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 +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
-rm -rf /var/tmp/openacs-4
    +Clean Up.  Clean up after +yourself.

    cd /var/tmp
+rm -rf tarball dotlrn-tarball dotlrn-packages openacs-5.0.0a1
+rm -rf /var/tmp/openacs-4

    • Here is a shell script that automates packaging the tarball (it's a bit out of date with the new steps - I've been @@ -264,8 +265,8 @@ # Clean up after ourselves... cd $BASE && rm -rf dotlrn-tarball tarball openacs-4 dotlrn-packages -

    ($‌Id: releasing-openacs.xml,v 1.22.2.5 -2017/04/22 17:18:48 gustafn Exp $)
    +

    ($‌Id: releasing-openacs.xml,v 1.23 +2017/08/07 23:47:54 gustafn Exp $)