Mercurial > p > roundup > code

annotate BUILD.txt @ 4546:d39c37fd2940 git

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Repository conversion from Subversion to git.
author Eric S. Raymond <esr@thyrsus.com>
date Tue, 18 Oct 2011 10:20:29 -0400
parents 079fdf9b8de1
children 93b0b3f0085a
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
3588
503d4c10f1f8 pre-release stuff
Richard Jones <richard@users.sourceforge.net>
parents: 3531
diff changeset
9 Building and distributing 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"
4261
d82cd44bea96 update BUILD
Richard Jones <richard@users.sourceforge.net>
parents: 4104
diff changeset
12 2. Edit roundup/__init__.py and doc/announcement.txt to reflect the new
4393
Richard Jones <richard@users.sourceforge.net>
parents: 4353
diff changeset
13 version and appropriate announcements.
4262
e5e4434957c5 reinstate 3 with correct instructions
Richard Jones <richard@users.sourceforge.net>
parents: 4261
diff changeset
14 3. Note the SVN revision in the CHANGES.txt file.
e5e4434957c5 reinstate 3 with correct instructions
Richard Jones <richard@users.sourceforge.net>
parents: 4261
diff changeset
15 4. Clean out all *.orig, *.rej, .#* files from the source.
e5e4434957c5 reinstate 3 with correct instructions
Richard Jones <richard@users.sourceforge.net>
parents: 4261
diff changeset
16 5. python setup.py clean --all
e5e4434957c5 reinstate 3 with correct instructions
Richard Jones <richard@users.sourceforge.net>
parents: 4261
diff changeset
17 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
18 information etc) is correct.
4487
5e9578d35d03 Document 'build_doc' step.
Stefan Seefeld <stefan@seefeld.name>
parents: 4433
diff changeset
19 7. python setup.py build_doc
5e9578d35d03 Document 'build_doc' step.
Stefan Seefeld <stefan@seefeld.name>
parents: 4433
diff changeset
20 8. python setup.py sdist --manifest-only
5e9578d35d03 Document 'build_doc' step.
Stefan Seefeld <stefan@seefeld.name>
parents: 4433
diff changeset
21 9. 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.
4487
5e9578d35d03 Document 'build_doc' step.
Stefan Seefeld <stefan@seefeld.name>
parents: 4433
diff changeset
24 10. 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)
4487
5e9578d35d03 Document 'build_doc' step.
Stefan Seefeld <stefan@seefeld.name>
parents: 4433
diff changeset
27 11. 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.
4487
5e9578d35d03 Document 'build_doc' step.
Stefan Seefeld <stefan@seefeld.name>
parents: 4433
diff changeset
29 12. Assuming all is well tag the release in SVN::
4353
7bfbf82ef3ca add tagging info to the release build doc
Richard Jones <richard@users.sourceforge.net>
parents: 4277
diff changeset
30
4527
079fdf9b8de1 fix build instructions
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4501
diff changeset
31 svn cp https://svn.roundup-tracker.org/svnroot/roundup/roundup/trunk \
079fdf9b8de1 fix build instructions
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4501
diff changeset
32 https://svn.roundup-tracker.org/svnroot/roundup/roundup/tags/release-1-4-19
4353
7bfbf82ef3ca add tagging info to the release build doc
Richard Jones <richard@users.sourceforge.net>
parents: 4277
diff changeset
33
4487
5e9578d35d03 Document 'build_doc' step.
Stefan Seefeld <stefan@seefeld.name>
parents: 4433
diff changeset
34 13. python setup.py bdist_rpm
5e9578d35d03 Document 'build_doc' step.
Stefan Seefeld <stefan@seefeld.name>
parents: 4433
diff changeset
35 14. python setup.py bdist_wininst
5e9578d35d03 Document 'build_doc' step.
Stefan Seefeld <stefan@seefeld.name>
parents: 4433
diff changeset
36 15. Send doc/announcement.txt to python-announce@python.org and
4277
9e1a91f3cf17 - Add roundup-devel@lists.sourceforge.net to announcement list.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4272
diff changeset
37 roundup-users@lists.sourceforge.net and
9e1a91f3cf17 - Add roundup-devel@lists.sourceforge.net to announcement list.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4272
diff changeset
38 roundup-devel@lists.sourceforge.net
98
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
39
1354
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
40 So, those commands in a nice, cut'n'pasteable form::
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
41
3531
616244e247f4 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3106
diff changeset
42 find . -name '*.orig' -exec rm {} \;
616244e247f4 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3106
diff changeset
43 find . -name '*.rej' -exec rm {} \;
616244e247f4 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3106
diff changeset
44 find . -name '.#*' -exec rm {} \;
1354
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
45 python setup.py clean --all
4487
5e9578d35d03 Document 'build_doc' step.
Stefan Seefeld <stefan@seefeld.name>
parents: 4433
diff changeset
46 python setup.py build_doc
1354
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
47 python setup.py sdist --manifest-only
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
48 python setup.py sdist --quiet
2237
f624fc20f8fe added capturing of stats
Richard Jones <richard@users.sourceforge.net>
parents: 2223
diff changeset
49 python setup.py bdist_rpm
f624fc20f8fe added capturing of stats
Richard Jones <richard@users.sourceforge.net>
parents: 2223
diff changeset
50 python setup.py bdist_wininst
3588
503d4c10f1f8 pre-release stuff
Richard Jones <richard@users.sourceforge.net>
parents: 3531
diff changeset
51 python setup.py register
4261
d82cd44bea96 update BUILD
Richard Jones <richard@users.sourceforge.net>
parents: 4104
diff changeset
52 python setup.py sdist upload --sign
4501
588e5dbbb9fe - document experience from release(s)
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4487
diff changeset
53 python2.5 setup.py bdist_wininst upload --sign
98
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
54
4261
d82cd44bea96 update BUILD
Richard Jones <richard@users.sourceforge.net>
parents: 4104
diff changeset
55 (if the last two fail make sure you're using python2.5+)
4501
588e5dbbb9fe - document experience from release(s)
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4487
diff changeset
56 Note that python2.6 won't correctly create a bdist_wininst install on
4527
079fdf9b8de1 fix build instructions
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4501
diff changeset
57 Linux (it will produce a .exe with "linux" in the name). 2.7 still has
079fdf9b8de1 fix build instructions
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4501
diff changeset
58 this bug (Ralf)
4501
588e5dbbb9fe - document experience from release(s)
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4487
diff changeset
59
Roundup Issue Tracker: http://roundup-tracker.org/