Create a release branch
Current practice dictates that non-indie *.x branch pom versions must remain constant for the life of the branch. *.x branch pom files are versioned major version.minor version-SNAPSHOT (e.g., 2.8-SNAPSHOT). In addition, no snapshot jars are permitted in the Maven2 release repo. Because of these rules, particularly the latter, a release branch must be created prior to a release for each non-indie project in order to reset each pom <version> to a non-snapshot version (e.g., 2.8.1).
Release branches should only be created after all *.x branch blockers have been eliminated. Once the release branch is created the *.x branch is free to accept merged code not intended for the release. However, given the vagaries of CLE quality assurance late breaking release blockers are often discovered after the release branch is created. This creates challenges for the release team and branch managers since blocker fixes must be merged both to the *.x maintenance branch AND the release branch. Great vigilance is required to track the commit stream to ensure that fixes required for the release are not missed.
Indie projects, which leverage the Maven release plugin, are easier to manage. Releases are performed from existing *.x maintenance branches (no release branch is required) and the plugin handles pom version changes, tag creation and binaries generation and deployment automatically.
Non-indie release branches (as well as tags) are created using the following bash script.
TODO: add URL
The script takes six arguments.
$ bash sakaitagbuilder-2.8.bash [Jira ticket number] \ [source branch] \ [take HEAD=true|false] \ [target=branches|tags] \ [sakai version] \ [version suffix=mXX|aXX|bXX|rcXX] $ bash sakaitagbuilder-2.8.bash SAK-20967 sakai-2.8.x true branches 2.8.1
Update pom.xml <version>, master pom.xml <properties>, sakai.properties
1. Update <version>: find/replace 2.*-SNAPSHOT with release version
<version>2.8-SNAPSHOT</version> -> <version>2.8.1</version>
2. Update <sakai.version> (master pom.xml)
<sakai.version>2.8.1</sakai.version>
3. Update Indie version <properties> (master pom.xml)
<sakai.version>2.8.1</sakai.version> <sakai.kernel.version>1.2.5</sakai.kernel.version> . . . <sakai.basiclti.version>1.3.3</sakai.basiclti.version> <sakai.common.version>1.1.3</sakai.common.version> <sakai.contentreview.version>2.8.5</sakai.contentreview.version> <sakai.edu-services.version>1.1.2</sakai.edu-services.version> <sakai.ets.version>0.5.3</sakai.ets.version> <sakai.entitybroker.version>1.4.2</sakai.entitybroker.version> <sakai.hybrid.version>1.1.4</sakai.hybrid.version> <sakai.jsf.version>2.8.2</sakai.jsf.version> <sakai.msgcntr.version>2.8.1</sakai.msgcntr.version> <sakai.polls.version>1.4.2</sakai.polls.version> <sakai.profile.version>2.8.2</sakai.profile.version> <sakai.profile2.version>1.4.2</sakai.profile2.version> <sakai.resetpass.version>2.8.2</sakai.resetpass.version> <sakai.sakai-mock.version>2.8.2</sakai.sakai-mock.version> <sakai.samigo.version>2.8.2</sakai.samigo.version> <sakai.scheduler.version>2.8.1</sakai.scheduler.version> <sakai.search.version>1.3.4</sakai.search.version> <sakai.shortenedurl.version>1.0.2</sakai.shortenedurl.version> <sakai.sitestats.version>2.2.1</sakai.sitestats.version> <sakai.webservices.version>1.0.2</sakai.webservices.version>
4. Review other properties such as Tomcat or Quartz versions and update as necessary.
<sakai.commons.lang.version>2.5</sakai.commons.lang.version> <sakai.commons.fileupload.version>1.2.1</sakai.commons.fileupload.version> <sakai.ehcache.groupId>net.sf.ehcache</sakai.ehcache.groupId> <sakai.ehcache.artifactId>ehcache</sakai.ehcache.artifactId> <sakai.ehcache.version>1.6.1</sakai.ehcache.version> <sakai.hibernate.groupId>org.hibernate</sakai.hibernate.groupId> <sakai.hibernate.artifactId>hibernate</sakai.hibernate.artifactId> <sakai.hibernate.version>3.2.7.ga</sakai.hibernate.version> <sakai.jcr.version>1.0</sakai.jcr.version> <sakai.pluto.version>1.1.7</sakai.pluto.version> <sakai.quartz.version>1.6.6</sakai.quartz.version> <sakai.servletapi.version>2.4</sakai.servletapi.version> <sakai.spring.groupId>org.springframework</sakai.spring.groupId> <sakai.spring.artifactId>spring</sakai.spring.artifactId> <sakai.spring.version>2.5.6.SEC01</sakai.spring.version> <sakai.spring.test.artifactId>spring-test</sakai.spring.test.artifactId> <sakai.spring.test.version>2.5.6.SEC01</sakai.spring.test.version> <sakai.tomcat.version>5.5.33</sakai.tomcat.version> <sakai.xerces.impl.version>2.6.2</sakai.xerces.impl.version> <sakai.xerces.api.version>2.6.2</sakai.xerces.api.version>
5. Update sakai.properties
default.sakai.properties
version.service=RELEASE version.sakai=2.8.1
demo.sakai.properties
version.service=DEMO version.sakai=2.8.1
sample.sakai.properties
version.service=SAMPLE version.sakai=2.8.1
6. Check stealth settings and adjust accordingly for the default and demo sakai.properties
default.sakai.properties
# STEALTH TOOLS # A stealth tool is a tool that is running in Sakai but is not available to be added to a site in Worksite Setup. # For Development/QA purposes stealthTools property will be commented out; release artifacts will have the property uncommented. stealthTools@org.sakaiproject.tool.api.ActiveToolManager=sakai.profile
demo.sakai.properties
# STEALTH TOOLS. A stealth tool is a tool that is running in Sakai, but is not available to be added to a site in Worksite Setup. stealthTools@org.sakaiproject.tool.api.ActiveToolManager=sakai.profile,sakai.search
Review reference/docs/sakai.properties version.service and version.sakai. These files should not have been updated by developers. Check logs for changes.
reference/docs/sakai.properties
version.service=RELEASE version.sakai=2.8.1
Confirm /master/pom.xml Sakai Maven plugin <version> from 1.2.0
<plugin>
<inherited>true</inherited>
<groupId>org.sakaiproject.maven.plugins</groupId>
<artifactId>sakai</artifactId>
<version>1.2.0</version>
. . . .
</plugin>
GENERATE RELEASE ARTIFACTS
Get copy of Maven2 repo
Mount Sakai Maven2 Repo using DAV (https:/source.sakaiproject.org/maven2 -> /Volumes/maven2). WARNING: create backup folder of maven2 so that only one copy operation is required in event of a generation failure. This takes far too long to accomplish. Just tar up maven2/org/sakaiproject and sftp or scp across the network. The challenge here is that you need all the Maven metadata files locally so that they can be properly updated during the release. Start thinking about using rsync.
Local build machine environment
- Check out 2.8.1 branch
- clean Tomcat 5.5.33
- empty .m2/repository/org/sakaiproject
- new MySQL 5.1.x sakai db
- Confirm maven-taglib is defined in .m2/settings.xml
<!-- Reference plugins in order to use <goalPrefix> short-hand -->
<pluginGroups>
<pluginGroup>net.sourceforge.maven-taglib</pluginGroup>
</pluginGroups>
/master/pom.xml
Confirm <distributionManagement>, maven-taglib-plugin, wagon-webdav <build> extensions are in place. Commit changes if necessary.
1. <distributionManagement>
<distributionManagement>
<repository>
<uniqueVersion>false</uniqueVersion>
<id>local</id>
<name>Local Test</name>
<url>file:///tmp/maven2</url>
<layout>default</layout>
</repository>
<site>
<id>local</id>
<name>Local Test</name>
<url>file:///tmp/site</url>
</site>
</distributionManagement>
2. maven-taglib-plugin
<plugin> <groupId>net.sourceforge.maven-taglib</groupId> <artifactId>maven-taglib-plugin</artifactId> <configuration> <goalPrefix>taglib</goalPrefix> <taglib.src.dir>src</taglib.src.dir> <!-- <taglib.src.dir>src/webapp/WEB-INF</taglib.src.dir> --> </configuration> </plugin>
3. wagon-webdav <build> extension
<!-- Required for Dav -->
<extensions>
<extension>
<groupId>org.apache.maven.wagon</groupId>
<artifactId>wagon-webdav</artifactId>
<version>1.0-beta-2</version>
</extension>
</extensions>
/reference/conversion
Review sql conversion scripts, update and commit as necessary.
base pom.xml
1. Confirm javadoc plugin definition. Should be configured as follows:
<plugin>
<!-- javadocs -->
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.6.1</version>
<configuration>
<debug>true</debug>
<links>
<link>http://java.sun.com/j2se/1.5.0/docs/api/
</link>
</links>
<breakiterator>true</breakiterator>
<verbose>false</verbose>
<aggregate>true</aggregate>
<maxmemory>512m</maxmemory>
<additionalJOption>-J-Xms168m -J-Xmx512m -J-XX:PermSize=128m -J-XX:NewSize=64m</additionalJOption>
</configuration>
</plugin>
2. Confirm that taglib profile is included.
<profile>
<id>taglib</id>
<modules>
<module>gradebook/app/ui</module>
<module>help/help-tool</module>
<!-- <module>jsf/jsf-widgets</module> -->
<module>metaobj/metaobj-util/tool-lib</module>
<!-- <module>msgcntr/messageforums-app</module> -->
<module>osp/common/tool-lib</module>
<module>osp/glossary/tool-lib</module>
<module>osp/jsf/widgets</module>
<module>osp/presentation/tool-lib</module>
<module>podcasts/podcasts-app</module>
<module>postem/postem-app</module>
<!-- <module>profile/profile-app</module> -->
<module>roster/roster-app</module>
<module>rwiki/rwiki-tool/tool</module>
<!-- <module>sam/samigo-app</module> -->
<module>sections/sections-app</module>
<module>sections/sections-app-util</module>
<module>syllabus/syllabus-app</module>
</modules>
</profile>
Run sakaiartifactgenerator.bash
sh sakaiartifactgenerator.sh 2.8.1 /Users/arwhyte/Development/svn/sakai/branches/sakai-2.8.1
Download and check samigo audio jar for signature
jarsigner -verify sakai-samigo-audio-2.8.1.jar
Check artifacts
1. Build and deploy the sakai-src archives.
WARNING do not issue clean and install goals or local repo will get wiped prematurely (Sakai maven2 repo has yet to be updated).
cd master mvn install cd .. mvn -o -Dmaven.test.skip=true sakai:deploy
2. Test the sakai-bin archives
Check that the ant task built the archives correctly. Fix if necessary as follows:
tar -czvf sakai-bin-2.8.1.tgz ECLv2.text common components licenses server shared webapps
3. Run the demo artifact.
Update Sakai Maven2 repo
1. Make backup copy of current maven2/org/sakaiproject folder where x.x.x equals the previous Sakai release number. Then untar updated files:
sudo tar -xvzf mavenrepo-2.8.1.tgz -C /var/www/html/
Cut release tag from 2.8.1 branch
The sakaitagbuilder.bash script accepts two arguments: Sakai version and tag suffix (e.g., blank, beta01, rc01, qa01). In this case no tag suffix is required.
bash sakaitagbuilder-2.8.bash [JIRA ISSUE] sakai-2.8.1 tags 2.8.1
After the release is generated, backup .m2/repository/org/sakaiproject, whack original (to ensure someone new can populate their repo from scratch), download the release tag and build and deploy it to a fresh Tomcat and fresh MySQL database.
Update release pages
Make sure that external links to Confluence release pages are updated.