Core Build Process

Linus Ericson, Markus Gylling, Romain Deltour

Latest update: 2007-12-21

A step-by-step guide on building the Pipeline core.

Note: In the following guide {DATE} is the date of the date of the release in YYYYMMDD format.

1. Make sure the project is updated to the latest svn version.

2. If you are making an official release (i.e. not just local for your own needs) Make sure to have run the entire suite in org.daisy.pipeline.test.TestDriver (using the main method of TestDriver) in the IDE.

3. If you are making an official release, modify the date in org/daisy/util/Version.java and org/daisy/pipeline/Version.java. Commit.

4. Make sure the build-core.xml is updated, i.e. the JARs defined in the <fileset> with id="fileset.utilJars" are correct.

5. Excluding a certain transformer:

   • make sure the transformer is not used by any scripts...
   • In build-core.xml, edit the <patternset> with id="patternset.transformers". Add an exclude line: <exclude name="int_daisy_validator/**/*.*"/>

6. If you are making an official build, make sure the UserAgreement.txt file lists the corrent libraries.

7. If you are making an official build, create a tag:

   • from the "SVN Repository Exploring" perspective, right click on trunk/dmfc and select "Branch/Tag..."
   • set the "To URL" to "https://daisymfc.svn.sourceforge.net/svnroot/daisymfc/tags/v{DATE}"

   Or from the command line: svn copy https://daisymfc.svn.sourceforge.net/svnroot/daisymfc/trunk/dmfc https://daisymfc.svn.sourceforge.net/svnroot/daisymfc/tags/v{DATE} -m "Tagging the v{DATE} release."

8. Make sure the following is run on a clean pipeline checkout:

   Run the "all" target in the build script. The generated files are:

   • dist/pipeline-${DATE}.zip
   • dist/pipeline-${DATE}-src.zip
   • dist/org.daisy.util-docs-${DATE}.zip
   • dist/org.daisy.pipeline-framework-docs-${DATE}.zip
   • dist/org.daisy.pipeline-transformers-docs-${DATE}.zip

9. Test the generated build!

   • Minimally, run a couple of scripts, preferably using both pipeline.bat and pipeline.sh.
   • If creating an official release, make sure to have run the entire suite in org.daisy.pipeline.test.TestDriver (using the main method of TestDriver).
   • make sure the javadoc looks OK

10. Upload to sf.net

    Create a release named "pipeline-{ISO-DATE}" (where {ISO-DATE} is the release date in YYYY-MM-DD format) in the "pipeline" package and upload the generated zip files.

    Make sure to update edit the download page (using the "Create/Edit Download Page" link) to point to pipeline-${DATE}.zip.

11. Change the download link on the Pipeline sourceforge website download section to http://downloads.sourceforge.net/daisymfc/pipeline-{DATE}.zip

12. Rebuild the documentation suite using org.daisy.pipeline.util.DocIndexGenerator to regenerate indices, and then upload the whole /doc directory on the Pipeline sourceforge website.

    Note: make sure write acces is given to both user and group, if not run from the sf shell:
    $ cd /home/groups/d/da/daisymfc
$ chgrp daisymfc . -R
$ find . -type f -exec chmod 664 {} \;
$ find . -type d -exec chmod 775 {} \;