Mercurial > p > roundup > code

annotate RELEASE.txt @ 5326:db8659c4e8eb

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
xmlrpc: logging; content property The 'content' property is special: It should not be set to None when receiving an empty string (creation of an empty file) but to an empty string instead. Otherwise we'll get a traceback from the backend.
author Ralf Schlatterbeck <rsc@runtux.com>
date Tue, 29 May 2018 13:36:22 +0200
parents 534b8bebfb1d
children 1ee8b7a671e7
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
4807
641f0895d306 Revise BUILD.txt
anatoly techtonik <techtonik@gmail.com>
parents: 4798
diff changeset
4 Roundup is a pure Python application with no binary components. This file
641f0895d306 Revise BUILD.txt
anatoly techtonik <techtonik@gmail.com>
parents: 4798
diff changeset
5 describes how to build a source release. To find out how to install
641f0895d306 Revise BUILD.txt
anatoly techtonik <techtonik@gmail.com>
parents: 4798
diff changeset
6 Roundup, read the doc/installation.txt file.
98
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
7
4807
641f0895d306 Revise BUILD.txt
anatoly techtonik <techtonik@gmail.com>
parents: 4798
diff changeset
8 Roundup release checklist:
98
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
9
4807
641f0895d306 Revise BUILD.txt
anatoly techtonik <techtonik@gmail.com>
parents: 4798
diff changeset
10 1. Run unit tests! They should pass successfully. "./run_tests.py"
4815
efa61cc8be67 RELEASE.txt: doc/upgrading.txt needs to be updated too
anatoly techtonik <techtonik@gmail.com>
parents: 4809
diff changeset
11 2. Update version
efa61cc8be67 RELEASE.txt: doc/upgrading.txt needs to be updated too
anatoly techtonik <techtonik@gmail.com>
parents: 4809
diff changeset
12 CHANGES.txt
efa61cc8be67 RELEASE.txt: doc/upgrading.txt needs to be updated too
anatoly techtonik <techtonik@gmail.com>
parents: 4809
diff changeset
13 roundup/__init__.py
efa61cc8be67 RELEASE.txt: doc/upgrading.txt needs to be updated too
anatoly techtonik <techtonik@gmail.com>
parents: 4809
diff changeset
14 3. Update documentation
efa61cc8be67 RELEASE.txt: doc/upgrading.txt needs to be updated too
anatoly techtonik <techtonik@gmail.com>
parents: 4809
diff changeset
15 doc/announcement.txt
efa61cc8be67 RELEASE.txt: doc/upgrading.txt needs to be updated too
anatoly techtonik <techtonik@gmail.com>
parents: 4809
diff changeset
16 doc/upgrading.txt
4835
5cd6b0014f34 RELEASE.txt: Do 'setup.py check -rms' command to validate that long
anatoly techtonik <techtonik@gmail.com>
parents: 4834
diff changeset
17 4. Update setup.py info is needed (contacts, classifiers, etc.), and
5cd6b0014f34 RELEASE.txt: Do 'setup.py check -rms' command to validate that long
anatoly techtonik <techtonik@gmail.com>
parents: 4834
diff changeset
18 check that metadata is valid and long descriptions is proper reST:
5cd6b0014f34 RELEASE.txt: Do 'setup.py check -rms' command to validate that long
anatoly techtonik <techtonik@gmail.com>
parents: 4834
diff changeset
19 python setup.py check --restructuredtext --metadata --strict
5cd6b0014f34 RELEASE.txt: Do 'setup.py check -rms' command to validate that long
anatoly techtonik <techtonik@gmail.com>
parents: 4834
diff changeset
20 5. Clean out all *.orig, *.rej, .#* files from the source.
5cd6b0014f34 RELEASE.txt: Do 'setup.py check -rms' command to validate that long
anatoly techtonik <techtonik@gmail.com>
parents: 4834
diff changeset
21 6. Remove previuos build files
5cd6b0014f34 RELEASE.txt: Do 'setup.py check -rms' command to validate that long
anatoly techtonik <techtonik@gmail.com>
parents: 4834
diff changeset
22 python setup.py clean --all
4809
80febeb6d897 RELEASE.txt: Update HTML doc paths
anatoly techtonik <techtonik@gmail.com>
parents: 4808
diff changeset
23 7. Rebuild documentation in "share/doc/roundup/html"
4834
8a4021713c6e RELEASE: Add PyPI page review to the checklist.
anatoly techtonik <techtonik@gmail.com>
parents: 4815
diff changeset
24 python setup.py build_doc
4487
5e9578d35d03 Document 'build_doc' step.
Stefan Seefeld <stefan@seefeld.name>
parents: 4433
diff changeset
25 8. python setup.py sdist --manifest-only
5e9578d35d03 Document 'build_doc' step.
Stefan Seefeld <stefan@seefeld.name>
parents: 4433
diff changeset
26 9. Check the MANIFEST to make sure that any new files are included. If
4834
8a4021713c6e RELEASE: Add PyPI page review to the checklist.
anatoly techtonik <techtonik@gmail.com>
parents: 4815
diff changeset
27 they are not, edit MANIFEST.in to include them. For format docs see
8a4021713c6e RELEASE: Add PyPI page review to the checklist.
anatoly techtonik <techtonik@gmail.com>
parents: 4815
diff changeset
28 http://docs.python.org/2/distutils/sourcedist.html#manifest-template
4487
5e9578d35d03 Document 'build_doc' step.
Stefan Seefeld <stefan@seefeld.name>
parents: 4433
diff changeset
29 10. python setup.py sdist
1939
1303c208419d some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents: 1875
diff changeset
30 (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
31 command)
4834
8a4021713c6e RELEASE: Add PyPI page review to the checklist.
anatoly techtonik <techtonik@gmail.com>
parents: 4815
diff changeset
32 11. Unpack the new dist file in /tmp then
8a4021713c6e RELEASE: Add PyPI page review to the checklist.
anatoly techtonik <techtonik@gmail.com>
parents: 4815
diff changeset
33 a) run_test.py
8a4021713c6e RELEASE: Add PyPI page review to the checklist.
anatoly techtonik <techtonik@gmail.com>
parents: 4815
diff changeset
34 b) demo.py
1947
0e19e99075e3 fix #white in cgitb
Richard Jones <richard@users.sourceforge.net>
parents: 1939
diff changeset
35 with all available Python versions.
4562
93b0b3f0085a Remove some Subversion-specific references.
Eric S. Raymond <esr@thyrsus.com>
parents: 4527
diff changeset
36 12. Assuming all is well tag the release in the version-control system.
5144
de275ca660c5 issue2550719 Install on Win 7, fails if not run as administrator. Update RELEASE.txt to include flag required to run as admin on windows 7+, drop support for XP at this point.
John Rouillard <rouilj@ieee.org>
parents: 4836
diff changeset
37 13. Build binary packages (requires python 2.6 or newer for
de275ca660c5 issue2550719 Install on Win 7, fails if not run as administrator. Update RELEASE.txt to include flag required to run as admin on windows 7+, drop support for XP at this point.
John Rouillard <rouilj@ieee.org>
parents: 4836
diff changeset
38 bdist_windist to have the --user-access flag.)
4834
8a4021713c6e RELEASE: Add PyPI page review to the checklist.
anatoly techtonik <techtonik@gmail.com>
parents: 4815
diff changeset
39 python setup.py bdist_rpm
5144
de275ca660c5 issue2550719 Install on Win 7, fails if not run as administrator. Update RELEASE.txt to include flag required to run as admin on windows 7+, drop support for XP at this point.
John Rouillard <rouilj@ieee.org>
parents: 4836
diff changeset
40 python setup.py bdist_wininst --user-access-control force
4834
8a4021713c6e RELEASE: Add PyPI page review to the checklist.
anatoly techtonik <techtonik@gmail.com>
parents: 4815
diff changeset
41 14. Upload source distributive to PyPI
8a4021713c6e RELEASE: Add PyPI page review to the checklist.
anatoly techtonik <techtonik@gmail.com>
parents: 4815
diff changeset
42 python setup.py sdist upload --sign
4835
5cd6b0014f34 RELEASE.txt: Do 'setup.py check -rms' command to validate that long
anatoly techtonik <techtonik@gmail.com>
parents: 4834
diff changeset
43 It should appear on http://pypi.python.org/pypi/roundup in no time.
4487
5e9578d35d03 Document 'build_doc' step.
Stefan Seefeld <stefan@seefeld.name>
parents: 4433
diff changeset
44 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
45 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
46 roundup-devel@lists.sourceforge.net
4836
fdcd7ef5bacf RELEASE.txt: +website update
anatoly techtonik <techtonik@gmail.com>
parents: 4835
diff changeset
47 16. Refresh website.
fdcd7ef5bacf RELEASE.txt: +website update
anatoly techtonik <techtonik@gmail.com>
parents: 4835
diff changeset
48 website/README.txt
5148
71643a839c80 Updated release docs to account for issue2550838.
John Rouillard <rouilj@ieee.org>
parents: 5144
diff changeset
49 http://www.roundup-tracker.org/ should state that the stable
71643a839c80 Updated release docs to account for issue2550838.
John Rouillard <rouilj@ieee.org>
parents: 5144
diff changeset
50 version is the one that you released.
71643a839c80 Updated release docs to account for issue2550838.
John Rouillard <rouilj@ieee.org>
parents: 5144
diff changeset
51 http://www.roundup-tracker.org/docs.html should also match the
71643a839c80 Updated release docs to account for issue2550838.
John Rouillard <rouilj@ieee.org>
parents: 5144
diff changeset
52 released version (or atleast the major 1.x release.
98
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
53
1354
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
54 So, those commands in a nice, cut'n'pasteable form::
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
55
3531
616244e247f4 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3106
diff changeset
56 find . -name '*.orig' -exec rm {} \;
616244e247f4 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3106
diff changeset
57 find . -name '*.rej' -exec rm {} \;
616244e247f4 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3106
diff changeset
58 find . -name '.#*' -exec rm {} \;
1354
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
59 python setup.py clean --all
4835
5cd6b0014f34 RELEASE.txt: Do 'setup.py check -rms' command to validate that long
anatoly techtonik <techtonik@gmail.com>
parents: 4834
diff changeset
60 python setup.py check --restructuredtext --metadata --strict
4487
5e9578d35d03 Document 'build_doc' step.
Stefan Seefeld <stefan@seefeld.name>
parents: 4433
diff changeset
61 python setup.py build_doc
1354
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
62 python setup.py sdist --manifest-only
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
63 python setup.py sdist --quiet
2237
f624fc20f8fe added capturing of stats
Richard Jones <richard@users.sourceforge.net>
parents: 2223
diff changeset
64 python setup.py bdist_rpm
5308
534b8bebfb1d Fix command in cut/paste section. Missing --user-access-control force.
John Rouillard <rouilj@ieee.org>
parents: 5148
diff changeset
65 python2.5 setup.py bdist_wininst --user-access-control force
3588
503d4c10f1f8 pre-release stuff
Richard Jones <richard@users.sourceforge.net>
parents: 3531
diff changeset
66 python setup.py register
4261
d82cd44bea96 update BUILD
Richard Jones <richard@users.sourceforge.net>
parents: 4104
diff changeset
67 python setup.py sdist upload --sign
4501
588e5dbbb9fe - document experience from release(s)
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4487
diff changeset
68 python2.5 setup.py bdist_wininst upload --sign
98
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
69
4261
d82cd44bea96 update BUILD
Richard Jones <richard@users.sourceforge.net>
parents: 4104
diff changeset
70 (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
71 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
72 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
73 this bug (Ralf)
4501
588e5dbbb9fe - document experience from release(s)
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4487
diff changeset
74
Roundup Issue Tracker: http://roundup-tracker.org/