Difference between revisions of "CcPublisher Release Procedure"
| Line 1: | Line 1: | ||
This page documents the procedure used when creating a new release of ccPublisher. | This page documents the procedure used when creating a new release of ccPublisher. | ||
| − | = Increment Version Number = | + | == Increment Version Number == |
| − | + | The version number currently needs to be updated in two 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. | ||
| + | |||
| + | == 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. | ||
=== Prerequisites === | === Prerequisites === | ||
| Line 36: | Line 53: | ||
=== Packaging === | === Packaging === | ||
| − | = Distribute Packages | + | == Distribute Packages == |
| − | |||
| − | |||
Revision as of 21:04, 9 May 2006
This page documents the procedure used when creating a new release of ccPublisher.
Contents
Increment Version Number
The version number currently needs to be updated in two places. This will be corrected in the future (see Issue 102).
pyarchive
The pyarchive package is responsible for assembling metadata and uploading files to the Internet Archive. The file submission.py 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 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.
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.
Prerequisites
| Windows | Mac OS X | Linux |
|---|---|---|
|
|
Building
When issuing
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
