View source for CcPublisher Release Procedure

This page documents the procedure used when creating a new release of ccPublisher.  Instructions assume you have successfully checked out a sandbox from Subversion, as described [[Developing ccPublisher 2|here]].

== Increment Version Number ==

The version number currently needs to be updated in three places.  This will be corrected in the future (see [http://roundup.creativecommons.org/ccpublisher/issue102 Issue 102]).

=== pyarchive ===

The <code>pyarchive</code> package is responsible for assembling metadata and uploading files to the [http://archive.org Internet Archive].  The file <code>submission.py</code> contains the version number as part of the uploading application identification.  For example, the current release contains the following code that would need updated for a new release:

        result.write(u"""
        <title>%s</title>
        <collection>%s</collection>
        <mediatype>%s</mediatype>
        <upload_application appid="ccpublisher" version="1.9.3" />
        """ % (self.title, self.collection, self.mediatype) )

=== version.txt ===

The <code>version.txt</code> contains the current version number and is used for the about box and other user-visible locations.  This file is located in the resources directory of a ccPublisher checkout.

=== setup.nsi ===

<code>setup.nsi</code>, located in the deploy/win32 directory of a Subversion checkout, contains instructions for building the installer for Windows.  The version number appears near the top of the file.  The line similar to 

   !define VERSION 1.9.3.0

needs to be updated before the installer is generated.  Note that this '''must''' be a 4 digit version number.

== Branch or Tag Subversion ==

When creating a release, it's important to tag or branch the Subversion repository with version information.  In general branches are only for major releases (2.0, etc), while tags are made for each release.  You can tag Subversion using a command such as:

  $ svn cp svn+ssh://<username>@svn.berlios.de/svnroot/repos/cctools/publisher/trunk svn+ssh://<username>@svn.berlios.de/svnroot/repos/cctools/publisher/tags/ccpublisher-1.9.3

This will create a copy of the current repository trunk as a tag (in the example above for 2.0 beta 3).  Note that this only tags changes which have been committed; changes which are in your local sandbox are '''not''' included in the tagged copy.

Branching is performed in a similar fashion.

  $ svn cp svn+ssh://<username>@svn.berlios.de/svnroot/repos/cctools/publisher/trunk svn+ssh://<username>@svn.berlios.de/svnroot/repos/cctools/publisher/branches/ccpublisher-2.0

== Create Packages ==

The package creation process varies slightly for different platforms.  We '''will''' have scripts for this, we just haven't found the right tool.  Ideally something like Ant, but without the Java overhead.  Suggestions welcome.

=== Linux ===

We currently distribute tarballs of ccPublisher for Linux.  There is some support for building RPMs in Subversion, but it is far more fragile than the simple tarball support.  To build a tarball from your checkout:

  $ python setup.py sdist

Distutils will create a tarball containing all the code necessary for ccPublisher in the <code>dist</code> directory with the filename <code>ccPublisher-X.Y.Z.tar.gz</code>, where X.Y.Z is the version number.

=== Windows ===

The [http://www.py2exe.org py2exe] [http://docs.python.org/dist/dist.html distutils] extension takes a Python script, assembles the dependencies, and creates an executable stub along with the dependencies.  To build the application byte code and loader, run the following command:

  C:\publisher> c:\python24\python.exe setup.py py2exe

This will assemble the necessary files in the <code>dist</code> subdirectory.  When building ccPublisher, you will see <code>ccpublisher.exe</code>; this is the main application.

Once the application is built, an installer must be created.  ccPublisher uses [http://nsis.sourceforge.net NSIS] to create Windows installation packages.  The script used to build the installer is deploy/win32/setup.nsi.  If you are using Eclipse, the [http://eclipsensis.soureforge.net EclipseNSIS] plugin allows you to build the installer from within Eclipse.  The [http://nsis.sourceforge.net/Developer_Center NSIS wiki] has documentation on other ways to use NSIS.  After building the installer you'll be left with <code>setup.exe</code> in the working directory (<code>deploy/win32</code> under Eclipse).

=== Mac OS X ===

The [http://undefined.org/python/py2app.html py2app] [http://docs.python.org/dist/dist.html distutils] extension takes a Python script, assembles the dependencies, and creates an executable bundle for Mac OS X.  To build the application byte code and loader, run the following command:

  $ python2.4 setup.py py2app

Note that ccPublisher does require Python 2.4, while 2.3 is included with Mac OS X.  You can download a Python 2.4 Framework Build for OS X at [http://www.python.org/download/releases/2.4.3/ python.org].  After running the py2app build, the <code>dist</code> directory will contain the application bundle, ccPublisher.app.  An application bundle is actually a directory which contains information used to load the app.  Zip this directory up for distribution, using the following commands.  Note that the <code>-y</code> parameter is important -- it causes symbolic links to be stored as links and not resolved.

  $ cd dist
  $ zip -ry ccPublisher-1.9.3.zip ccPublisher.app

== Distribute Packages ==