Bug 274
[auf_roundup.git] / BUILD.txt
1Building Releases
4Roundup is currently a source-only release - it has no binary components. I
5want it to stay that way, too. This document describes how to build a
6source release. Users of Roundup should read the doc/installation.txt file
7to find out how to install this software.
9Building and distributing a release of Roundup is done by running:
111. Make sure the unit tests run! "./run_tests.py"
122. Edit roundup/__init__.py and doc/announcement.txt to reflect the new
13 version and appropriate announcements. Add truncated announcement to
14 setup.py description field.
153. Note the SVN revision in the CHANGES.txt file.
164. Clean out all *.orig, *.rej, .#* files from the source.
175. python setup.py clean --all
186. Edit setup.py to ensure that all information therein (version, contact
19 information etc) is correct.
207. python setup.py sdist --manifest-only
218. 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.
249. python setup.py sdist
25 (if you find sdist a little verbose, add "--quiet" to the end of the
26 command)
2710. Unpack the new dist file in /tmp then a) run_test.py and b) demo.py
28 with all available Python versions.
2911. Assuming all is well tag the release in SVN::
31 svn cp https://roundup.svn.sourceforge.net/svnroot/roundup/roundup/trunk \
32 https://roundup.svn.sourceforge.net/svnroot/roundup/roundup/tags/release-1.4.12
3411. python setup.py bdist_rpm
3512. python setup.py bdist_wininst
3613. Send doc/announcement.txt to python-announce@python.org and
37 roundup-users@lists.sourceforge.net and
38 roundup-devel@lists.sourceforge.net
40So, those commands in a nice, cut'n'pasteable form::
42 find . -name '*.orig' -exec rm {} \;
43 find . -name '*.rej' -exec rm {} \;
44 find . -name '.#*' -exec rm {} \;
45 python setup.py clean --all
46 python setup.py sdist --manifest-only
47 python setup.py sdist --quiet
48 python setup.py bdist_rpm
49 python setup.py bdist_wininst
50 python setup.py register
51 python setup.py sdist upload --sign
52 python setup.py bdist_wininst upload --sign
54(if the last two fail make sure you're using python2.5+)