annotate BUILD.txt @ 1939:1303c208419d

some updates that were sitting on disk
author Richard Jones <richard@users.sourceforge.net>
date Thu, 04 Dec 2003 02:43:07 +0000
parents 3ffb7b56172a
children 0e19e99075e3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1354
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
1 Building Releases
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
2 =================
98
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
3
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
4 Roundup is currently a source-only release - it has no binary components. I
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
5 want it to stay that way, too.
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
6
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
7 This means that we only need to ever build source releases. This is done by
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
8 running:
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
9
1939
1303c208419d some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents: 1875
diff changeset
10 1. Make sure the unit tests run! "./run_tests"
1303c208419d some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents: 1875
diff changeset
11 2. Edit roundup/__init__.py and doc/announcement.txt to reflect the new
1303c208419d some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents: 1875
diff changeset
12 version and appropriate announcements. Add truncated announcement to
1303c208419d some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents: 1875
diff changeset
13 setup.py description field.
1303c208419d some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents: 1875
diff changeset
14 3. python setup.py clean --all
1303c208419d some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents: 1875
diff changeset
15 4. Edit setup.py to ensure that all information therein (version, contact
1303c208419d some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents: 1875
diff changeset
16 information etc) is correct.
1303c208419d some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents: 1875
diff changeset
17 5. python setup.py sdist --manifest-only
1303c208419d some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents: 1875
diff changeset
18 6. Check the MANIFEST to make sure that any new files are included. If
1303c208419d some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents: 1875
diff changeset
19 they are not, edit MANIFEST.in to include them. "Documentation" for
1303c208419d some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents: 1875
diff changeset
20 MANIFEST.in may be found in disutils.filelist._parse_template_line.
1303c208419d some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents: 1875
diff changeset
21 7. python setup.py sdist
1303c208419d some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents: 1875
diff changeset
22 (if you find sdist a little verbose, add "--quiet" to the end of the
1303c208419d some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents: 1875
diff changeset
23 command)
1303c208419d some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents: 1875
diff changeset
24 8. unpack the new dist file in /tmp and a) run_test, and b) demo.py
1303c208419d some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents: 1875
diff changeset
25 9. Generate gpg signature with "gpg -a --detach-sign" and upload to
1303c208419d some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents: 1875
diff changeset
26 mechanicalcat.net
1303c208419d some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents: 1875
diff changeset
27 10. PyPI registration
1303c208419d some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents: 1875
diff changeset
28 11. tag the CVS for the release, eg. "cvs tag -R release-0-6-3"
98
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
29
1354
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
30 So, those commands in a nice, cut'n'pasteable form::
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
31
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
32 python setup.py clean --all
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
33 python setup.py sdist --manifest-only
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
34 python setup.py sdist --quiet
1605
da7edcdd8500 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1354
diff changeset
35 python2.3 setup.py register
98
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
36
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
37
1354
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
38 Distributing Releases
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
39 =====================
493
3daf92816746 build notes, modified announcement
Richard Jones <richard@users.sourceforge.net>
parents: 240
diff changeset
40
3daf92816746 build notes, modified announcement
Richard Jones <richard@users.sourceforge.net>
parents: 240
diff changeset
41 Once a release is built, follow these steps:
1354
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
42
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
43 1. FTP the tar.gz from the dist directory to to the "incoming" directory on
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
44 "upload.sourceforge.net".
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
45 2. Make a quick release at:
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
46 http://sourceforge.net/project/admin/qrs.php?package_id=&group_id=31577
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
47 3. Add a news item at:
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
48 https://sourceforge.net/news/submit.php?group_id=31577
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
49 using the top of doc/announcement.txt
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
50 4. Send doc/announcement.txt to python-announce@python.org
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
51 5. Notify any other news services as appropriate...
493
3daf92816746 build notes, modified announcement
Richard Jones <richard@users.sourceforge.net>
parents: 240
diff changeset
52
3daf92816746 build notes, modified announcement
Richard Jones <richard@users.sourceforge.net>
parents: 240
diff changeset
53
1354
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
54 Author
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
55 ======
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
56
194
30c3a37b699f Started stuff off for the 0.2.5 release
Richard Jones <richard@users.sourceforge.net>
parents: 184
diff changeset
57 richard@users.sourceforge.net
98
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
58

Roundup Issue Tracker: http://roundup-tracker.org/