Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

Sakai

...

The Sakai Community manages its source code utilizing the Subversion (SVN) source control management system. Sakai source code is available at

https://source.sakaiproject.org/svn/

source code can also be checked out anonymously from our SVN repository. The latest development work is located in /sakai/trunk; stable releases can be found in /sakai/tags. Maintenance branches also exist in /sakai/branches for applying bug fixes to current or previous tagged releases.

Trunk: https://source.sakaiproject.org/svn/sakai/trunk/

Tags: https://source.sakaiproject.org/svn/sakai/tags/

Branches: https://source.sakaiproject.org/svn/sakai/branches/

In addition, Sakai's SVN repository includes a number of projects that are not included in official Sakai releases that can be checked out and installed in the Sakai CLE. Code for these projects (known within the Sakai Community as contributed or "contrib" projects) is located at the following address:

Contrib: https://source.sakaiproject.org/contrib/

You can check out the source code directly from SVN. You might wish to do this, for example, in order to grab the maintenance branch, which includes the latest set of bug fixes. You must first install Subversion (binary or source) or a Subversion client package appropriate for your operating system. SVN Packages can be found at http://subversion.tigris.org/project_packages.html. If you're on a Windows platform we also recommend that you take a look at TortoiseSVN. If you're working with Eclipse, you might want to take a look at the Subclipse plugin.

Once you have installed your SVN client, check out the release into a local folder with the following command:

2.6 release tags

Stable Sakai 2.6 release tags are available at

https while maintenance and other work is performed in /branches.

Starting with Sakai 2.6, Sakai common services (e.g., authz, content, event, site, tool, user, etc.) have been repackaged and refactored as the Sakai Kernel (K1). In most cases, you will never have to check out the kernel manually as Sakai kernel dependencies are managed by Maven.

2.6 release archive

You can download an archive of Sakai source code:

...

2.6 release tags

To checkout a stable release tag issue the following svn command from the terminal:

...

No Format
svn co https://source.sakaiproject.org/svn/sakai/branches/sakai_2-6-x/ sakai_2-6-x

2.6 Contributed (Contrib) projects

Additional capabilities provided by Sakai Community members are available as "contrib" projects. These projects range from prototype efforts to mature tool and service releases such as the Universidade Fernando Pessoa's SiteStats tool or Etudes' Melete Lesson Builder tool.

The Contrib repo is located at

...

/

...

(minus) Before installing a "contrib" tool check its release notes to confirm that it's Sakai common services dependencies have been updated to bind to the new kernel. Contrib tool information can also be found in Sakai's Confluence wiki.

Adding a 2.6-compatible contrib tool to your build is usually a straightforward process. For example, to add SiteStats to you Sakai build checkout the latest release tag into your sakai-2.6.0 base folder:

No Format
 cd sakai-2.6.0
svn co https://source.sakaiproject.org/contrib/ufp/sitestats/tags/sitestats_2-0-rc1/ sitestats

Edit SiteStats' base pom file sitestats/pom.xml updating the <parent> pom's <version> value to the appropriate Sakai version:

Code Block
xmlxml

<!-- Parent: Sakai master pom -->
<parent>
  <artifactId>master</artifactId>
  <groupId>org.sakaiproject</groupId>
  <!-- EDIT ME: Sakai Version -->
  <version>2.6.0</version>-->                     <!-- For 2.6.0 release -->   
  <!-- <version>2.6.1-SNAPSHOT</version> -->      <!-- For 2.6.x branch -->
  <!-- <version>2.7.0-SNAPSHOT</version> -->      <!-- For TRUNK -->  
</parent>

Then install SiteStats artifacts in your local Maven repository followed by deployment to your servlet container (e.g. Tomcat):

No Format

cd sitestats
mvn clean install sakai:deploy