Code

build notes, modified announcement
[roundup.git] / BUILD.txt
1                                     Roundup
2                                     =======
4 1. Building Releases
5 ====================
7 Roundup is currently a source-only release - it has no binary components. I
8 want it to stay that way, too.
10 This means that we only need to ever build source releases. This is done by
11 running:
13   0. Edit setup.py and doc/announcement.txt to reflect the new version and
14      appropriate announcments.
15   1. python setup.py clean --all
16   2. Edit setup.py to ensure that all information therein (version, contact
17      information etc) is correct.
18   3. python setup.py sdist --manifest-only
19   4. Check the MANIFEST to make sure that any new files are included. If
20      they are not, edit MANIFEST.in to include them. "Documentation" for
21      MANIFEST.in may be found in disutils.filelist._parse_template_line.
22   5. python setup.py sdist
23      (if you find sdist a little verbose, add "--quiet" to the end of the
24       command)
26 So, those commands in a nice, cut'n'pasteable form :)
27 python setup.py clean --all
28 python setup.py sdist --manifest-only
29 python setup.py sdist --quiet
32 2. Distributing Releases
33 ========================
35 Once a release is built, follow these steps:
36   1. FTP the tar.gz from the dist directory to to the "incoming" directory on
37      "upload.sourceforge.net".
38   2. Make a quick release at:
39       http://sourceforge.net/project/admin/qrs.php?package_id=&group_id=31577
40   3. Add a news item at:
41       https://sourceforge.net/news/submit.php?group_id=31577
42      using the top of doc/announcement.txt
43   4. Send doc/announcement.txt to python-announce@python.org
44   5. Notify any other news services as appropriate...
47 3. Author
48 =========
49 richard@users.sourceforge.net