Code

Update customization examples too, expand upgrade notice a bit.
[roundup.git] / BUILD.txt
1 Building Releases
2 =================
4 Roundup is currently a source-only release - it has no binary components. I
5 want it to stay that way, too.
7 This means that we only need to ever build source releases. This is done by
8 running:
10 1.  Make sure the unit tests run! "./run_tests"
11 2.  Edit roundup/__init__.py and doc/announcement.txt to reflect the new
12     version and appropriate announcements. Add truncated announcement to
13     setup.py description field.
14 3.  python setup.py clean --all
15 4.  Edit setup.py to ensure that all information therein (version, contact
16     information etc) is correct.
17 5.  python setup.py sdist --manifest-only
18 6.  Check the MANIFEST to make sure that any new files are included. If
19     they are not, edit MANIFEST.in to include them. "Documentation" for
20     MANIFEST.in may be found in disutils.filelist._parse_template_line.
21 7.  python setup.py sdist
22     (if you find sdist a little verbose, add "--quiet" to the end of the
23      command)
24 8.  unpack the new dist file in /tmp then a) run_test.py and b) demo.py
25     with all available Python versions.
26 9.  generate gpg signature with "gpg -a --detach-sign" and upload to
27     Sourceforge.
28 10. PyPI registration
29 11. tag the CVS for the release, eg. "cvs tag -R release-0-6-3"
31 So, those commands in a nice, cut'n'pasteable form::
33  python setup.py clean --all
34  python setup.py sdist --manifest-only
35  python setup.py sdist --quiet
36  python2.3 setup.py register
39 Distributing Releases
40 =====================
42 Once a release is built, follow these steps:
44 1. FTP the tar.gz from the dist directory to to the "incoming" directory on
45    "upload.sourceforge.net".
46 2. Make a quick release at:
47     http://sourceforge.net/project/admin/qrs.php?package_id=&group_id=31577
48 3. Add a news item at:
49     https://sourceforge.net/news/submit.php?group_id=31577
50    using the top of doc/announcement.txt
51 4. Send doc/announcement.txt to python-announce@python.org
52 5. Notify any other news services as appropriate...
55 Author
56 ======
58 richard@users.sourceforge.net