annotate BUILD.txt @ 1935:b4e670840963

Missed change note for last checkin.
author Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
date Fri, 21 Nov 2003 21:41:19 +0000
parents 3ffb7b56172a
children 1303c208419d
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
1875
3ffb7b56172a *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1842
diff changeset
10 1. Make sure the unit tests run! "python run_tests.py"
1655
0feb34b2de71 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1643
diff changeset
11 2. Edit roundup/__init__.py and doc/announcement.txt to reflect the new
1643
41dbd406a79c *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1605
diff changeset
12 version and appropriate announcements. Add truncated announcement to
41dbd406a79c *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1605
diff changeset
13 setup.py description field.
1842
7bdd9ce360d0 mention tagging :)
Richard Jones <richard@users.sourceforge.net>
parents: 1655
diff changeset
14 3. Tag the CVS with a release tag (ie. 'release-N-N-N')
7bdd9ce360d0 mention tagging :)
Richard Jones <richard@users.sourceforge.net>
parents: 1655
diff changeset
15 4. python setup.py clean --all
7bdd9ce360d0 mention tagging :)
Richard Jones <richard@users.sourceforge.net>
parents: 1655
diff changeset
16 5. Edit setup.py to ensure that all information therein (version, contact
1354
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
17 information etc) is correct.
1842
7bdd9ce360d0 mention tagging :)
Richard Jones <richard@users.sourceforge.net>
parents: 1655
diff changeset
18 6. python setup.py sdist --manifest-only
7bdd9ce360d0 mention tagging :)
Richard Jones <richard@users.sourceforge.net>
parents: 1655
diff changeset
19 7. Check the MANIFEST to make sure that any new files are included. If
1354
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
20 they are not, edit MANIFEST.in to include them. "Documentation" for
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
21 MANIFEST.in may be found in disutils.filelist._parse_template_line.
1842
7bdd9ce360d0 mention tagging :)
Richard Jones <richard@users.sourceforge.net>
parents: 1655
diff changeset
22 8. python setup.py sdist
1354
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
23 (if you find sdist a little verbose, add "--quiet" to the end of the
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
24 command)
98
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
25
1354
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
26 So, those commands in a nice, cut'n'pasteable form::
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
27
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
28 python setup.py clean --all
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
29 python setup.py sdist --manifest-only
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
30 python setup.py sdist --quiet
1605
da7edcdd8500 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1354
diff changeset
31 python2.3 setup.py register
98
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
32
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
33
1354
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
34 Distributing Releases
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
35 =====================
493
3daf92816746 build notes, modified announcement
Richard Jones <richard@users.sourceforge.net>
parents: 240
diff changeset
36
3daf92816746 build notes, modified announcement
Richard Jones <richard@users.sourceforge.net>
parents: 240
diff changeset
37 Once a release is built, follow these steps:
1354
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
38
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
39 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
40 "upload.sourceforge.net".
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
41 2. Make a quick release at:
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
42 http://sourceforge.net/project/admin/qrs.php?package_id=&group_id=31577
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
43 3. Add a news item at:
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
44 https://sourceforge.net/news/submit.php?group_id=31577
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
45 using the top of doc/announcement.txt
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
46 4. Send doc/announcement.txt to python-announce@python.org
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
47 5. Notify any other news services as appropriate...
493
3daf92816746 build notes, modified announcement
Richard Jones <richard@users.sourceforge.net>
parents: 240
diff changeset
48
3daf92816746 build notes, modified announcement
Richard Jones <richard@users.sourceforge.net>
parents: 240
diff changeset
49
1354
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
50 Author
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
51 ======
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
52
194
30c3a37b699f Started stuff off for the 0.2.5 release
Richard Jones <richard@users.sourceforge.net>
parents: 184
diff changeset
53 richard@users.sourceforge.net
98
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
54

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