How to package and release an OpenACS Package

+cvs�commit:�Rebuilding�administrative�file�database

Although you should add your package on HEAD, you should do package development on the latest release branch that your code is compatible with. So, after completing the import, you may want to branch your package:

cd /var/lib/aolserver/service0/packages/newpackage
+cvs tag -b oacs-5-1

See the section called “How to package and release an OpenACS Package”

Note

Some packages are already in cvs at openacs-4/contrib/packages. Starting with OpenACS 5.1, we have a Maturity mechanism in the APM which makes the contrib directory un-necessary. If you are working on a contrib package, you should move it to /packages. This must be done by an OpenACS administrator. On cvs.openacs.org:

cp -r /cvsroot/openacs-4/contrib/packages/package0 /cvsroot/openacs-4/packages

Update the modules file as described above.
Remove the directory from cvs in the old location using cvs rm. One approach for file in `find | grep -v CVS`; do rm $file; cvs remove $file; done

Rules for Committing Code to the OpenACS repository

CVS commit procedures are governed by @@ -134,7 +135,7 @@ flag which defaults to no-effect wouldn't require a TIP. Added a new mandatory flag to an existing function would require a TIP. -

+

Reasons

We don't currently have clear standards for committing @@ -170,7 +171,7 @@ applies to all packages. This tag can be used to fork packages as needed, and provides a common ancestor between the fork and the OpenACS code so that patches can be generated. -

+

Informal Guidelines

Informal guidelines which may be obsolete in places and should be reviewed: Index: openacs-4/packages/acs-core-docs/www/releasing-package.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/releasing-package.html,v diff -u -r1.2.2.3 -r1.2.2.4 --- openacs-4/packages/acs-core-docs/www/releasing-package.html 8 Nov 2004 19:59:34 -0000 1.2.2.3 +++ openacs-4/packages/acs-core-docs/www/releasing-package.html 30 Nov 2004 21:43:29 -0000 1.2.2.4 @@ -1,4 +1,4 @@ -How to package and release an OpenACS Package

Prev	Chapter�17.�Releasing OpenACS	Next

How to package and release an OpenACS Package

In this example, we are packaging and releasing myfirstpackage as version 1.0.0, which is compatible with OpenACS 5.0.x.

Update the version number of your package in the APM.
Make sure all changes are committed.

Tag the updated work.:

cd /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/myfirstpackage
+How to package and release an OpenACS PackagePrev Chapter�17.�Releasing OpenACS  Next
How to package and release an OpenACS Package
In this example, we are packaging and releasing myfirstpackage as version 1.0.0, which is compatible with OpenACS 5.0.x.
Update the version number, release date, and package maturity of your package in the APM.
Make sure all changes are committed.
Tag the updated work.:
cd /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/myfirstpackage
 cvs tag myfirstpackages-1-0-0-final
 cvs tag -F openacs-5-0-compat
 
Done.  The package will be added to the repository automatically.  If the correct version does not show up within 24 hours, ask for help on the OpenACS.org development forum.
Prev Home  Next
How to Update the OpenACS.org repository Up  How to Update the translations
docs@openacs.org
View comments on this page at openacs.org
Index: openacs-4/packages/acs-core-docs/www/xml/releasing-openacs.xml
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/xml/releasing-openacs.xml,v
diff -u -r1.16.2.6 -r1.16.2.7
--- openacs-4/packages/acs-core-docs/www/xml/releasing-openacs.xml	29 Nov 2004 19:25:24 -0000	1.16.2.6
+++ openacs-4/packages/acs-core-docs/www/xml/releasing-openacs.xml	30 Nov 2004 21:43:31 -0000	1.16.2.7
@@ -308,7 +308,7 @@
     In this example, we are packaging and releasing myfirstpackage as version 1.0.0, which is compatible with OpenACS 5.0.x.
     
       
-        Update the version number of your package in the APM.
+        Update the version number, release date, and package maturity of your package in the APM.
       
       
         Make sure all changes are committed.
Index: openacs-4/packages/acs-core-docs/www/xml/engineering-standards/cvs.xml
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/xml/engineering-standards/cvs.xml,v
diff -u -r1.1.2.5 -r1.1.2.6
--- openacs-4/packages/acs-core-docs/www/xml/engineering-standards/cvs.xml	30 Nov 2004 20:58:38 -0000	1.1.2.5
+++ openacs-4/packages/acs-core-docs/www/xml/engineering-standards/cvs.xml	30 Nov 2004 21:43:31 -0000	1.1.2.6
@@ -351,6 +351,11 @@
 cvs commit: Rebuilding administrative file database
             
           
+            Although you should add your package on HEAD, you should do package development on the latest release branch that your code is compatible with.  So, after completing the import, you may want to branch your package:
+            cd /var/lib/aolserver/service0/packages/newpackage
+cvs tag -b oacs-5-1
+          
+          
             See 
           
           
@@ -364,7 +369,7 @@
               Update the modules file as described above.
             
             
-              Remove the directory from cvs in the old location using cvs remove.
+              Remove the directory from cvs in the old location using cvs rm.  One approach for file in `find | grep -v CVS`; do rm $file; cvs remove $file; done

Prev	Home	Next
How to Update the OpenACS.org repository	Up	How to Update the translations