Mercurial > p > roundup > code
annotate RELEASE.txt @ 5548:fea11d05110e
Avoid errors from selecting "no selection" on multilink (issue2550722).
As discussed in issue 2550722 there are various cases where selecting
"no selection" on a multilink can result in inappropriate errors from
Roundup:
* If selecting "no selection" produces a null edit (a value was set in
the multilink in an edit with an error, then removed again, along
with all other changes, in the next form submission), so the page is
rendered from the form contents including the "-<id>" value for "no
selection" for the multilink.
* If creating an item with a nonempty value for a multilink has an
error, and the resubmission changes that multilink to "no selection"
(and this in turn has subcases, according to whether the creation
then succeeds or fails on the resubmission, which need fixes in
different places in the Roundup code).
All of these cases have in common that it is expected and OK to have a
"-<id>" value for a submission for a multilink when <id> is not set in
that multilink in the database (because the original attempt to set
<id> in that multilink had an error), so the hyperdb.py logic to give
an error in that case is thus removed. In the subcase of the second
case where the resubmission with "no selection" has an error, the
templating code tries to produce a menu entry for the "-<id>"
multilink value, which also results in an error, hence the
templating.py change to ignore such values in the list for a
multilink.
| author | Joseph Myers <jsm@polyomino.org.uk> |
|---|---|
| date | Thu, 27 Sep 2018 11:33:01 +0000 |
| parents | 0036f4a7bf2a |
| children | bff95a7bcdbc |
| rev | line source |
|---|---|
| 1354 | 1 Building Releases |
| 2 ================= | |
|
98
16dcdab5ce70
Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
3 |
| 4807 | 4 Roundup is a pure Python application with no binary components. This file |
| 5 describes how to build a source release. To find out how to install | |
| 6 Roundup, read the doc/installation.txt file. | |
|
98
16dcdab5ce70
Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
7 |
| 4807 | 8 Roundup release checklist: |
|
98
16dcdab5ce70
Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
9 |
|
5520
0036f4a7bf2a
Mention regenerating roundup.pot in release instructions.
Joseph Myers <jsm@polyomino.org.uk>
parents:
5374
diff
changeset
|
10 1. Regenerate locale/roundup.pot. See "Extracting Translatable |
|
0036f4a7bf2a
Mention regenerating roundup.pot in release instructions.
Joseph Myers <jsm@polyomino.org.uk>
parents:
5374
diff
changeset
|
11 Messages" in doc/developers.txt. This is best done some time in |
|
0036f4a7bf2a
Mention regenerating roundup.pot in release instructions.
Joseph Myers <jsm@polyomino.org.uk>
parents:
5374
diff
changeset
|
12 advance of the release to allow for translators to update their |
|
0036f4a7bf2a
Mention regenerating roundup.pot in release instructions.
Joseph Myers <jsm@polyomino.org.uk>
parents:
5374
diff
changeset
|
13 translations. |
|
0036f4a7bf2a
Mention regenerating roundup.pot in release instructions.
Joseph Myers <jsm@polyomino.org.uk>
parents:
5374
diff
changeset
|
14 2. Run unit tests! They should pass successfully. "./run_tests.py" |
|
0036f4a7bf2a
Mention regenerating roundup.pot in release instructions.
Joseph Myers <jsm@polyomino.org.uk>
parents:
5374
diff
changeset
|
15 3. Update version |
|
4815
efa61cc8be67
RELEASE.txt: doc/upgrading.txt needs to be updated too
anatoly techtonik <techtonik@gmail.com>
parents:
4809
diff
changeset
|
16 CHANGES.txt |
|
efa61cc8be67
RELEASE.txt: doc/upgrading.txt needs to be updated too
anatoly techtonik <techtonik@gmail.com>
parents:
4809
diff
changeset
|
17 roundup/__init__.py |
|
5335
e7293df727dc
Working through RELEASE.txt - updates for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents:
5334
diff
changeset
|
18 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
|
19 website/www/conf.py (also update copyright) |
|
5520
0036f4a7bf2a
Mention regenerating roundup.pot in release instructions.
Joseph Myers <jsm@polyomino.org.uk>
parents:
5374
diff
changeset
|
20 3a. Update license end date in COPYING.txt |
|
0036f4a7bf2a
Mention regenerating roundup.pot in release instructions.
Joseph Myers <jsm@polyomino.org.uk>
parents:
5374
diff
changeset
|
21 3b. Update doc/acknowledgements.txt (add section for |
|
5347
341baf8b5865
More updates for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents:
5345
diff
changeset
|
22 release, churn contributers etc.). |
|
5520
0036f4a7bf2a
Mention regenerating roundup.pot in release instructions.
Joseph Myers <jsm@polyomino.org.uk>
parents:
5374
diff
changeset
|
23 4. Update documentation |
|
4815
efa61cc8be67
RELEASE.txt: doc/upgrading.txt needs to be updated too
anatoly techtonik <techtonik@gmail.com>
parents:
4809
diff
changeset
|
24 doc/announcement.txt |
|
efa61cc8be67
RELEASE.txt: doc/upgrading.txt needs to be updated too
anatoly techtonik <techtonik@gmail.com>
parents:
4809
diff
changeset
|
25 doc/upgrading.txt |
|
5520
0036f4a7bf2a
Mention regenerating roundup.pot in release instructions.
Joseph Myers <jsm@polyomino.org.uk>
parents:
5374
diff
changeset
|
26 4a. cd to website/www and run 'make linkcheck'. See output in |
|
5374
488d44cb42ef
add running linkcheck to update docs
John Rouillard <rouilj@ieee.org>
parents:
5358
diff
changeset
|
27 _tmp/linkcheck/output.txt |
|
488d44cb42ef
add running linkcheck to update docs
John Rouillard <rouilj@ieee.org>
parents:
5358
diff
changeset
|
28 fix broken references in docs |
|
488d44cb42ef
add running linkcheck to update docs
John Rouillard <rouilj@ieee.org>
parents:
5358
diff
changeset
|
29 verify redirects are correct |
|
5520
0036f4a7bf2a
Mention regenerating roundup.pot in release instructions.
Joseph Myers <jsm@polyomino.org.uk>
parents:
5374
diff
changeset
|
30 5. Update setup.py info is needed (contacts, classifiers, etc.), and |
|
4835
5cd6b0014f34
RELEASE.txt: Do 'setup.py check -rms' command to validate that long
anatoly techtonik <techtonik@gmail.com>
parents:
4834
diff
changeset
|
31 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
|
32 python setup.py check --restructuredtext --metadata --strict |
|
5520
0036f4a7bf2a
Mention regenerating roundup.pot in release instructions.
Joseph Myers <jsm@polyomino.org.uk>
parents:
5374
diff
changeset
|
33 6. Clean out all *.orig, *.rej, .#* files from the source. |
|
0036f4a7bf2a
Mention regenerating roundup.pot in release instructions.
Joseph Myers <jsm@polyomino.org.uk>
parents:
5374
diff
changeset
|
34 7. 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
|
35 python setup.py clean --all |
|
5520
0036f4a7bf2a
Mention regenerating roundup.pot in release instructions.
Joseph Myers <jsm@polyomino.org.uk>
parents:
5374
diff
changeset
|
36 8. 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
|
37 python setup.py build_doc |
|
5520
0036f4a7bf2a
Mention regenerating roundup.pot in release instructions.
Joseph Myers <jsm@polyomino.org.uk>
parents:
5374
diff
changeset
|
38 9. python setup.py sdist --manifest-only |
|
0036f4a7bf2a
Mention regenerating roundup.pot in release instructions.
Joseph Myers <jsm@polyomino.org.uk>
parents:
5374
diff
changeset
|
39 10. Check the MANIFEST to make sure that any new files are included. |
|
5334
1ee8b7a671e7
Add to release docs. Typo correction, direction on using mercurial to
John Rouillard <rouilj@ieee.org>
parents:
5308
diff
changeset
|
40 (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
|
41 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
|
42 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
|
43 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
|
44 http://docs.python.org/2/distutils/sourcedist.html#manifest-template |
|
5520
0036f4a7bf2a
Mention regenerating roundup.pot in release instructions.
Joseph Myers <jsm@polyomino.org.uk>
parents:
5374
diff
changeset
|
45 11. python setup.py sdist |
|
1939
1303c208419d
some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents:
1875
diff
changeset
|
46 (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
|
47 command) |
|
5520
0036f4a7bf2a
Mention regenerating roundup.pot in release instructions.
Joseph Myers <jsm@polyomino.org.uk>
parents:
5374
diff
changeset
|
48 12. Unpack the new tarball created in dist/roundup-<version>.tar.gz |
|
5337
01dabc0483b0
more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents:
5335
diff
changeset
|
49 file in /tmp then |
|
01dabc0483b0
more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents:
5335
diff
changeset
|
50 a) run_tests.py |
|
4834
8a4021713c6e
RELEASE: Add PyPI page review to the checklist.
anatoly techtonik <techtonik@gmail.com>
parents:
4815
diff
changeset
|
51 b) demo.py |
|
1947
0e19e99075e3
fix #white in cgitb
Richard Jones <richard@users.sourceforge.net>
parents:
1939
diff
changeset
|
52 with all available Python versions. |
|
5520
0036f4a7bf2a
Mention regenerating roundup.pot in release instructions.
Joseph Myers <jsm@polyomino.org.uk>
parents:
5374
diff
changeset
|
53 13. Assuming all is well tag the release in the version-control |
|
5358
adf1061f15a6
Update docs on how to tag with mercurial.
John Rouillard <rouilj@ieee.org>
parents:
5357
diff
changeset
|
54 system. |
|
adf1061f15a6
Update docs on how to tag with mercurial.
John Rouillard <rouilj@ieee.org>
parents:
5357
diff
changeset
|
55 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
|
56 b) hg push # update main repo |
|
adf1061f15a6
Update docs on how to tag with mercurial.
John Rouillard <rouilj@ieee.org>
parents:
5357
diff
changeset
|
57 c) hg sum # verify that the tag shows up |
|
5520
0036f4a7bf2a
Mention regenerating roundup.pot in release instructions.
Joseph Myers <jsm@polyomino.org.uk>
parents:
5374
diff
changeset
|
58 14. Upload source distributive to PyPI - requires you sign up for a |
|
5337
01dabc0483b0
more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents:
5335
diff
changeset
|
59 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
|
60 maintainer for access. |
|
01dabc0483b0
more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents:
5335
diff
changeset
|
61 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
|
62 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
|
63 time. If you are using python older than 2.7.13 you need a |
| 5352 | 64 .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
|
65 you can remove the "--repository pypi" option. |
|
5520
0036f4a7bf2a
Mention regenerating roundup.pot in release instructions.
Joseph Myers <jsm@polyomino.org.uk>
parents:
5374
diff
changeset
|
66 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
|
67 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
|
68 roundup-devel@lists.sourceforge.net |
|
5520
0036f4a7bf2a
Mention regenerating roundup.pot in release instructions.
Joseph Myers <jsm@polyomino.org.uk>
parents:
5374
diff
changeset
|
69 16. Refresh website. |
|
4836
fdcd7ef5bacf
RELEASE.txt: +website update
anatoly techtonik <techtonik@gmail.com>
parents:
4835
diff
changeset
|
70 website/README.txt |
|
5148
71643a839c80
Updated release docs to account for issue2550838.
John Rouillard <rouilj@ieee.org>
parents:
5144
diff
changeset
|
71 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
|
72 version is the one that you released. |
|
71643a839c80
Updated release docs to account for issue2550838.
John Rouillard <rouilj@ieee.org>
parents:
5144
diff
changeset
|
73 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
|
74 released version (or atleast the major 1.x release. |
|
98
16dcdab5ce70
Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
75 |
| 1354 | 76 So, those commands in a nice, cut'n'pasteable form:: |
| 77 | |
|
3531
616244e247f4
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
3106
diff
changeset
|
78 find . -name '*.orig' -exec rm {} \; |
|
616244e247f4
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
3106
diff
changeset
|
79 find . -name '*.rej' -exec rm {} \; |
|
616244e247f4
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
3106
diff
changeset
|
80 find . -name '.#*' -exec rm {} \; |
| 1354 | 81 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
|
82 python setup.py check --restructuredtext --metadata --strict |
|
4487
5e9578d35d03
Document 'build_doc' step.
Stefan Seefeld <stefan@seefeld.name>
parents:
4433
diff
changeset
|
83 python setup.py build_doc |
| 1354 | 84 python setup.py sdist --manifest-only |
| 85 python setup.py sdist --quiet | |
|
2237
f624fc20f8fe
added capturing of stats
Richard Jones <richard@users.sourceforge.net>
parents:
2223
diff
changeset
|
86 python setup.py bdist_rpm |
|
5337
01dabc0483b0
more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents:
5335
diff
changeset
|
87 # 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
|
88 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
|
89 |
|
01dabc0483b0
more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents:
5335
diff
changeset
|
90 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
|
91 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
|
92 distribution. |
|
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 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
|
95 ~/.pypirc file as well |
|
98
16dcdab5ce70
Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
96 |
|
5337
01dabc0483b0
more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents:
5335
diff
changeset
|
97 ======== |
|
01dabc0483b0
more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents:
5335
diff
changeset
|
98 [distutils] |
|
01dabc0483b0
more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents:
5335
diff
changeset
|
99 index-servers = |
|
01dabc0483b0
more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents:
5335
diff
changeset
|
100 test |
|
01dabc0483b0
more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents:
5335
diff
changeset
|
101 pypi |
|
4501
588e5dbbb9fe
- document experience from release(s)
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents:
4487
diff
changeset
|
102 |
|
5337
01dabc0483b0
more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents:
5335
diff
changeset
|
103 [pypi] |
|
01dabc0483b0
more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents:
5335
diff
changeset
|
104 repository: https://upload.pypi.org/legacy/ |
|
01dabc0483b0
more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents:
5335
diff
changeset
|
105 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
|
106 password: <your password here> |
|
01dabc0483b0
more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents:
5335
diff
changeset
|
107 |
|
01dabc0483b0
more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents:
5335
diff
changeset
|
108 [test] |
|
01dabc0483b0
more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents:
5335
diff
changeset
|
109 repository: https://test.pypi.org/legacy/ |
|
01dabc0483b0
more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents:
5335
diff
changeset
|
110 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
|
111 password: <your password here> |
|
01dabc0483b0
more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents:
5335
diff
changeset
|
112 ======== |
|
01dabc0483b0
more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents:
5335
diff
changeset
|
113 |
