README

   1 Requirements
   2 ============
   3
   4 Packages needed to build, sign and upload (on Debian lenny):
   5
   6 * zip
   7 * ruby
   8 * libxslt-ruby
   9 * libnss3-1d
  10 * python-paramiko
  11 * ... and dependencies
  12
  13 Spock (http://hyperstruct.net/projects/spock) must be installed in
  14 release/spock. The McCoy profile must be in release/mccoy.default.
  15
  16 Configuration
  17 =============
  18
  19 To upload to the server, copy common/server.conf.example to common/server.conf
  20 and edit the file to match the correct settings.
  21
  22 SSH is required. Local file operations are not supported yet.
  23
  24 Preparing for a release
  25 =======================
  26
  27 The web change log needs to be written. Use www/changes-next.mdwn as a staging
  28 area for the next version.
  29
  30 Uploading a release
  31 ===================
  32
  33 You must first build a distribution which contains the XPI, news and unsigned
  34 release files. To do so, type
  35
  36     make dist VERSION=x.y.z
  37
  38 where VERSION is the version of the release. This should be the current
  39 version in git without the "pre". For example, you should use VERSION=0.7.5
  40 if the git version is 0.7.5pre.
  41
  42 After inspecting and testing the distribution, upload it by typing
  43
  44     make upload
  45
  46 This automatically does the following:
  47
  48     1. Uploads the XPI to $(file_dir)
  49     2. Uploads the news to $(file_dir)/news
  50     3. Signs the update RDF file and uploads it
  51     4. Replaces the current changes.mdwn file on the server with the contents of
  52        changes-next.mdwn
  53     5. Moves the XPI of the previous version to $(file_dir)/oldxpi
  54     6. Deletes the current nightly XPI
  55
  56 What to do after a release
  57 ==========================
  58
  59 First, you should tag the git repo with the latest version number. Then you
  60 should bump the version number in:
  61
  62     Makefile
  63     content/NEWS
  64     install.rdf
  65     www/index.php.txt (including date and version compatibility)
  66
  67 You should also add the release date to the latest version in
  68 www/changes-next.mdwn, then copy it to www/changes.mdwn.
  69
  70 Commit and push the updates above.
  71
  72 Make a release topic on Blood Money. The title should be "[release] GameFOX
  73 x.y.z", and conform to this template:
  74
  75     <b>Download:</b>
  76
  77     http://link_to_xpi
  78
  79     <b>Changes:</b>
  80
  81     [changes for the latest version from content/NEWS or
  82      www/changes(-next).mdwn]
  83
  84 Finally, you should upload the *_amo.xpi file in the root of the git tree to
  85 addons.mozilla.org.
  86
  87 Configuring a nightly build server
  88 ==================================
  89
  90 To be written.