CcPublisher Release Procedure

From Creative Commons
Jump to: navigation, search

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 here.

Increment Version Number

The version number currently needs to be updated in three places. This will be corrected in the future (see Issue 102).


The pyarchive package is responsible for assembling metadata and uploading files to the Internet Archive. The file 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:

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


The version.txt 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, 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.2

needs to be updated before the installer is generated.

Branch or Tag Subversion

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.


Windows Mac OS X Linux
  • py2app


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 sdist

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


The py2exe 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 py2exe

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

Once the application is built, an installer must be created. ccPublisher uses NSIS to create Windows installation packages.

Mac OS X

Distribute Packages