BUILD.txt

   1 Building Releases
   2 =================
   3
   4 Roundup is currently a source-only release - it has no binary components. I
   5 want it to stay that way, too. This document describes how to build a
   6 source release. Users of Roundup should read the doc/installation.txt file
   7 to find out how to install this software.
   8
   9 Building and distributing a release of Roundup is done by running:
  10
  11 1.  Make sure the unit tests run! "./run_tests.py"
  12 2.  XXX "tag" SVN??
  13 3.  Edit roundup/__init__.py and doc/announcement.txt to reflect the new
  14     version and appropriate announcements. Add truncated announcement to
  15     setup.py description field.
  16 4.  Clean out all *.orig, *.rej, .#* files from the source.
  17 5.  python setup.py clean --all
  18 6.  Edit setup.py to ensure that all information therein (version, contact
  19     information etc) is correct.
  20 7.  python setup.py sdist --manifest-only
  21 8.  Check the MANIFEST to make sure that any new files are included. If
  22     they are not, edit MANIFEST.in to include them. "Documentation" for
  23     MANIFEST.in may be found in disutils.filelist._parse_template_line.
  24 9.  python setup.py sdist
  25     (if you find sdist a little verbose, add "--quiet" to the end of the
  26      command)
  27 10. Unpack the new dist file in /tmp then a) run_test.py and b) demo.py
  28     with all available Python versions.
  29 11. Generate gpg signature with "gpg -a --detach-sign"
  30 12. python setup.py bdist_rpm
  31 13. python setup.py bdist_wininst
  32 14. Send doc/announcement.txt to python-announce@python.org
  33 15. Notify any other news services as appropriate...
  34
  35       http://freshmeat.net/projects/roundup/
  36
  37
  38 So, those commands in a nice, cut'n'pasteable form::
  39
  40  find . -name '*.orig' -exec rm {} \;
  41  find . -name '*.rej' -exec rm {} \;
  42  find . -name '.#*' -exec rm {} \;
  43  python setup.py clean --all
  44  python setup.py sdist --manifest-only
  45  python setup.py sdist --quiet
  46  python setup.py bdist_rpm
  47  python setup.py bdist_wininst
  48  python setup.py register
  49  python2.5 setup.py sdist upload --sign
  50
  51