Mercurial > p > roundup > code

annotate RELEASE.txt @ 5840:b68d3d8531d5 maint-1.6 1.6.1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Changes to prepare for 1.6.1 release.
author John Rouillard <rouilj@ieee.org>
date Wed, 10 Jul 2019 10:35:29 -0400
parents d1e4a42cba99
children 0036f4a7bf2a
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
5335
e7293df727dc Working through RELEASE.txt - updates for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5334
diff changeset
14 website/www/index.txt
5345
9e2f5a615eca website/www/conf.py needs copyright update and version update.
John Rouillard <rouilj@ieee.org>
parents: 5337
diff changeset
15 website/www/conf.py (also update copyright)
5337
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
16 2a. Update license end date in COPYING.txt
5357
5d26774b0915 fix location of acknowledgements.txt in doc
John Rouillard <rouilj@ieee.org>
parents: 5355
diff changeset
17 2b. Update doc/acknowledgements.txt (add section for
5347
341baf8b5865 More updates for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5345
diff changeset
18 release, churn contributers etc.).
4815
efa61cc8be67 RELEASE.txt: doc/upgrading.txt needs to be updated too
anatoly techtonik <techtonik@gmail.com>
parents: 4809
diff changeset
19 3. Update documentation
efa61cc8be67 RELEASE.txt: doc/upgrading.txt needs to be updated too
anatoly techtonik <techtonik@gmail.com>
parents: 4809
diff changeset
20 doc/announcement.txt
efa61cc8be67 RELEASE.txt: doc/upgrading.txt needs to be updated too
anatoly techtonik <techtonik@gmail.com>
parents: 4809
diff changeset
21 doc/upgrading.txt
5535
d1e4a42cba99 add running linkcheck to update docs
John Rouillard <rouilj@ieee.org>
parents: 5358
diff changeset
22 3a. cd to website/www and run 'make linkcheck'. See output in
d1e4a42cba99 add running linkcheck to update docs
John Rouillard <rouilj@ieee.org>
parents: 5358
diff changeset
23 _tmp/linkcheck/output.txt
d1e4a42cba99 add running linkcheck to update docs
John Rouillard <rouilj@ieee.org>
parents: 5358
diff changeset
24 fix broken references in docs
d1e4a42cba99 add running linkcheck to update docs
John Rouillard <rouilj@ieee.org>
parents: 5358
diff changeset
25 verify redirects are correct
4835
5cd6b0014f34 RELEASE.txt: Do 'setup.py check -rms' command to validate that long
anatoly techtonik <techtonik@gmail.com>
parents: 4834
diff changeset
26 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
27 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
28 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
29 5. Clean out all *.orig, *.rej, .#* files from the source.
5334
1ee8b7a671e7 Add to release docs. Typo correction, direction on using mercurial to
John Rouillard <rouilj@ieee.org>
parents: 5308
diff changeset
30 6. Remove previous build files
4835
5cd6b0014f34 RELEASE.txt: Do 'setup.py check -rms' command to validate that long
anatoly techtonik <techtonik@gmail.com>
parents: 4834
diff changeset
31 python setup.py clean --all
4809
80febeb6d897 RELEASE.txt: Update HTML doc paths
anatoly techtonik <techtonik@gmail.com>
parents: 4808
diff changeset
32 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
33 python setup.py build_doc
4487
5e9578d35d03 Document 'build_doc' step.
Stefan Seefeld <stefan@seefeld.name>
parents: 4433
diff changeset
34 8. python setup.py sdist --manifest-only
5334
1ee8b7a671e7 Add to release docs. Typo correction, direction on using mercurial to
John Rouillard <rouilj@ieee.org>
parents: 5308
diff changeset
35 9. Check the MANIFEST to make sure that any new files are included.
1ee8b7a671e7 Add to release docs. Typo correction, direction on using mercurial to
John Rouillard <rouilj@ieee.org>
parents: 5308
diff changeset
36 (use hg status --rev <last release or tag>:tip to list changed
1ee8b7a671e7 Add to release docs. Typo correction, direction on using mercurial to
John Rouillard <rouilj@ieee.org>
parents: 5308
diff changeset
37 added and removed files. Last release e.g. 1.5.1 where tip was
1ee8b7a671e7 Add to release docs. Typo correction, direction on using mercurial to
John Rouillard <rouilj@ieee.org>
parents: 5308
diff changeset
38 what would become 1.6)
1ee8b7a671e7 Add to release docs. Typo correction, direction on using mercurial to
John Rouillard <rouilj@ieee.org>
parents: 5308
diff changeset
39 If they are not, edit MANIFEST.in to include them. For format docs see
4834
8a4021713c6e RELEASE: Add PyPI page review to the checklist.
anatoly techtonik <techtonik@gmail.com>
parents: 4815
diff changeset
40 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
41 10. python setup.py sdist
1939
1303c208419d some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents: 1875
diff changeset
42 (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
43 command)
5337
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
44 11. Unpack the new tarball created in dist/roundup-<version>.tar.gz
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
45 file in /tmp then
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
46 a) run_tests.py
4834
8a4021713c6e RELEASE: Add PyPI page review to the checklist.
anatoly techtonik <techtonik@gmail.com>
parents: 4815
diff changeset
47 b) demo.py
1947
0e19e99075e3 fix #white in cgitb
Richard Jones <richard@users.sourceforge.net>
parents: 1939
diff changeset
48 with all available Python versions.
5358
adf1061f15a6 Update docs on how to tag with mercurial.
John Rouillard <rouilj@ieee.org>
parents: 5357
diff changeset
49 12. Assuming all is well tag the release in the version-control
adf1061f15a6 Update docs on how to tag with mercurial.
John Rouillard <rouilj@ieee.org>
parents: 5357
diff changeset
50 system.
adf1061f15a6 Update docs on how to tag with mercurial.
John Rouillard <rouilj@ieee.org>
parents: 5357
diff changeset
51 a) hg tag 1.6.0 # use right version. Should create/commit a changeset
adf1061f15a6 Update docs on how to tag with mercurial.
John Rouillard <rouilj@ieee.org>
parents: 5357
diff changeset
52 b) hg push # update main repo
adf1061f15a6 Update docs on how to tag with mercurial.
John Rouillard <rouilj@ieee.org>
parents: 5357
diff changeset
53 c) hg sum # verify that the tag shows up
5337
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
54 13. Upload source distributive to PyPI - requires you sign up for a
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
55 pypi account and be added as a maintainer to roundup. Ask existing
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
56 maintainer for access.
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
57 python setup.py sdist upload --repository pypi --sign
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
58 It should appear on http://pypi.python.org/pypi/roundup in no
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
59 time. If you are using python older than 2.7.13 you need a
5352
9fc6974f6863 fix typo
John Rouillard <rouilj@ieee.org>
parents: 5347
diff changeset
60 .pypirc shown below. URL has changed. If using 2.7.13 or newer,
5337
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
61 you can remove the "--repository pypi" option.
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
62 14. 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
63 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
64 roundup-devel@lists.sourceforge.net
5337
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
65 15. Refresh website.
4836
fdcd7ef5bacf RELEASE.txt: +website update
anatoly techtonik <techtonik@gmail.com>
parents: 4835
diff changeset
66 website/README.txt
5148
71643a839c80 Updated release docs to account for issue2550838.
John Rouillard <rouilj@ieee.org>
parents: 5144
diff changeset
67 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
68 version is the one that you released.
71643a839c80 Updated release docs to account for issue2550838.
John Rouillard <rouilj@ieee.org>
parents: 5144
diff changeset
69 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
70 released version (or atleast the major 1.x release.
98
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
71
1354
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
72 So, those commands in a nice, cut'n'pasteable form::
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
73
3531
616244e247f4 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3106
diff changeset
74 find . -name '*.orig' -exec rm {} \;
616244e247f4 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3106
diff changeset
75 find . -name '*.rej' -exec rm {} \;
616244e247f4 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3106
diff changeset
76 find . -name '.#*' -exec rm {} \;
1354
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
77 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
78 python setup.py check --restructuredtext --metadata --strict
4487
5e9578d35d03 Document 'build_doc' step.
Stefan Seefeld <stefan@seefeld.name>
parents: 4433
diff changeset
79 python setup.py build_doc
1354
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
80 python setup.py sdist --manifest-only
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
81 python setup.py sdist --quiet
2237
f624fc20f8fe added capturing of stats
Richard Jones <richard@users.sourceforge.net>
parents: 2223
diff changeset
82 python setup.py bdist_rpm
5337
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
83 # not required for pypi.org since 2017 -> python setup.py register
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
84 python setup.py sdist upload --repository pypi --sign
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
85
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
86 Note pypi no longer allows uploads of .exe installers such as produced
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
87 by bdist_wininst. Removed directions for producing the binary
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
88 distribution.
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
89
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
90 If you get errors on the upload operation, you may need the following
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
91 ~/.pypirc file as well
98
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
92
5337
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
93 ========
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
94 [distutils]
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
95 index-servers =
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
96 test
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
97 pypi
4501
588e5dbbb9fe - document experience from release(s)
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4487
diff changeset
98
5337
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
99 [pypi]
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
100 repository: https://upload.pypi.org/legacy/
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
101 username: <your username on pypi.org here>
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
102 password: <your password here>
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
103
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
104 [test]
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
105 repository: https://test.pypi.org/legacy/
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
106 username: <your username on test.pypi.org here>
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
107 password: <your password here>
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
108 ========
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
109
Roundup Issue Tracker: http://roundup-tracker.org/