Mercurial > p > roundup > code

annotate BUILD.txt @ 3536:00a7983b4666

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
*** empty log message ***
author Richard Jones <richard@users.sourceforge.net>
date Fri, 03 Feb 2006 04:12:36 +0000
parents 616244e247f4
children 503d4c10f1f8
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
3106
a574d183b0df *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
5 want it to stay that way, too. This document describes how to build a
a574d183b0df *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
6 source release. Users of Roundup should read the doc/installation.txt file
a574d183b0df *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
7 to find out how to install this software.
98
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
8
3106
a574d183b0df *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
9 Building a release of Roundup is done by running:
98
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
10
3089
33e3ba342e93 Typo fixes: [SF#097860] and [SF#097864].
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 2237
diff changeset
11 1. Make sure the unit tests run! "./run_tests.py"
3531
616244e247f4 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3106
diff changeset
12 2. Tag the CVS for the release, eg. "cvs tag -R release-0-6-3"
616244e247f4 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3106
diff changeset
13 3. Edit roundup/__init__.py and doc/announcement.txt to reflect the new
1939
1303c208419d some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents: 1875
diff changeset
14 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
15 setup.py description field.
3531
616244e247f4 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3106
diff changeset
16 4. Clean out all *.orig, *.rej, .#* files from the source.
616244e247f4 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3106
diff changeset
17 5. python setup.py clean --all
616244e247f4 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3106
diff changeset
18 6. Edit setup.py to ensure that all information therein (version, contact
1939
1303c208419d some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents: 1875
diff changeset
19 information etc) is correct.
3531
616244e247f4 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3106
diff changeset
20 7. python setup.py sdist --manifest-only
616244e247f4 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3106
diff changeset
21 8. Check the MANIFEST to make sure that any new files are included. If
1939
1303c208419d some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents: 1875
diff changeset
22 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
23 MANIFEST.in may be found in disutils.filelist._parse_template_line.
3531
616244e247f4 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3106
diff changeset
24 9. python setup.py sdist
1939
1303c208419d some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents: 1875
diff changeset
25 (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
26 command)
3531
616244e247f4 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3106
diff changeset
27 10. Unpack the new dist file in /tmp then a) run_test.py and b) demo.py
1947
0e19e99075e3 fix #white in cgitb
Richard Jones <richard@users.sourceforge.net>
parents: 1939
diff changeset
28 with all available Python versions.
3531
616244e247f4 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3106
diff changeset
29 11. Generate gpg signature with "gpg -a --detach-sign"
616244e247f4 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3106
diff changeset
30 12. python setup.py bdist_rpm
616244e247f4 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3106
diff changeset
31 13. python setup.py bdist_wininst
98
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
32
1354
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
33 So, those commands in a nice, cut'n'pasteable form::
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
34
3531
616244e247f4 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3106
diff changeset
35 find . -name '*.orig' -exec rm {} \;
616244e247f4 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3106
diff changeset
36 find . -name '*.rej' -exec rm {} \;
616244e247f4 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3106
diff changeset
37 find . -name '.#*' -exec rm {} \;
1354
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
38 python setup.py clean --all
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
39 python setup.py sdist --manifest-only
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
40 python setup.py sdist --quiet
2237
f624fc20f8fe added capturing of stats
Richard Jones <richard@users.sourceforge.net>
parents: 2223
diff changeset
41 python setup.py bdist_rpm
f624fc20f8fe added capturing of stats
Richard Jones <richard@users.sourceforge.net>
parents: 2223
diff changeset
42 python setup.py bdist_wininst
1605
da7edcdd8500 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1354
diff changeset
43 python2.3 setup.py register
98
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
44
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
45
3531
616244e247f4 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3106
diff changeset
46
1354
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
47 Distributing Releases
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
48 =====================
493
3daf92816746 build notes, modified announcement
Richard Jones <richard@users.sourceforge.net>
parents: 240
diff changeset
49
3daf92816746 build notes, modified announcement
Richard Jones <richard@users.sourceforge.net>
parents: 240
diff changeset
50 Once a release is built, follow these steps:
1354
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
51
3531
616244e247f4 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3106
diff changeset
52 1. FTP the tar.gz from the dist directory to to the "incoming" directory on
1354
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
53 "upload.sourceforge.net".
3531
616244e247f4 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3106
diff changeset
54 2. Make a quick release at:
1354
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
55 http://sourceforge.net/project/admin/qrs.php?package_id=&group_id=31577
3531
616244e247f4 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3106
diff changeset
56 3. PyPI registration / upload::
616244e247f4 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3106
diff changeset
57
616244e247f4 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3106
diff changeset
58 python setup.py register
616244e247f4 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3106
diff changeset
59 python2.5 setup.py sdist upload --sign
616244e247f4 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3106
diff changeset
60
616244e247f4 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3106
diff changeset
61 4. Send doc/announcement.txt to python-announce@python.org
616244e247f4 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3106
diff changeset
62 5. Notify any other news services as appropriate...
493
3daf92816746 build notes, modified announcement
Richard Jones <richard@users.sourceforge.net>
parents: 240
diff changeset
63
2223
9b447ac40be3 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2221
diff changeset
64 http://freshmeat.net/projects/roundup/
9b447ac40be3 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2221
diff changeset
65
Roundup Issue Tracker: http://roundup-tracker.org/