Mercurial > p > roundup > code
annotate RELEASE.txt @ 6593:e70e2789bc2c
issue2551189 - increase text search maxlength
This removes I think all the magic references to 25 and 30 (varchar
size) and replaces them with references to maxlength or maxlength+5.
I am not sure why the db column is 5 characters larger than the size
of what should be the max size of a word, but I'll keep the buffer
of 5 as making it 1/5 the size of maxlength makes less sense.
Also added tests for fts search in templating which were missing.
Added postgres, mysql and sqlite native indexing backends in which to
test fts. Added fts test to native-fts as well to make sure it's
working.
I want to commit this now for CI.
Todo:
add test cases for the use of FTS in the csv output in
actions.py. There is no test coverage of the match case there.
change maxlength to a higher value (50) as requested in the ticket.
Modify existing extremewords test cases to allow words > 25 and < 51
write code to migrate column sizes for mysql and postgresql to match
maxlength I will roll this into the version 7 schema update that
supports use of database fts support.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Tue, 25 Jan 2022 13:22:00 -0500 |
| parents | 43298edf7ab1 |
| children | 6d102b4ba4d7 |
| 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 |
|
5841
f2804ec3bd06
issue2551007 document merging .pot files into .po file and
John Rouillard <rouilj@ieee.org>
parents:
5835
diff
changeset
|
13 translations. Merge into .po files by running 'make *.po' |
|
6224
3cf5bcf2bb5c
Update commands needed for locale updates.
John Rouillard <rouilj@ieee.org>
parents:
6137
diff
changeset
|
14 in the locale directory. Run: |
|
6379
843a88670707
Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents:
6378
diff
changeset
|
15 |
|
6453
3e7fc096fe5b
add cd commands for better cut/paste.
John Rouillard <rouilj@ieee.org>
parents:
6451
diff
changeset
|
16 cd locale |
|
6224
3cf5bcf2bb5c
Update commands needed for locale updates.
John Rouillard <rouilj@ieee.org>
parents:
6137
diff
changeset
|
17 make template |
|
3cf5bcf2bb5c
Update commands needed for locale updates.
John Rouillard <rouilj@ieee.org>
parents:
6137
diff
changeset
|
18 make *.po |
|
6453
3e7fc096fe5b
add cd commands for better cut/paste.
John Rouillard <rouilj@ieee.org>
parents:
6451
diff
changeset
|
19 cd .. |
|
6379
843a88670707
Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents:
6378
diff
changeset
|
20 |
|
6297
a635a60ffb84
Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents:
6265
diff
changeset
|
21 2. Run unit tests! They should pass successfully. Install pytest |
|
a635a60ffb84
Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents:
6265
diff
changeset
|
22 using pip2/pip3 for python2 and python3. Then invoke pytest |
|
a635a60ffb84
Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents:
6265
diff
changeset
|
23 using both python versions from the top of the roundup tree: |
|
6379
843a88670707
Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents:
6378
diff
changeset
|
24 |
|
6297
a635a60ffb84
Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents:
6265
diff
changeset
|
25 python3 -m pytest test/ |
|
a635a60ffb84
Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents:
6265
diff
changeset
|
26 python2 -m pytest test/ |
|
6379
843a88670707
Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents:
6378
diff
changeset
|
27 |
|
843a88670707
Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents:
6378
diff
changeset
|
28 3. Update version in: |
|
4815
efa61cc8be67
RELEASE.txt: doc/upgrading.txt needs to be updated too
anatoly techtonik <techtonik@gmail.com>
parents:
4809
diff
changeset
|
29 CHANGES.txt |
|
efa61cc8be67
RELEASE.txt: doc/upgrading.txt needs to be updated too
anatoly techtonik <techtonik@gmail.com>
parents:
4809
diff
changeset
|
30 roundup/__init__.py |
|
5335
e7293df727dc
Working through RELEASE.txt - updates for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents:
5334
diff
changeset
|
31 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
|
32 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
|
33 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
|
34 3b. Update doc/acknowledgements.txt (add section for |
|
5835
ad5cae31cd0f
Fix typos and add build step.
John Rouillard <rouilj@ieee.org>
parents:
5776
diff
changeset
|
35 release, churn contributers etc.). (Use hg churn -c -r ####..####) |
|
5520
0036f4a7bf2a
Mention regenerating roundup.pot in release instructions.
Joseph Myers <jsm@polyomino.org.uk>
parents:
5374
diff
changeset
|
36 4. Update documentation |
|
4815
efa61cc8be67
RELEASE.txt: doc/upgrading.txt needs to be updated too
anatoly techtonik <techtonik@gmail.com>
parents:
4809
diff
changeset
|
37 doc/announcement.txt |
|
efa61cc8be67
RELEASE.txt: doc/upgrading.txt needs to be updated too
anatoly techtonik <techtonik@gmail.com>
parents:
4809
diff
changeset
|
38 doc/upgrading.txt |
|
5520
0036f4a7bf2a
Mention regenerating roundup.pot in release instructions.
Joseph Myers <jsm@polyomino.org.uk>
parents:
5374
diff
changeset
|
39 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
|
40 _tmp/linkcheck/output.txt |
|
488d44cb42ef
add running linkcheck to update docs
John Rouillard <rouilj@ieee.org>
parents:
5358
diff
changeset
|
41 fix broken references in docs |
|
488d44cb42ef
add running linkcheck to update docs
John Rouillard <rouilj@ieee.org>
parents:
5358
diff
changeset
|
42 verify redirects are correct |
|
5941
29d428927362
prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents:
5841
diff
changeset
|
43 5. Update setup.py info if needed (contacts, classifiers, etc.). When |
|
29d428927362
prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents:
5841
diff
changeset
|
44 releasing check that Development Status matches release: stable, |
|
29d428927362
prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents:
5841
diff
changeset
|
45 beta alpha etc. |
|
29d428927362
prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents:
5841
diff
changeset
|
46 |
|
29d428927362
prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents:
5841
diff
changeset
|
47 Check that metadata is valid and long descriptions is proper reST: |
|
6379
843a88670707
Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents:
6378
diff
changeset
|
48 |
|
6451
bb561a8b179f
python -> python3, check removed files; baseline from 2.0.0
John Rouillard <rouilj@ieee.org>
parents:
6439
diff
changeset
|
49 python3 setup.py check --restructuredtext --metadata --strict |
|
6379
843a88670707
Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents:
6378
diff
changeset
|
50 |
|
5520
0036f4a7bf2a
Mention regenerating roundup.pot in release instructions.
Joseph Myers <jsm@polyomino.org.uk>
parents:
5374
diff
changeset
|
51 6. Clean out all *.orig, *.rej, .#* files from the source. |
|
6379
843a88670707
Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents:
6378
diff
changeset
|
52 |
|
843a88670707
Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents:
6378
diff
changeset
|
53 find . -name '*.orig' -exec rm {} \; |
|
843a88670707
Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents:
6378
diff
changeset
|
54 find . -name '*.rej' -exec rm {} \; |
|
843a88670707
Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents:
6378
diff
changeset
|
55 find . -name '.#*' -exec rm {} \; |
|
843a88670707
Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents:
6378
diff
changeset
|
56 |
|
843a88670707
Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents:
6378
diff
changeset
|
57 6a. Rebuild .mo translation files in distribution |
|
843a88670707
Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents:
6378
diff
changeset
|
58 |
|
843a88670707
Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents:
6378
diff
changeset
|
59 cd locale |
|
843a88670707
Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents:
6378
diff
changeset
|
60 make |
|
843a88670707
Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents:
6378
diff
changeset
|
61 cd .. |
|
843a88670707
Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents:
6378
diff
changeset
|
62 |
|
5520
0036f4a7bf2a
Mention regenerating roundup.pot in release instructions.
Joseph Myers <jsm@polyomino.org.uk>
parents:
5374
diff
changeset
|
63 7. Remove previous build files |
|
6379
843a88670707
Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents:
6378
diff
changeset
|
64 |
|
6451
bb561a8b179f
python -> python3, check removed files; baseline from 2.0.0
John Rouillard <rouilj@ieee.org>
parents:
6439
diff
changeset
|
65 python3 setup.py clean --all |
|
6225
043a8ffd79ad
Commits for roundup 2.0 release.
John Rouillard <rouilj@ieee.org>
parents:
6224
diff
changeset
|
66 rm -rf build/share # deletes locale .mo files |
|
6379
843a88670707
Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents:
6378
diff
changeset
|
67 |
|
843a88670707
Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents:
6378
diff
changeset
|
68 Build including new .mo files built in 6a. |
|
843a88670707
Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents:
6378
diff
changeset
|
69 |
|
6451
bb561a8b179f
python -> python3, check removed files; baseline from 2.0.0
John Rouillard <rouilj@ieee.org>
parents:
6439
diff
changeset
|
70 python3 setup.py build |
|
6379
843a88670707
Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents:
6378
diff
changeset
|
71 |
|
843a88670707
Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents:
6378
diff
changeset
|
72 (sdist generation will fail if this isn't done) |
|
843a88670707
Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents:
6378
diff
changeset
|
73 8. Rebuild documentation in "share/doc/roundup/html" |
|
843a88670707
Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents:
6378
diff
changeset
|
74 |
|
6451
bb561a8b179f
python -> python3, check removed files; baseline from 2.0.0
John Rouillard <rouilj@ieee.org>
parents:
6439
diff
changeset
|
75 python3 setup.py build_doc |
|
6379
843a88670707
Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents:
6378
diff
changeset
|
76 |
|
843a88670707
Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents:
6378
diff
changeset
|
77 9. Generate source distribution: |
|
843a88670707
Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents:
6378
diff
changeset
|
78 |
|
6451
bb561a8b179f
python -> python3, check removed files; baseline from 2.0.0
John Rouillard <rouilj@ieee.org>
parents:
6439
diff
changeset
|
79 python3 setup.py sdist |
|
6379
843a88670707
Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents:
6378
diff
changeset
|
80 |
|
6378
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
81 (if you find sdist a little verbose, add "--quiet" to the end of the |
|
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
82 command) |
|
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
83 9a. 2021/04/17 skip this for now. Need to make sure that whl installs |
|
6379
843a88670707
Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents:
6378
diff
changeset
|
84 exectuable scripts properly and update these directions to test. |
|
6378
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
85 |
|
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
86 python2 setup.py bdist_wheel; python3 setup.py bdist_wheel |
|
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
87 |
|
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
88 to create binary distributions in wheel format. (egg format is |
|
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
89 deprecated.) |
|
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
90 10. Check the roundup.egg-info/SOURCES.txt to make sure that any new files are |
|
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
91 included. (use hg status --rev <last release or tag>:tip to list changed |
|
6379
843a88670707
Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents:
6378
diff
changeset
|
92 added and removed files. Last release e.g. 1.5.1 where tip is what would |
|
6378
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
93 become 1.6) E.G. |
|
5951
0a42163ac846
Final doc fixes and translation extraction.
John Rouillard <rouilj@ieee.org>
parents:
5941
diff
changeset
|
94 |
|
6451
bb561a8b179f
python -> python3, check removed files; baseline from 2.0.0
John Rouillard <rouilj@ieee.org>
parents:
6439
diff
changeset
|
95 hg status --rev 2.0.0:tip | sed -ne 's/^A //p' | while read i ; \ |
|
bb561a8b179f
python -> python3, check removed files; baseline from 2.0.0
John Rouillard <rouilj@ieee.org>
parents:
6439
diff
changeset
|
96 do echo $i; grep "$i" roundup.egg-info/SOURCES.txt; done | \ |
|
bb561a8b179f
python -> python3, check removed files; baseline from 2.0.0
John Rouillard <rouilj@ieee.org>
parents:
6439
diff
changeset
|
97 uniq -c | sort -rn |
|
5951
0a42163ac846
Final doc fixes and translation extraction.
John Rouillard <rouilj@ieee.org>
parents:
5941
diff
changeset
|
98 |
|
6137
eb9d00db0923
Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents:
5954
diff
changeset
|
99 Anything with a count of 1 is not in the manifest. |
|
6225
043a8ffd79ad
Commits for roundup 2.0 release.
John Rouillard <rouilj@ieee.org>
parents:
6224
diff
changeset
|
100 If there are missing files that should be in the manifest, |
|
6137
eb9d00db0923
Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents:
5954
diff
changeset
|
101 edit MANIFEST.in to include them. For format docs see |
|
6378
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
102 https://packaging.python.org/guides/using-manifest-in/#using-manifest-in |
|
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
103 (Note: files under website/ shouldn't be in the manifest.) |
|
6451
bb561a8b179f
python -> python3, check removed files; baseline from 2.0.0
John Rouillard <rouilj@ieee.org>
parents:
6439
diff
changeset
|
104 |
|
bb561a8b179f
python -> python3, check removed files; baseline from 2.0.0
John Rouillard <rouilj@ieee.org>
parents:
6439
diff
changeset
|
105 10a: Check for removed files still in manifest: |
|
bb561a8b179f
python -> python3, check removed files; baseline from 2.0.0
John Rouillard <rouilj@ieee.org>
parents:
6439
diff
changeset
|
106 |
|
bb561a8b179f
python -> python3, check removed files; baseline from 2.0.0
John Rouillard <rouilj@ieee.org>
parents:
6439
diff
changeset
|
107 hg status --rev 2.0.0:tip | sed -ne 's/^R //p' | while read i ; \ |
|
bb561a8b179f
python -> python3, check removed files; baseline from 2.0.0
John Rouillard <rouilj@ieee.org>
parents:
6439
diff
changeset
|
108 do echo $i; grep "$i" roundup.egg-info/SOURCES.txt; done | \ |
|
bb561a8b179f
python -> python3, check removed files; baseline from 2.0.0
John Rouillard <rouilj@ieee.org>
parents:
6439
diff
changeset
|
109 uniq -c | sort -n |
|
bb561a8b179f
python -> python3, check removed files; baseline from 2.0.0
John Rouillard <rouilj@ieee.org>
parents:
6439
diff
changeset
|
110 |
|
bb561a8b179f
python -> python3, check removed files; baseline from 2.0.0
John Rouillard <rouilj@ieee.org>
parents:
6439
diff
changeset
|
111 any file with a count of 2 or more needs to be removed from |
|
bb561a8b179f
python -> python3, check removed files; baseline from 2.0.0
John Rouillard <rouilj@ieee.org>
parents:
6439
diff
changeset
|
112 MANIFEST.in and possibly cleaned out of the build tree. |
|
bb561a8b179f
python -> python3, check removed files; baseline from 2.0.0
John Rouillard <rouilj@ieee.org>
parents:
6439
diff
changeset
|
113 |
|
bb561a8b179f
python -> python3, check removed files; baseline from 2.0.0
John Rouillard <rouilj@ieee.org>
parents:
6439
diff
changeset
|
114 10b: if you added/removed files rebuild starting at step 6a. |
|
bb561a8b179f
python -> python3, check removed files; baseline from 2.0.0
John Rouillard <rouilj@ieee.org>
parents:
6439
diff
changeset
|
115 |
|
6378
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
116 11. 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
|
117 file in /tmp then |
|
6297
a635a60ffb84
Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents:
6265
diff
changeset
|
118 a) run tests using installed pytest run under python2 and |
|
a635a60ffb84
Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents:
6265
diff
changeset
|
119 python3. (python2 -m pytest test/; python3 -m pytest test/) |
|
4834
8a4021713c6e
RELEASE: Add PyPI page review to the checklist.
anatoly techtonik <techtonik@gmail.com>
parents:
4815
diff
changeset
|
120 b) demo.py |
|
1947
0e19e99075e3
fix #white in cgitb
Richard Jones <richard@users.sourceforge.net>
parents:
1939
diff
changeset
|
121 with all available Python versions. |
|
6378
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
122 11a. (TBD how to test wheel binary distribution before uploading.) |
|
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
123 12. 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
|
124 system. |
|
adf1061f15a6
Update docs on how to tag with mercurial.
John Rouillard <rouilj@ieee.org>
parents:
5357
diff
changeset
|
125 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
|
126 b) hg push # update main repo |
|
adf1061f15a6
Update docs on how to tag with mercurial.
John Rouillard <rouilj@ieee.org>
parents:
5357
diff
changeset
|
127 c) hg sum # verify that the tag shows up |
|
6378
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
128 13. Upload source distribution 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
|
129 pypi account and be added as a maintainer to roundup. Ask existing |
|
6378
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
130 maintainer for access. You can do this two ways: |
|
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
131 |
|
6451
bb561a8b179f
python -> python3, check removed files; baseline from 2.0.0
John Rouillard <rouilj@ieee.org>
parents:
6439
diff
changeset
|
132 python3 setup.py sdist upload --repository pypi --sign |
|
6378
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
133 |
|
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
134 which rebuilds the source distribution tarball and uploads it. |
|
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
135 This means that you have uploaded something tha is not tested. It |
|
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
136 should be the same as the tarball you tested but.... |
|
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
137 |
|
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
138 Another way to do this is to use twine (pip install twine). |
|
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
139 You need to sign the tarball. This can be done with: |
|
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
140 |
|
6379
843a88670707
Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents:
6378
diff
changeset
|
141 cd dist |
|
6378
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
142 gpg --detach-sign --armor <filename>.tgz |
|
6379
843a88670707
Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents:
6378
diff
changeset
|
143 |
|
6378
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
144 you should be prompted to use the roundup release key. If not you |
|
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
145 can add --local=roundup-devel@lists.sourceforge.net. |
|
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
146 This will create a file by the name <filename>.tgz.asc. Then |
|
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
147 use twine to upload *both* the asc and distibution tarball |
|
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
148 at the same time. E.G.:x |
|
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
149 |
|
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
150 twine upload --repository pypi <filename>.tar.gz <filename>.tar.gz.asc |
|
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
151 |
|
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
152 (If you upload the .asc file separately from the distibution file |
|
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
153 it gets a different path and is not able to be located in the pypi |
|
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
154 interface. The asc file is downloaded using the tarball path and |
|
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
155 add `asc'.) |
|
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
156 |
|
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
157 The distribution file should appear on |
|
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
158 https://pypi.python.org/pypi/roundup in no time. If you are using |
|
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
159 python older than 2.7.13 you need a .pypirc shown below since the |
|
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
160 URL has changed. If using 2.7.13 or newer, you can remove the |
|
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
161 "--repository pypi" option and use 'setup.py sdist upload...'. |
|
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
162 |
|
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
163 You can also use twine to upload the .whl (wheel) format |
|
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
164 distributions (if created). Follow the directions for generating |
|
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
165 the gpg asc files and upload the .whl distribution and .whl.asc |
|
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
166 signature files together. |
|
6455
43298edf7ab1
add notification email address and another directory site.
John Rouillard <rouilj@ieee.org>
parents:
6453
diff
changeset
|
167 14. Send doc/announcement.txt to python-announce@python.org, |
|
6439
5296d27ac97c
Implementing RELEASE.txt 2.1.0b1 release
John Rouillard <rouilj@ieee.org>
parents:
6379
diff
changeset
|
168 roundup-users@lists.sourceforge.net, |
|
6455
43298edf7ab1
add notification email address and another directory site.
John Rouillard <rouilj@ieee.org>
parents:
6453
diff
changeset
|
169 roundup-devel@lists.sourceforge.net, and lwn@lwn.net. |
|
6378
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
170 14b. Update entry on https://freshcode.club/projects/roundup-tracker |
|
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
171 14c. Update entries for fossies by emailing announcement to |
|
5776
bff95a7bcdbc
Add some additional sites to update with release announcements:
John Rouillard <rouilj@ieee.org>
parents:
5520
diff
changeset
|
172 announce@fossies.org |
|
6455
43298edf7ab1
add notification email address and another directory site.
John Rouillard <rouilj@ieee.org>
parents:
6453
diff
changeset
|
173 14d. Update entry on https://directory.fsf.org/wiki/Roundup. |
|
6378
b57c3d50505b
issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
174 15. Refresh website. |
|
4836
fdcd7ef5bacf
RELEASE.txt: +website update
anatoly techtonik <techtonik@gmail.com>
parents:
4835
diff
changeset
|
175 website/README.txt |
|
6265
b2eb59ada444
Replace http:....roundup-tracker.org with https. Also fix wiki links.
John Rouillard <rouilj@ieee.org>
parents:
6225
diff
changeset
|
176 https://www.roundup-tracker.org/ should state that the stable |
|
5148
71643a839c80
Updated release docs to account for issue2550838.
John Rouillard <rouilj@ieee.org>
parents:
5144
diff
changeset
|
177 version is the one that you released. |
|
6265
b2eb59ada444
Replace http:....roundup-tracker.org with https. Also fix wiki links.
John Rouillard <rouilj@ieee.org>
parents:
6225
diff
changeset
|
178 https://www.roundup-tracker.org/docs.html should also match the |
|
5941
29d428927362
prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents:
5841
diff
changeset
|
179 released version (or at least the major non pre-release |
|
29d428927362
prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents:
5841
diff
changeset
|
180 1.x/2.x version). |
|
98
16dcdab5ce70
Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
181 |
|
6379
843a88670707
Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents:
6378
diff
changeset
|
182 ------------- |
|
5337
01dabc0483b0
more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents:
5335
diff
changeset
|
183 |
|
01dabc0483b0
more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents:
5335
diff
changeset
|
184 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
|
185 ~/.pypirc file as well |
|
98
16dcdab5ce70
Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
186 |
|
5337
01dabc0483b0
more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents:
5335
diff
changeset
|
187 ======== |
|
01dabc0483b0
more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents:
5335
diff
changeset
|
188 [distutils] |
|
01dabc0483b0
more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents:
5335
diff
changeset
|
189 index-servers = |
|
01dabc0483b0
more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents:
5335
diff
changeset
|
190 test |
|
01dabc0483b0
more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents:
5335
diff
changeset
|
191 pypi |
|
4501
588e5dbbb9fe
- document experience from release(s)
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents:
4487
diff
changeset
|
192 |
|
5337
01dabc0483b0
more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents:
5335
diff
changeset
|
193 [pypi] |
|
01dabc0483b0
more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents:
5335
diff
changeset
|
194 repository: https://upload.pypi.org/legacy/ |
|
01dabc0483b0
more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents:
5335
diff
changeset
|
195 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
|
196 password: <your password here> |
|
01dabc0483b0
more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents:
5335
diff
changeset
|
197 |
|
01dabc0483b0
more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents:
5335
diff
changeset
|
198 [test] |
|
01dabc0483b0
more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents:
5335
diff
changeset
|
199 repository: https://test.pypi.org/legacy/ |
|
01dabc0483b0
more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents:
5335
diff
changeset
|
200 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
|
201 password: <your password here> |
|
01dabc0483b0
more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents:
5335
diff
changeset
|
202 ======== |
