Docs Setup Checkout

Checkout from SVN and building a release

Note: a checkout from SVN might not give you a working version. Do this only if you know what you are doing. If not, use our download section to get a working version.

To checkout Stubbles from our Subversion repository use this command:

svn co http://svn.stubbles.net/dev/framework/trunk stubbles

This will give you the complete current development version of Stubbles which contains the following directories:

build                  => Will contain the release after it has been build
lib*                   => contains other third party libraries
projects*
  /common*             => Javascript, CSS, and images for distributed features
  /dist*               => Base installation directory
  /examples*           => example project of Stubbles usage
src
  /main
    /javascript*       => javascript classes provided by Stubbles
    /php               => php classes organized in packages, as well as classes of subprojects
      /net/stubbles*   => the stubbles classes
      /org/stubbles*   => classes for working with the repository and creating builds
    /resources*        => other source file, that contain no php (xml files for example)
  /test
    /php               => test cases and test suites
    /resources         => other non-php files needed by the test cases
build.properties       => properties used in the phing build process
build.xml              => build file for phing
LICENSE*               => contains the license
VERSION                => current version of the checkout

A * behind the directory name indicates that contents of this directory will be part of the release. All other directories are not part of the release.

To build a release you need Phing. (We recommend an installation via PEAR.) Additionally you need the star tools, install them via pear install bovigo/star-alpha (In case PEAR reports an unknown channel do pear channel-discover pear.bovigo.org first). Change to the directory where you checked out Stubbles. To run the unit tests, type phing test.

To build a release, just type phing. Now all unit and integration tests are executed. After that the Stubbles release will be created. If all goes well you will find the release in a tar.gz-version in build/stubbles-$VERSION.tar.gz and an unpacked version in build/stubbles-$VERSION. See the directory layout of Stubbles for how this should look like. (To build a release without running any tests use phing build.

The version number is read from the VERSION file in the checkout. If you want to overrule this version number, type phing -Dversion YOUR_VERSIONNUMBER_HERE.